Atrim OmniSensor contains multiple command classes which are used for communication between it and Z-Wave gateways. Some command classes can also be used to customize the sensor's settings. Please refer to your Z-Wave controller's user guide for instructions on accessing and changing command classes.
Command Class | Version |
---|---|
Association | 2 |
Association Group Information | 3 |
Battery | 1 |
Configuration | 4 |
Device Reset Locally | 1 |
Firmware Update Meta Data | 5 |
Indicator | 3 |
Manufacturer Specific | 2 |
Multi-Channel Association | 3 |
Multilevel Sensor | 1 |
Notification | 8 |
Power Level | 1 |
Security 0/2 | 1 |
Supervision | 1 |
Transport Service | 2 |
Version | 3 |
Wakeup | 2 |
Z-Wave Plus Info | 2 |
Association Groups
OmniSensor supports 7 association groups and every group supports a maximum of 5 associated nodes. Group 1 is Lifeline group; all nodes which associated in this group will receive the messages sent by device through Lifeline.
Note: When Basic CC/ Switch Binary CC are used to control OmniSensor or sent through association groups to control other associated nodes, the variable will be phased as the follow ways:
- 0x00~0x63 / 0xff means On
- 0x00 means Off
Other values will be ignored.
The Command Class supported by each association group is shown in the table below:
ID | Name | Nodes | Profile | Description |
---|---|---|---|---|
1 | Lifeline | 5 | General: Lifeline | Device Reset Locally: When factory reset. Notification Report: See notification section for more information. Sensor Multilevel Report: When sensors above over limit or below under limit. Battery Report: Indicator Report: Issued when the indicator light changed. |
2 | Motion | 5 | General: NA | Basic Set: Basic Set Command will be sent to the associated device when motion trigger or untrigger. The basic set value is determined by Param3. See Param4 for more information. |
3 | Over Heat | 5 | Sensor: Temperature | Basic Set: When the temperature change value is over or under the threshold set by Param10. Scale is determined by Param24. |
4 | Under Heat | 5 | Sensor: Temperature | Basic Set: When the light change value is over or under the threshold set by Param11. Scale is determined by Param24. |
5 | Over Light | 5 | Sensor: Illuminance | Basic Set: When the current light/lux is over or under the threshold set by Param12. |
6 | Under Light | 5 | Sensor: Illuminance | Basic Set: When the current light/lux is under or over the threshold set by Param13. |
7 | Temperature | 5 | Sensor: Temperature | Associated device receive Temperature reports from OmniSensor |
Basic CC does not map to any Command Class.
Wakeup
The device stays in sleep status for the majority of time in order to conserve battery life. This will not, however, prevent it from sending motion and other notificatioons on an immediate basis.
The minimum wakeup interval is 1,800 seconds (30 minutes)
The maximum wakeup interval is 86,400 seconds (24 hours)
The default wakeup interval is 28,800 seconds (8 hours) The value is greater, the battery life is longer. Allowable min step among each wakeup interval is 60 seconds, such as 1860s, 1920s, 1980s...
Note: If OmniSensor is in a sleep state for a long time and your gateway shows it is in offline state, you can rediscover it via pressing and holding its Action Button for 3 seconds. OmniSensor will send a wake up notification report to your gateway and let your gateway that it is still online.
Battery
OmniSensor's battery level will be checked every time the device wakes up. These includes the wake-ups owing to the wake-up timer, when motion triggers the sensor, and a pressing of OmniSensor's Action Button. When the percentage of battery life remaining changes, a battery report command will be sent to the controller.
Multilevel Sensor
The device has a temperature/ humidity sensor and an ambient light sensor. The ambient temperature and light will be checked period.
Command Class | COMMAND_CLASS_SENSOR_MULTILEVEL |
Command | SENSOR_MULTILEVEL_REPORT |
Type | Air Temperature |
Scale | Celsius (EU) / Fahrenheit (US) |
Command Class | COMMAND_CLASS_SENSOR_MULTILEVEL |
Command | SENSOR_MULTILEVEL_REPORT |
Type | Illuminance |
Scale | Lux |
Notification
Notification Type | Notification Event/State | Description |
---|---|---|
Home Security (0x07) | State idle | Notification value for the state variable going to idle. |
Motion detection (0x08) | When motion triggered. | |
Power Management (0x08) | Replace battery soon (0x0A) | When battery level below the param14 value. |
Replace battery now (0x0B) | When battery level below 2.2V. | |
System (0x09) | System software failure (manufacturer proprietary failure code provided) (0x04) | When watch dog timeout. |
Manufacturer Information
Parameter | Value |
---|---|
Manufacturer ID 1 | 0x0286 |
Product Type ID 1 | 0x0102 |
Product ID 1 | 0x0004 |
Configuration
User can change the default settings by the below configuration parameters. After device reset, all these parameters will be set to their default values.
Properties:
- R = Readable
- W = Writable
- S = Signed Integer
- U = Unsigned Integer
- E = Enumerated
- B = Bit filed
(Param 3) Motion Untrigger Time
Timeout configuration set in second for motion sensor to send no trigger status.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x03 | 2 | 0~3600 | 240 | R/W/U |
(Param 4) Motion Sensitivity
Set the sensitivity of motion sensor.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x04 | 1 | 0~3 | 3 | R/W/U |
- 0 - disable
- 1 - minimum sensitivity
- 3 - maximum sensitivity
(Param 7) Motion Group Control (Group 2)
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x07 | 1 | 0/1/2/3/4/5/6 | 0 | R/W/E |
The follow are the definitions for the available settings for this command class.
- Send BASIC_SET (0xFF) when motion is triggered to associated device
Send BASIC_SET (0x00) when motion is untriggered to associated device - Send BASIC_SET (0x00) when motion is triggered
Send BASIC_SET (0xFF) when motion is untriggered - Send BASIC_SET (0xFF) when motion is triggered, Nothing when motion untriggered
- Send BASIC_SET (0x00) when motion is triggered, Nothing when motion untriggered
- Send BASIC_SET (0x00) when motion is untriggered, Nothing when motion triggered
- Send BASIC_SET (0xFF) when motion is untriggered, Nothing when motion triggered
- Send BASIC_SET (value is configured by parameter 8) when motion is triggered to associated devices
Send BASIC_SET (value is configured by parameter 8) when motion is untriggered
(Param 8) Motion Group Value Setting
Set Basic Set value for Group2. The MSB will act as the basic set value when motion trigger. The LSB will act as the basic set value when motion untrigger. E.g. value=0x0A00, then BASIC_SET(0x0A) will be sent when motion trigger, BASIC_SET(0x00) will be sent when motion untrigger.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x08 | 2 | 0~65535 | 65280 | R/W/U |
(Param 9) Motion Group Control Requirement
Set threshold of Light/Lux when devices associated in group2 should be triggered by motion. Associated device only receive BASIC_SET command when light <= (this value).
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x09 | 2 | 0~30000 | 30000 | R/W/U |
(Param 10) Over Heat Group Threshold (Group3)
Set threshold of temperature. Designed to control Air Conditioners or temperature controllers ON or OFF. If measured temperature >= (this value, Scale is determined by Param64) send BASIC_SET (0xFF) to associated devices. If measured temperature < (this value) send BASIC_SET (0x00) to associated devices. E.g. Value 239 means 23.9°.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x0A | 2 | 270~850 (EU/AU models) 806~1850 (North American models) | 270 (EU/AU) 806 (US) | R/W/S |
Setting the value to 0 will disable the functionality associatd with this command class.
(Param 11) Under Heat Group Threshold (Group4)
Set threshold of temperature. Designed to control Air Conditioners or temperature controllers ON or OFF. If measured temperature <= (this value, Scale is determined by Param64) send BASIC_SET (0xFF) to associated devices. If measured temperature > (this value) send BASIC_SET (0x00) to associated devices. E.g. Value 155 means 15.5 C. Value 600 means 60.0 F.Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x0B | 2 | -100~155 (EU/AU) 140~ 600 (US) | 155 (EU/AU) 600 (US) | R/W/S |
Setting the value to 0 will disable the functionality associatd with this command class.
(Param 12) Over Light Group Threshold (Group5)
Set threshold of Light/Lux. If measured light/lux >= (this value) send BASIC_SET (0xFF) to associated devices. If measured light < (this value) send BASIC_SET (0x00) to associated devices.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x0C | 2 | 0~30000 | 2000 | R/W/U |
- 0 - Disable.
- 1 ~ 30000 - Enable. Each number in the range of 1 ~ 30000 is equivalent to a lux unit.
(Param 13) Under Light Group Threshold (Group6)
Set threshold of Light/Lux. If measured light/lux <= (this value) send BASIC_SET (0xFF) to associated devices. If measured light/lux > (this value) send BASIC_SET (0x00) to associated devices.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x0D | 2 | 0~30000 | 100 | R/W/U |
(Param 14) Low Battery Threshold
Configure low battery report threshold, sends low battery report via notification and battery report when battery level drops under setting. Unit %.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x0E | 2 | 10~50 | 20 | R/W/U |
(Param 15) Threshold Check Enable/Disable
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x0F | 2 | 0/1 | 0 | R/W/E |
- 0 - Disable
- 1 - Enable
(Param 16) Temperature Threshold
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x10 | 1 | 0~255 | 30 | R/W/U |
Threshold = (Value * 0.1) 0 = disable
(Param 17) Lux Threshold
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x11 | 2 | 0~10000 | 250 | R/W/U |
0 = disable
(Param 18) Threshold Check Time
Set threshold check time in seconds.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x12 | 2 | 60~65535 | 900 | R/W/U |
(Param 19) Sensor Limit Control
This value is bit mask. Used to enable/disable measurement reports for various sensors that is morethan the upper limit value or less than the lower limit value.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x13 | 1 | 1|2|3|4|5|6|7|8|9|10|11|12|13|14|15 | 0 | R/W/B |
- 0 - Disabled
- 1 - Temperature upper level
- 2 - Lux upper level
- 4 - Temperature lower level
- 8 - Lux lower level
Note: this parameter supports combination setting. E.g. if value = 1+2+4+8=15, which means all thelimit reports are enabled.
(Param 20) Temperature Upper Limit
Set upper limit level for temperature set in scale of 0.1. Scale is determined by Param24. If (Current measurement) > (Upper Limit), then report sensor.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x14 | 2 | 280~1000 (EU/AU) 824~2120 (US) | 280 (EU/AU) 824 (US) | R/W/S |
(Param 21) Temperature Lower Limit
Set lower limit level for temperature set in scale of 0.1. Scale is determined by Param24. If (Current Measurement) < (Lower limit), then report sensor.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x15 | 2 | -400~0 (EU/AU) -400~320 (US) | 0 (EU/AU) 320 (US) | R/W/S |
(Param 22) Lux Upper Limit
Set lux upper limit level. If (Current measurement) > (Upper Limit), then report sensor.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x16 | 2 | 0~30000 | 1000 | R/W/U |
(Param 23) Set lux lower limit level.
Set lux lower limit level. If (Current Measurement) < (Lower limit), then report sensor.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x17 | 2 | 0~30000 | 100 | R/W/U |
(Param 24) Temperature Scale
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x18 | 1 | 0/1 | 0 (EU/AU) 1 (US) | R/W/E |
(Param 25) Automatic Interval Time
Interval time set in seconds to check the sensor report. Multilevel Sensor Report will be sent when timeout.
Parameter | Size (Byte) | Available settings | Default value | Property |
---|---|---|---|---|
0x19 | 2 | 30~65535 | 3600 | R/W/U |
11 Security Network
OmniSensor is a security enabled Z-Wave Plus product that is able to use encrypted Z-Wave Plus messages to communicate to other security enabled Z-Wave Plus products.
The device supports the security function with S0 and S2 encrypted communication. The device will auto switch to the security mode when the device included with a security controller. In the security mode, the commands will use security and security2 command class wrapped to communicate with others, otherwise the device will not response any commands.
OmniSensor supports security levels are listed in below table:
Security Levels | Supported? |
---|---|
SECURITY_KEY_S0 | Yes |
SECURITY_KEY_S2_UNAUTHENTICATED | Yes |
SECURITY_KEY_S2_AUTHENTICATED | Yes |
SECURITY_KEY_S2_ACCESS | No |