BeeeOn Gateway  v2020.3.1-2-g6f737dc
Platform to interconnect the IoT world
Public Member Functions
BeeeOn::OZWNotificationEvent Class Reference

Low-level OpenZWave notification event. Because, the OpenZWave::Notification cannot be copied nor cloned, we have to represent it explicitly and copy all its contents. More...

#include <OZWNotificationEvent.h>

Public Member Functions

 OZWNotificationEvent (const OpenZWave::Notification &notification)
 
uint32_t homeID () const
 
uint8_t nodeID () const
 
OpenZWave::Notification::NotificationType type () const
 
OpenZWave::ValueID valueID () const
 
uint8_t byte () const
 
Poco::Nullable< uint8_t > event () const
 

Detailed Description

Low-level OpenZWave notification event. Because, the OpenZWave::Notification cannot be copied nor cloned, we have to represent it explicitly and copy all its contents.

See Also
https://github.com/OpenZWave/open-zwave/blob/master/cpp/src/Notification.h

Constructor & Destructor Documentation

OZWNotificationEvent::OZWNotificationEvent ( const OpenZWave::Notification &  notification)

Copy contents of the given notification into the event representation.

Member Function Documentation

uint8_t OZWNotificationEvent::byte ( ) const

Note different semantics at least for notifications of types Type_SceneEvent, Type_Notification, Type_ControllerCommand, Type_CreateButton, Type_DeleteButton, Type_ButtonOn, Type_ButtonOff, Type_Group.

Returns
byte value with semantics specific for each type.
See Also
OpenZWave::Notification
Poco::Nullable< uint8_t > OZWNotificationEvent::event ( ) const

The result is valid only for types Type_NodeEvent and Type_ControllerCommand.

Returns
event as reported by notifications of types NodeEvent and ControllerCommand.
See Also
OpenZWave::Notification
uint32_t BeeeOn::OZWNotificationEvent::homeID ( ) const
inline

Shortcut to access home ID.

uint8_t BeeeOn::OZWNotificationEvent::nodeID ( ) const
inline

Shortcut to access node ID.

OpenZWave::Notification::NotificationType OZWNotificationEvent::type ( ) const
Returns
type of notification.
OpenZWave::ValueID OZWNotificationEvent::valueID ( ) const
Returns
identification of the reported value.
See Also
OpenZWave::ValueID

The documentation for this class was generated from the following files: