Skip to content

Latest commit

 

History

History
executable file
·
716 lines (451 loc) · 27 KB

zw100_1_7.md

File metadata and controls

executable file
·
716 lines (451 loc) · 27 KB
layout title
documentation
ZW100 - ZWave

{% include base.html %}

ZW100 MultiSensor 6

This describes the Z-Wave device ZW100, manufactured by AEON Labs with the thing type UID of aeon_zw100_01_007. This version of the device is limited to firmware version 1.7

The device is in the category of Sensor, defining Device used to measure something.

ZW100 product image

The ZW100 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.

Overview

Technical Specifications

  • Battery or USB powered PIR motion sensor, operating distance: Up to 500 feet/150 metres outdoors.
  • Operating temperature: 0°C to 40°C
  • Relative humidity: 8% RH to 80% RH

Inclusion Information

Click one time:

  • Send non-security Node Info Frame
  • Add MultiSensor into Z-wave network (non security inclusion)

Short press 2 times within 1 second:

  • Send Security Node Info Frame
  • Add Multisensor into Z-Wave network (security inclusion)

Exclusion Information

Click one time:

  • Send non-security Node Info Frame
  • Remove MultiSensor from Z-wave network

Short press 2 times within 1 second:

  • Send Security Node Info Frame
  • Remove MultiSensor from network

General Usage Information

Press and hold for 20 seconds:

  • Reset MultiSensor to factory default (see documentation)

Channels

The following table summarises the channels available for the ZW100 -:

Channel Name Channel ID Channel Type Category Item Type
Sensor (relative humidity) sensor_relhumidity sensor_relhumidity Humidity Number
Sensor (ultraviolet) sensor_ultraviolet sensor_ultraviolet Number
Sensor (temperature) sensor_temperature sensor_temperature Temperature Number:Temperature
Sensor (luminance) sensor_luminance sensor_luminance Number
Motion Alarm alarm_motion alarm_motion Motion Switch
Tamper Alarm alarm_tamper alarm_tamper Switch
Battery Level battery-level system.battery_level Battery Number

Sensor (relative humidity)

Indicates the current relative humidity.

The sensor_relhumidity channel is of type sensor_relhumidity and supports the Number item and is in the Humidity category. This is a read only channel so will only be updated following state changes from the device.

Sensor (ultraviolet)

Indicates the current ultraviolet level.

The sensor_ultraviolet channel is of type sensor_ultraviolet and supports the Number item. This is a read only channel so will only be updated following state changes from the device.

Sensor (temperature)

Indicates the current temperature.

The sensor_temperature channel is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.

Sensor (luminance)

Indicates the current light reading.

The sensor_luminance channel is of type sensor_luminance and supports the Number item. This is a read only channel so will only be updated following state changes from the device.

Motion Alarm

Indicates if a motion alarm is triggered.

The alarm_motion channel is of type alarm_motion and supports the Switch item and is in the Motion category. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF OK
ON Alarm

Tamper Alarm

Indicates if the tamper alarm is triggered.

The alarm_tamper channel is of type alarm_tamper and supports the Switch item. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF OK
ON Alarm

Battery Level

Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.

The system.battery-level channel is of type system.battery-level and supports the Number item and is in the Battery category. This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.

Device Configuration

The following table provides a summary of the 31 configuration parameters available in the ZW100. Detailed information on each parameter can be found in the sections below.

Param Name Description
2 Stay Awake in Battery Mode Stay awake for 10 minutes at power on
3 Motion Sensor reset timeout Motion Sensor reset timeout
4 Motion sensor sensitivity Sensitivity level of PIR sensor (1=minimum, 5=maximum)
5 Motion Sensor Triggered Command
9 Report the current power mode Report the current power mode and the product state of battery power mode
39 Low Battery Report Report Low Battery if below this value
40 Selective Reporting Select to report on thresholds
41 Temperature Threshold Temperature change threshold
41 Temperature Threshold Unit Sets the unit of the threshold
41 Temperature Threshold Threshold change in temperature to induce an automatic report.
42 Humidity Threshold Humidity percent change threshold
43 Luminance Threshold Luminance change threshold
44 Battery Threshold Battery level threshold
45 Ultraviolet Threshold Ultraviolet change threshold
46 Send Alarm Report if low temperature Send an alarm report if temperature is less than -15 °C
100 Set parameters 101-103 to default. Reset 101-103 to defaults
101 Group 1 Periodic Reports Periodic reports to send to Group 1
102 Group 2 Periodic Reports Periodic reports to send to Group 2
103 Group 3 Periodic Reports Periodic reports to send to Group 3
110 Set parameters 111-113 to default. Set parameters 111-113 to default.
111 Group 1 Report Interval How often to update Group 1
112 Group 2 Report Interval Group 2 Report Interval
113 Group 3 Report Interval Group 3 Report Interval
201 Temperature Calibration Temperature calibration in 0.1 deg steps
201 Temperature Calibration Unit
201 Temperature Calibration Value Calibration value containing one decimal point
202 Humidity Sensor Calibration Humidity Sensor Calibration
203 Luminance Sensor Calibration Luminance Sensor Calibration
204 Ultraviolet Sensor Calibration Ultraviolet Sensor Calibration
252 Disable/Enable Configuration Lock Disable/Enable Configuration Lock (0=Disable, 1=Enable)
255 Reset to default factory settings
Wakeup Interval Sets the interval at which the device will accept commands from the controller
Wakeup Node Sets the node ID of the device to receive the wakeup notifications

Parameter 2: Stay Awake in Battery Mode

Stay awake for 10 minutes at power on Enable/Disable waking up for 10 minutes when re-power on (battery mode) the MultiSensor.

  1. Value = 0, disable.
  2. Value =others, enable. The following option values may be configured -:
Value Description
0 Disable
1 enable

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_2_1 and is of type INTEGER.

Parameter 3: Motion Sensor reset timeout

Motion Sensor reset timeout

  1. The default PIR time is 4 minutes. The Multisensor will send BASIC SET CC (0x00) to the associated nodes if no motion is triggered again in 4 minutes.
  2. Range: 10~3600.

Note:

  1. The time unit is second if the value range is in 10 to 255.
  2. If the value range is in 256 to 3600, the time unit will be minute and its value should follow the below rules:
    a), Interval time =Value/60, if the interval time can be divided by 60 and without remainder.
    b), Interval time= (Value/60) +1, if the interval time can be divided by 60 and has remainder.
  3. Other values will be ignored. Values in the range 10 to 3600 may be set.

The manufacturer defined default value is 240.

This parameter has the configuration ID config_3_2 and is of type INTEGER.

Parameter 4: Motion sensor sensitivity

Sensitivity level of PIR sensor (1=minimum, 5=maximum)

The following option values may be configured -:

Value Description
0 Disable
1 Enable, sensitivity level 1 (minimum)
2 Enable, sensitivity level 2
3 Enable, sensitivity level 3
4 Enable, sensitivity level 4
5 Enable, sensitivity level 5 (maximum)

The manufacturer defined default value is 5 (Enable, sensitivity level 5 (maximum)).

This parameter has the configuration ID config_4_1 and is of type INTEGER.

Parameter 5: Motion Sensor Triggered Command

The following option values may be configured -:

Value Description
1 Send Basic Set CC
2 Send Sensor Binary Report CC

The manufacturer defined default value is 1 (Send Basic Set CC).

This parameter has the configuration ID config_5_1 and is of type INTEGER.

Parameter 9: Report the current power mode

Report the current power mode and the product state of battery power mode Value1 (MSB): 0x00=USB power mode, 0x01=Battery power mode

Value2 (LSB): 0x00=keep sleep state for Battery power mode, 0x01=keep awake for 10 minutes for battery power mode

NOTE: this parameter cannot be used as Get/Set usage, it is read only. Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_9_2 and is of type INTEGER. This is a read only parameter.

Parameter 39: Low Battery Report

Report Low Battery if below this value Configure low battery value.
Value=10 to 50.(10% to 50%) Values in the range 10 to 50 may be set.

The manufacturer defined default value is 20.

This parameter has the configuration ID config_39_1 and is of type INTEGER.

Parameter 40: Selective Reporting

Select to report on thresholds Enable/disable the selective reporting only when measurements reach a certain threshold or percentage set in 41-44 below. This is used to reduce network traffic. (0 == disable, 1 == enable)

Note: If USB Power, the Sensor will check threshold every 10 seconds. If battery power, the Sensor will check the threshold when it is waken up. The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_40_1 and is of type INTEGER.

Parameter 41: Temperature Threshold

Temperature change threshold Threshold change in temperature to induce an automatic report.
Note:

  1. The unit is Fahrenheit for US version, Celsius for EU/AU version.
  2. High byte is the threshold value. Low byte is the unit (0x01=Celsius, 0x02=Fahrenheit).
  3. The threshold value (high byte) contains one decimal point. E.g. if the value is set to 20 (0x1401), the threshold value =2.0°C (EU/AU version) or if the value is set to 20 (0x1402), the threshold value=2.0 °F (US version). When the current temperature gap is more then 2.0, which will induce a temperature report to be sent out.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 100 may be set.

The manufacturer defined default value is 20.

This parameter has the configuration ID config_41_3 and is of type INTEGER.

Parameter 41: Temperature Threshold Unit

Sets the unit of the threshold

The following option values may be configured -:

Value Description
1 Celsius
2 Fahrenheit

The manufacturer defined default value is 1 (Celsius).

This parameter has the configuration ID config_41_3_0000000F and is of type INTEGER.

Parameter 41: Temperature Threshold

Threshold change in temperature to induce an automatic report.

Values in the range 0 to 100 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_41_3_00FFFF00 and is of type INTEGER.

Parameter 42: Humidity Threshold

Humidity percent change threshold Threshold change in humidity to induce an automatic report.
Note:

  1. The unit is %.
  2. The default value is 10, which means that if the current humidity gap is
    more than 10%, it will send out a humidity report. Values in the range 0 to 100 may be set.

The manufacturer defined default value is 10.

This parameter has the configuration ID config_42_1 and is of type INTEGER.

Parameter 43: Luminance Threshold

Luminance change threshold Threshold change in luminance to induce an automatic report. Values in the range 0 to 1000 may be set.

The manufacturer defined default value is 100.

This parameter has the configuration ID config_43_2 and is of type INTEGER.

Parameter 44: Battery Threshold

Battery level threshold Threshold change in battery level to induce an automatic report.

Note:

  1. The unit is %.
  2. The default value is 10, which means that if the current battery level gap is
    more than 10%, it will send out a battery report. Values in the range 0 to 100 may be set.

The manufacturer defined default value is 10.

This parameter has the configuration ID config_44_1 and is of type INTEGER.

Parameter 45: Ultraviolet Threshold

Ultraviolet change threshold Threshold change in ultraviolet to induce an automatic report. Values in the range 0 to 100 may be set.

The manufacturer defined default value is 2.

This parameter has the configuration ID config_45_1 and is of type INTEGER.

Parameter 46: Send Alarm Report if low temperature

Send an alarm report if temperature is less than -15 °C Enable/Disable to send the alarm report of low temperature (<-15°C)

Value=0, disable

Value=1, enable (The MultiSensor will send a report of Multi Level Temperature CC to controller if the current temperature is less then -15°C).

Note: The battery activity will reduced at low temperatures (-15 degrees Celsius and below), wich will lead to the product may not work normally. It is recommended to use USB power at low temperatures. The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_46_1 and is of type INTEGER.

Parameter 100: Set parameters 101-103 to default.

Reset 101-103 to defaults Set 101-103 to default. Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_100_1_wo and is of type INTEGER. This is a write only parameter.

Parameter 101: Group 1 Periodic Reports

Periodic reports to send to Group 1 This value is a combination number made up of the sum of the values for the individual sensors and battery. The sensors have these values:

  • Battery=1
  • Ultraviolet=16
  • Temperature=32
  • Humidity=64
  • Light=128

1+16+32+64+128 = 241 and is the default value Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 241.

This parameter has the configuration ID config_101_4 and is of type INTEGER.

Parameter 102: Group 2 Periodic Reports

Periodic reports to send to Group 2 This value is a combination number made up of the sum of the values for the individual sensors and battery. The sensors have these values:

  • Battery=1
  • Ultraviolet=16
  • Temperature=32
  • Humidity=64
  • Light=128 Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_102_4 and is of type INTEGER.

Parameter 103: Group 3 Periodic Reports

Periodic reports to send to Group 3 This value is a combination number made up of the sum of the values for the individual sensors and battery. The sensors have these values:

  • Battery=1
  • Ultraviolet=16
  • Temperature=32
  • Humidity=64
  • Light=128 Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_103_4 and is of type INTEGER.

Parameter 110: Set parameters 111-113 to default.

Set parameters 111-113 to default. Set parameters 111-113 to default.    Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_110_1_wo and is of type INTEGER. This is a write only parameter.

Parameter 111: Group 1 Report Interval

How often to update Group 1 The interval time of sending reports in Report group 1 (Valid values 0x05-0x28DE80).

  1. The unit of interval time is second if USB power.
  2. If battery power, the minimum interval time is 60 minutes by default, for example, if the value is set to be more than 5 and less than 3600, the interval time is 60 minutes, if the value is set to be more than 3600 and less than 7200, the interval time is 120 minutes. You can also change the minimum interval time to 4 minutes via setting the interval value(3 bytes) to 240 in Wake Up Interval Set CC. Values in the range 5 to 2678400 may be set.

The manufacturer defined default value is 3600.

This parameter has the configuration ID config_111_4 and is of type INTEGER.

Parameter 112: Group 2 Report Interval

Group 2 Report Interval The interval time of sending reports in Report group 2 (Valid values 0x05-
0x28DE80).
Note:

  1. The unit of interval time is second if USB power.
  2. If battery power, the minimum interval time is 60 minutes by default, for
    example, if the value is set to be more than 5 and less than 3600, the interval
    time is 60 minutes, if the value is set to be more than 3600 and less than 7200,
    the interval time is 120 minutes. You can also change the minimum interval time
    to 4 minutes via setting the interval value(3 bytes) to 240 in Wake Up Interval Set
    CC. Values in the range 5 to 2678400 may be set.

The manufacturer defined default value is 3600.

This parameter has the configuration ID config_112_4 and is of type INTEGER.

Parameter 113: Group 3 Report Interval

Group 3 Report Interval The interval time of sending reports in Report group 3

  1. The unit of interval time is second if USB power.
  2. If battery power, the minimum interval time is 60 minutes by default, for example, if the value is set to be more than 5 and less than 3600, the interval time is 60 minutes, if the value is set to be more than 3600 and less than 7200, the interval time is 120 minutes. You can also change the minimum interval time to 4 minutes via setting the interval value(3 bytes) to 240 in Wake Up Interval Set CC. Values in the range 5 to 2678400 may be set.

The manufacturer defined default value is 3600.

This parameter has the configuration ID config_113_4 and is of type INTEGER.

Parameter 201: Temperature Calibration

Temperature calibration in 0.1 deg steps Temperature calibration (the available value range is [-128,127] or [-12.8°C ,12.7 °C ] ).
Note:

  1. High byte is the calibration value. Low byte is the unit (0x01=Celsius, 0x02=Fahrenheit).
  2. The calibration value (high byte) contains one decimal point. E.g. if the value is set to 20 (0x1401), the calibration value is 2.0°C (EU/AU version) or if the value is set to 20 (0x1402), the calibration value is 2.0 °F (US version)
  3. The calibration value = standard value - measure value. °C and the standard value = 23.2 °C , so the calibration value= 23.2 °C - 25.3 °C = -2.1 °C (0xEB). If the measure value =30.1 °C and the standard value = 33.2 °C , so the calibration value= 33.2 °C - 30.1 °C =3.1 °C (0x1F).This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range -128 to 127 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_201_2 and is of type INTEGER.

