![]() |
OpenZWave Library 1.6.1914
|
Provides a container for data sent via the notification callback handler installed by a call to Manager::AddWatcher. More...
#include <Notification.h>
Public Member Functions | |
NotificationType | GetType () const |
uint32 | GetHomeId () const |
uint8 | GetNodeId () const |
ValueID const & | GetValueID () const |
uint8 | GetGroupIdx () const |
uint8 | GetEvent () const |
uint8 | GetButtonId () const |
DEPRECATED uint8 | GetSceneId () const |
uint8 | GetNotification () const |
uint8 | GetCommand () const |
uint8 | GetByte () const |
uint8 | GetRetry () const |
string | GetAsString () const |
UserAlertNotification | GetUserAlertType () const |
string | GetComPort () const |
Friends | |
class | Manager |
class | Driver |
class | Node |
class | Group |
class | Internal::VC::Value |
class | Internal::VC::ValueStore |
class | Internal::CC::Basic |
class | Internal::CC::ManufacturerSpecific |
class | Internal::CC::NodeNaming |
class | Internal::CC::SceneActivation |
class | Internal::CC::WakeUp |
class | Internal::CC::ApplicationStatus |
class | Internal::ManufacturerSpecificDB |
Provides a container for data sent via the notification callback handler installed by a call to Manager::AddWatcher.
A notification object is only ever created or deleted internally by OpenZWave.
Notification codes. Notifications of the type Type_Notification convey some extra information defined here.
Enumerator | |
---|---|
Code_MsgComplete | Completed messages |
Code_Timeout | Messages that timeout will send a Notification with this code. |
Code_NoOperation | Report on NoOperation message sent completion |
Code_Awake | Report when a sleeping node wakes up |
Code_Sleep | Report when a node goes to sleep |
Code_Dead | Report when a node is presumed dead |
Code_Alive | Report when a node is revived |
Notification types. Notifications of various Z-Wave events sent to the watchers registered with the Manager::AddWatcher method.
Enumerator | |
---|---|
Type_ValueAdded | A new node value has been added to OpenZWave's list. These notifications occur after a node has been discovered, and details of its command classes have been received. Each command class may generate one or more values depending on the complexity of the item being represented. |
Type_ValueRemoved | A node value has been removed from OpenZWave's list. This only occurs when a node is removed. |
Type_ValueChanged | A node value has been updated from the Z-Wave network and it is different from the previous value. |
Type_ValueRefreshed | A node value has been updated from the Z-Wave network. |
Type_Group | The associations for the node have changed. The application should rebuild any group information it holds about the node. |
Type_NodeNew | A new node has been found (not already stored in zwcfg*.xml file) |
Type_NodeAdded | A new node has been added to OpenZWave's list. This may be due to a device being added to the Z-Wave network, or because the application is initializing itself. |
Type_NodeRemoved | A node has been removed from OpenZWave's list. This may be due to a device being removed from the Z-Wave network, or because the application is closing. |
Type_NodeProtocolInfo | Basic node information has been received, such as whether the node is a listening device, a routing device and its baud rate and basic, generic and specific types. It is after this notification that you can call Manager::GetNodeType to obtain a label containing the device description. |
Type_NodeNaming | One of the node names has changed (name, manufacturer, product). |
Type_NodeEvent | A node has triggered an event. This is commonly caused when a node sends a Basic_Set command to the controller. The event value is stored in the notification. |
Type_PollingDisabled | Polling of a node has been successfully turned off by a call to Manager::DisablePoll |
Type_PollingEnabled | Polling of a node has been successfully turned on by a call to Manager::EnablePoll |
Type_SceneEvent | Scene Activation Set received (Depreciated in 1.8) |
Type_CreateButton | Handheld controller button event created |
Type_DeleteButton | Handheld controller button event deleted |
Type_ButtonOn | Handheld controller button on pressed event |
Type_ButtonOff | Handheld controller button off pressed event |
Type_DriverReady | A driver for a PC Z-Wave controller has been added and is ready to use. The notification will contain the controller's Home ID, which is needed to call most of the Manager methods. |
Type_DriverFailed | Driver failed to load |
Type_DriverReset | All nodes and values for this driver have been removed. This is sent instead of potentially hundreds of individual node and value notifications. |
Type_EssentialNodeQueriesComplete | The queries on a node that are essential to its operation have been completed. The node can now handle incoming messages. |
Type_NodeQueriesComplete | All the initialization queries on a node have been completed. |
Type_AwakeNodesQueried | All awake nodes have been queried, so client application can expected complete data for these nodes. |
Type_AllNodesQueriedSomeDead | All nodes have been queried but some dead nodes found. |
Type_AllNodesQueried | All nodes have been queried, so client application can expected complete data. |
Type_Notification | An error has occurred that we need to report. |
Type_DriverRemoved | The Driver is being removed. (either due to Error or by request) Do Not Call Any Driver Related Methods after receiving this call |
Type_ControllerCommand | When Controller Commands are executed, Notifications of Success/Failure etc are communicated via this Notification Notification::GetEvent returns Driver::ControllerCommand and Notification::GetNotification returns Driver::ControllerState |
Type_NodeReset | The Device has been reset and thus removed from the NodeList in OZW |
Type_UserAlerts | Warnings and Notifications Generated by the library that should be displayed to the user (eg, out of date config files) |
Type_ManufacturerSpecificDBReady | The ManufacturerSpecific Database Is Ready |
User Alert Types - These are messages that should be displayed to users to inform them of potential issues such as Out of Date configuration files etc
string Notification::GetAsString | ( | ) | const |
Helper Function to return the Notification as a String
|
inline |
Get the button id of a notification. Only valid in Notification::Type_CreateButton, Notification::Type_DeleteButton, Notification::Type_ButtonOn and Notification::Type_ButtonOff notifications.
|
inline |
Helper function to simplify wrapping the notification class. Should not normally need to be called.
|
inline |
Get the (controller) command from a notification. Only valid for Notification::Type_ControllerCommand notifications.
|
inline |
Return the Comport associated with the DriverFailed Message
|
inline |
Get the event value of a notification. Only valid in Notification::Type_NodeEvent and Notification::Type_ControllerCommand notifications.
|
inline |
Get the index of the association group that has been changed. Only valid in Notification::Type_Group notifications.
|
inline |
Get the Home ID of the driver sending this notification.
|
inline |
Get the ID of any node involved in this notification.
|
inline |
Get the notification code from a notification. Only valid for Notification::Type_Notification or Notification::Type_ControllerCommand notifications.
|
inline |
Helper function to return the Timeout to wait for. Only valid for Notification::Type_UserAlerts - Notification::Alert_ApplicationStatus_Retry
|
inline |
Get the scene Id of a notification. Only valid in Notification::Type_SceneEvent notifications. The SceneActivation CC now exposes ValueID's that convey this information
|
inline |
|
inline |
Retrieve the User Alert Type Enum to determine what this message is about
|
inline |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |