![]() |
OpenZWave Library
1.2
|
Provides a unique ID for a value reported by a Z-Wave device. More...
#include <ValueID.h>
Public Types | |
enum | ValueGenre { ValueGenre_Basic = 0, ValueGenre_User, ValueGenre_Config, ValueGenre_System, ValueGenre_Count } |
enum | ValueType { ValueType_Bool = 0, ValueType_Byte, ValueType_Decimal, ValueType_Int, ValueType_List, ValueType_Schedule, ValueType_Short, ValueType_String, ValueType_Button, ValueType_Raw, ValueType_Max = ValueType_Raw } |
Public Member Functions | |
uint32 | GetHomeId () const |
uint8 | GetNodeId () const |
ValueGenre | GetGenre () const |
uint8 | GetCommandClassId () const |
uint8 | GetInstance () const |
uint8 | GetIndex () const |
ValueType | GetType () const |
uint64 | GetId () const |
bool | operator== (ValueID const &_other) const |
bool | operator!= (ValueID const &_other) const |
bool | operator< (ValueID const &_other) const |
bool | operator> (ValueID const &_other) const |
ValueID (uint32 const _homeId, uint8 const _nodeId, ValueGenre const _genre, uint8 const _commandClassId, uint8 const _instance, uint8 const _valueIndex, ValueType const _type) | |
ValueID (uint32 _homeId, uint64 id) | |
Friends | |
class | Manager |
class | Driver |
class | Node |
class | Group |
class | CommandClass |
class | Value |
class | ValueStore |
class | Notification |
class | ManufacturerSpecific |
Provides a unique ID for a value reported by a Z-Wave device.
The ValueID is used to uniquely identify a value reported by a Z-Wave device.
The ID is built by packing various identifying characteristics into a single 32-bit number - the Z-Wave driver index, device node ID, the command class and command class instance that handles the value, plus an index for the value to distinguish it among all the other values managed by that command class instance. The type (bool, byte, string etc) of the value is also stored.
The packing of the ID is such that a list of Values sorted by ValueID will be in a sensible order for display to the user.
Value Genres The classification of a value to enable low level system or configuration parameters to be filtered by the application.
Enumerator | |
---|---|
ValueGenre_Basic | The 'level' as controlled by basic commands. Usually duplicated by another command class. |
ValueGenre_User | Basic values an ordinary user would be interested in. |
ValueGenre_Config | Device-specific configuration parameters. These cannot be automatically discovered via Z-Wave, and are usually described in the user manual instead. |
ValueGenre_System | Values of significance only to users who understand the Z-Wave protocol |
ValueGenre_Count | A count of the number of genres defined. Not to be used as a genre itself. |
Value Types The type of data represented by the value object.
|
inline |
Construct a value ID from its component parts. This method is public only to allow ValueIDs to be saved and recreated by the application. Only ValueIDs that have been reported by OpenZWave notifications should ever be used.
_homeId | Home ID of the PC Z-Wave Controller that manages the device. |
_nodeId | Node ID of the device reporting the value. |
_genre | classification of the value to enable low level system or configuration parameters to be filtered out. |
_commandClassId | ID of command class that creates and manages this value. |
_instance | Instance index of the command class. |
_valueIndex | Index of the value within all the values created by the command class instance. |
_type | Type of value (bool, byte, string etc). |
|
inline |
|
inline |
Get the Z-Wave command class that created and manages this value. Knowledge of command classes is not required to use OpenZWave, but this information is exposed in case it is of interest.
|
inline |
Get the genre of the value. The genre classifies a value to enable low-level system or configuration parameters to be filtered out by the application
|
inline |
Get the Home ID of the driver that controls the node containing the value.
|
inline |
|
inline |
Get the value index. The index is used to identify one of multiple values created and managed by a command class. In the case of configurable parameters (handled by the configuration command class), the index is the same as the parameter ID. Knowledge of command classes is not required to use OpenZWave, but this information is exposed in case it is of interest.
|
inline |
Get the command class instance of this value. It is possible for there to be multiple instances of a command class, although currently it appears that only the SensorMultilevel command class ever does this. Knowledge of instances and command classes is not required to use OpenZWave, but this information is exposed in case it is of interest.
|
inline |
Get the Home ID of the driver that controls the node containing the value.
|
inline |
Get the type of the value. The type describes the data held by the value and enables the user to select the correct value accessor method in the Manager class.
|
inline |
|
inline |
|
inline |
|
inline |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |