ZWValueId Class

Provides a unique ID for a value reported by a Z-Wave device.

Inheritance Hierarchy

SystemObject
OpenZWaveZWValueId

Namespace: OpenZWave
Assembly: OpenZWave (in OpenZWave.dll) Version: 255.255.255.255

Syntax

C++

Copy

public sealed class ZWValueId

Public NotInheritable Class ZWValueId

public ref class ZWValueId sealed

The ZWValueId type exposes the following members.

Constructors

	Name	Description
	ZWValueId	Create a ZWValue ID from its component parts.

Top

Properties

	Name	Description
	CommandClassId	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.
	Genre	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
	HomeId	Gets the Home ID of the driver that controls the node containing the value.
	Id	Get a 64Bit Integer that represents this ValueID. This Integer is not guaranteed to be valid across restarts of OpenZWave.
	Index	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.
	Instance	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.
	NodeId	Gets the Node ID of the node containing the value.
	Type	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.

Top

Remarks

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.

Reference

OpenZWave Namespace