2.2.100. Sensor Configuration Command Class, version 1 [OBSOLETED]¶
Warning
THIS COMMAND HAS BEEN OBSOLETED
New implementations MUST NOT use the Sensor Configuration Command Class. Refer to the Configuration Command Classes.
The Sensor Configuration Command Class adds the possibility for sensors to act on either a measured value or on a preconfigured value. With this command class an application can act on a specific event. It is up to the application to implement the actual event. This could e.g. be implementation of the Association Command Class where the application would activate a group based on a trigger from the sensor.
The trigger types that may be configured are the same types as the values specified in the Multilevel Sensor Command Class
Most movement sensors may be configured to “ignore” movement if it is not dark. Typically this is done manually. With the Sensor Configuration Command Class this may be configured remotely in a standardised way.
A device supporting the Sensor Configuration Command Class may be configured via the trigger level, but the decision on what the level change should trigger is up to the application. For the movement sensor this trigger level could be an input parameter to the logic that controls the light.
2.2.100.1. Sensor Trigger Level Set Command¶
This command is used to set different triggers to either a specified value or to the current measured value. The Command also supports to restore a factory default value.
All configurable trigger types and values MUST be mapped directly from the Multilevel Sensor Command Class.
It is RECOMMENDED that all combinations of precision, scale and size parameters are supported. The Set command MUST support same format of precision, scale and size parameters as can be returned in the report command.
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|---|---|---|---|---|---|---|---|
Command Class = COMMAND_CLASS_SENSOR_CONFIGURATION (0x9E) |
|||||||
Command = SENSOR_TRIGGER_LEVEL_SET (0x01) |
|||||||
Default |
Current |
Reserved |
|||||
Sensor Type |
|||||||
Precision |
Scale |
Size |
|||||
Trigger Value 1 |
|||||||
… |
|||||||
Trigger Value N |
|||||||
Default (1 bit)
Reset level of trigger type to factory default when this bit is set to 1. If any value is set in this frame when the Default bit is 1 this value will be ignored.
Current (1 bit)
The current measured value will be stored as trigger value when this bit is set to 1. The trigger value in this frame will be ignored when the Current bit is set to 1.
Reserved
This field MUST be set to 0 by a sending node and MUST be ignored by a receiving node.
Precision (3 bits)
The precision field describes what the precision of the trigger value is. The number indicates the number of decimals. The decimal value 1025 with precision 2 is therefore equal to 10.25.
Scale (2 bits)
The Scale used to indicate what unit the trigger uses. Refer to the table in the Multilevel Sensor Command Class with respect to defined scales for the relevant triggers. Scales are defined by the Z-Wave Alliance.
Size (3 bits)
The size field indicates the number of bytes used for the Trigger Value field. This field can take values from 1 (001b), 2 (010b) or 4 (100b).
Sensor Type (8 bits)
The Sensor Type specifies what type of trigger this Command will set. Refer to the Multilevel Sensor Command Class specification, where Sensor Type is defined in the Multilevel Sensor Report Command.
Trigger Value (N bytes)
Refer to the Multilevel Sensor Report Command for information on what trigger values to set.
2.2.100.2. Sensor Trigger Level Get Command¶
This command can request the stored trigger level.
The Sensor Trigger Level Report Command MUST be returned in response to this command.
This command MUST NOT be issued via multicast addressing.
A receiving node MUST NOT return a response if this command is received via multicast addressing. The Z-Wave Multicast frame, the broadcast NodeID and the Multi Channel multi-End Point destination are all considered multicast addressing methods.
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|---|---|---|---|---|---|---|---|
Command Class = COMMAND_CLASS_SENSOR_CONFIGURATION (0x9E) |
|||||||
Command = SENSOR_TRIGGER_LEVEL_GET (0x02) |
|||||||
2.2.100.3. Sensor Trigger Level Report Command¶
This command returns the stored trigger value.
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|---|---|---|---|---|---|---|---|
Command Class = COMMAND_CLASS_SENSOR_CONFIGURATION (0x9E) |
|||||||
Command = SENSOR_TRIGGER_LEVEL_REPORT (0x03) |
|||||||
Precision |
Scale |
Size |
|||||
Trigger Value 1 |
|||||||
… |
|||||||
Trigger Value N |
|||||||
For fields’ description, refer to the Sensor Trigger Level Set Command.
2.2.100.4. Mapping Example¶
The report structure of the Multilevel Sensor Command Class can be mapped direct into the Sensor Configuration Set Command Class. This example frame below will set the trigger level in the receiving node to 10.25 degree Celsius.
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|---|---|---|---|---|---|---|---|
Command Class = COMMAND_CLASS_SENSOR_CONFIGURATION (0x9E) |
|||||||
Command = SENSOR_TRIGGER_LEVEL_SET (0x01) |
|||||||
Default (0) |
Current (0) |
Reserved |
|||||
Precision (010b) |
Celsius (00b) |
Size (010b) |
|||||
0x04 |
|||||||
0x01 |
|||||||