| layout | title |
|---|---|
documentation |
TSM02 - ZWave |
{% include base.html %}
This describes the Z-Wave device TSM02, manufactured by TKB Home with the thing type UID of tkb_tsm02_00_000.
The device is in the category of Sensor, defining Device used to measure something.
The TSM02 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.
The TSM02 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. Refer to the Wakeup Information section below for further information.
The TSM02 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour.
The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The following table summarises the channels available for the TSM02 -:
| Channel | Channel Id | Category | Item Type |
|---|---|---|---|
| Motion Sensor | alarm_motion | Door | Switch |
| Tamper Alarm | alarm_tamper | Switch | |
| Door/Window Sensor | sensor_door | Door | Contact |
| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature |
| Sensor (luminance) | sensor_luminance | Number | |
| Battery Level | battery-level | Battery | Number |
Indicates if a motion alarm is triggered.
The alarm_motion channel supports the Switch item and is in the Door 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 |
Indicates if the tamper alarm is triggered.
The alarm_tamper channel 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 |
Indicates if the door/window is open or closed.
The sensor_door channel supports the Contact item and is in the Door 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 Contact item type -:
| Value | Label |
|---|---|
| OPEN | Open |
| CLOSED | Closed |
Indicates the current temperature.
The sensor_temperature channel supports the Number:Temperature item and is in the Temperature category.
Indicates the current light reading.
The sensor_luminance channel supports the Number item. This is a read only channel so will only be updated following state changes from the device.
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 battery-level channel supports the Number item and is in the Battery category.
The following table provides a summary of the 11 configuration parameters available in the TSM02. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 2 | Basic Set Level | -1 -> 0xFF(-1) turns on the light. 1 - 100 -> For dimmers 1 to 100 means the light strength |
| 3 | PIR Sensitivity | parameter to set the Sensitivity for the PIR (Passive Infrared Sensor) 0 -> 0 means disable the PIR motion; 1 - 99 -> 1 means the lowest sensitivity, 99 means the highest sensitivity |
| 4 | Light Threshold | Setting the illumination threshold to turn on the light. When the event triggered and the environment illumination lower then the threshold, the device will turn on the light 0 -> 0 means turn off illumination detected function And never turn on the |
| 5 | Operation Mode | Bit 0: 1 means security mode; 0 means home automation mode. Bit 1: 1 means enable test mode; 0 means disable test mode. Notice: Bit0 and Bit1 will effect when the DIP Switch setting to program mode. If Bit1 is enabled, the Bit0 is useless. Bit 2: Disable |
| 6 | Multi-Sensor Function Switch | Bit 0: Disable magnetic integrate illumination. Bit 1: Disable PIR integrate Illumination. Bit 2: Disable magnetic integrate PIR (Default is Disable) Bit 3: When Bit2 is 0 (Enable), the device is install in the same room with the light? 0: In the same roo |
| 8 | PIR Re-Detect Interval Time | In the security mode, after the PIR motion detected, setting the re-detect time 3 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 24 seconds, default tick is 3 (24 seconds). |
| 9 | Turn Off Light Time | After turn on the light, setting the delay time to turn off the light when the PIR motion is not detected 4 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 32 seconds, default tick is 4 (32 seconds) |
| 10 | Auto Report Battery Time | interval time for auto report the battery level 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) |
| 11 | Auto Report Door/Window State Time | interval time for auto report the door/window state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) |
| 12 | Auto Report Illumination Time | interval time for auto report the illumination state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) |
| 13 | Auto Report Temperature Time | Interval time for auto report the temperature state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) |
| 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 |
-1 -> 0xFF(-1) turns on the light. 1 - 100 -> For dimmers 1 to 100 means the light strength
Values in the range -1 to 100 may be set.
The manufacturer defined default value is -1.
This parameter has the configuration ID config_2_1 and is of type INTEGER.
parameter to set the Sensitivity for the PIR (Passive Infrared Sensor) 0 -> 0 means disable the PIR motion; 1 - 99 -> 1 means the lowest sensitivity, 99 means the highest sensitivity
Values in the range 0 to 99 may be set.
The manufacturer defined default value is 70.
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Setting the illumination threshold to turn on the light. When the event triggered and the environment illumination lower then the threshold, the device will turn on the light 0 -> 0 means turn off illumination detected function And never turn on the
Values in the range 0 to 100 may be set.
The manufacturer defined default value is 100.
This parameter has the configuration ID config_4_1 and is of type INTEGER.
Bit 0: 1 means security mode; 0 means home automation mode. Bit 1: 1 means enable test mode; 0 means disable test mode. Notice: Bit0 and Bit1 will effect when the DIP Switch setting to program mode. If Bit1 is enabled, the Bit0 is useless. Bit 2: Disable
Values in the range 0 to 127 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_5_1 and is of type INTEGER.
Bit 0: Disable magnetic integrate illumination. Bit 1: Disable PIR integrate Illumination. Bit 2: Disable magnetic integrate PIR (Default is Disable) Bit 3: When Bit2 is 0 (Enable), the device is install in the same room with the light? 0: In the same roo
Values in the range 0 to 127 may be set.
The manufacturer defined default value is 4.
This parameter has the configuration ID config_6_1 and is of type INTEGER.
In the security mode, after the PIR motion detected, setting the re-detect time 3 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 24 seconds, default tick is 3 (24 seconds).
Values in the range 3 to 127 may be set.
The manufacturer defined default value is 3.
This parameter has the configuration ID config_8_1 and is of type INTEGER.
After turn on the light, setting the delay time to turn off the light when the PIR motion is not detected 4 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 32 seconds, default tick is 4 (32 seconds)
Values in the range 4 to 127 may be set.
The manufacturer defined default value is 4.
This parameter has the configuration ID config_9_1 and is of type INTEGER.
interval time for auto report the battery level 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours)
Values in the range 1 to 127 may be set.
The manufacturer defined default value is 12.
This parameter has the configuration ID config_10_1 and is of type INTEGER.
interval time for auto report the door/window state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours)
Values in the range 1 to 127 may be set.
The manufacturer defined default value is 12.
This parameter has the configuration ID config_11_1 and is of type INTEGER.
interval time for auto report the illumination state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours)
Values in the range 1 to 127 may be set.
The manufacturer defined default value is 12.
This parameter has the configuration ID config_12_1 and is of type INTEGER.
Interval time for auto report the temperature state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours)
Values in the range 1 to 127 may be set.
The manufacturer defined default value is 12.
This parameter has the configuration ID config_13_1 and is of type INTEGER.
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.
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 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 TSM02 supports 2 association groups.
Association group 1 supports 7 nodes.
Association group 2 supports 7 nodes.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_NO_OPERATION_V1 | |
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SENSOR_BINARY_V2 | |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V5 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1 | |
| COMMAND_CLASS_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V2 | |
| COMMAND_CLASS_ASSOCIATION_V1 | |
| COMMAND_CLASS_VERSION_V1 |
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.