Parameter 201: Temperature Calibration Unit

The following option values may be configured -:

Value Description
1 Celsius
2 Fahrenheit

The manufacturer defined default value is 1 (Celsius).

This parameter has the configuration ID config_201_2_000000FF and is of type INTEGER.

Parameter 201: Temperature Calibration Value

Calibration value containing one decimal point

Values in the range -127 to 127 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_201_2_0000FF00 and is of type INTEGER.

Parameter 202: Humidity Sensor Calibration

Humidity Sensor Calibration Humidity sensor calibration (the available value range is [-50, 50]).
The calibration value = standard value - measure value.
E.g. If measure value =80RH and the standard value = 75RH, so the calibration
value= 75RH – 80RH= -5RH (0xFB).
If the measure value =85RH and the standard value = 90RH, so the calibration
value= 90RH – 85RH=5RH (0x05). Values in the range -50 to 50 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_202_1 and is of type INTEGER.

Parameter 203: Luminance Sensor Calibration

Luminance Sensor Calibration Luminance sensor calibration (the available value range is [-1000, 1000]).
The calibration value = standard value - measure value.
E.g. If measure value =800Lux and the standard value = 750Lux, so the
calibration value= 750 – 800= -50 (0xFFCE).
If the measure value =850Lux and the standard value = 900Lux, so the calibration
value= 900 – 850=50 (0x0032). Values in the range -1000 to 1000 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_203_2 and is of type INTEGER.

Parameter 204: Ultraviolet Sensor Calibration

Ultraviolet Sensor Calibration Ultraviolet sensor calibration (the available value range is [-10, 10]).
The calibration value = standard value - measure value.
E.g. If measure value =9 and the standard value = 8, so the calibration value= 8 –
9= -1 (0xFE).
If the measure value =7 and the standard value = 9, so the calibration value= 9 –
7=2 (0x02). Values in the range -10 to 10 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_204_1 and is of type INTEGER.

Parameter 252: Disable/Enable Configuration Lock

Disable/Enable Configuration Lock (0=Disable, 1=Enable) Disable/Enable Configuration Lock (0=Disable, 1=Enable) The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 0 (Disable).

This parameter has the configuration ID config_252_1 and is of type INTEGER.

Parameter 255: Reset to default factory settings

This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. The following option values may be configured -:

Value Description
1 Resets all configuration parameters to defaults
1431655765 Reset to default factory settings and be excluded

The manufacturer defined default value is 0.

This parameter has the configuration ID config_255_4_wo and is of type INTEGER. This is a write only parameter.

Wakeup Interval

The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications.

This setting is defined in seconds. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances.

Note that this setting does not affect the devices ability to send sensor data, or notification events.

This parameter has the configuration ID wakeup_interval and is of type INTEGER.

Wakeup Node

When sleeping devices wake up, they send a notification to a listening device. Normally, this device is the network controller, and normally the controller will set this automatically to its own address. In the event that the network contains multiple controllers, it may be necessary to configure this to a node that is not the main controller. This is an advanced setting and should not be changed without a full understanding of the impact.

This parameter has the configuration ID wakeup_node and is of type INTEGER.

Association Groups

Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.

The ZW100 supports 3 association groups.

Group 1: Group 1

Association group 1 supports 5 nodes.

Group 2: Group 2

Association group 2 supports 5 nodes.

Group 3: Group 3

Association group 3 supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_BINARY_V1 Linked to BASIC
COMMAND_CLASS_SENSOR_MULTILEVEL_V5
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V1
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_BATTERY_V1
COMMAND_CLASS_WAKE_UP_V2
COMMAND_CLASS_ASSOCIATION_V1
COMMAND_CLASS_VERSION_V1

Documentation Links


Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.