| layout | title |
|---|---|
documentation |
TZ04 - ZWave |
{% include base.html %}
This describes the Z-Wave device TZ04, manufactured by TKB Home with the thing type UID of tkb_tz04_00_000.
The TZ04 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.
No device information is provided in the database. Consider updating the database to improve the documentation.
The following table summarises the channels available for the TZ04 -:
| Channel | Channel Id | Category | Item Type |
|---|---|---|---|
| Switch | switch_binary | Switch | Switch |
| Electric meter (kWh) | meter_kwh | Energy | Number |
| Electric meter (watts) | meter_watts | Energy | Number |
| Electric meter (power factor) | meter_powerfactor | Energy | Number |
| Electric meter (volts) | meter_voltage | Energy | Number |
| Electric meter (amps) | meter_current | Energy | Number |
| Alarm | alarm_general | Door | Switch |
| Switch 1 | switch_binary1 | Switch | Switch |
| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number |
| Electric meter (watts) 1 | meter_watts1 | Energy | Number |
| Electric meter (power factor) 1 | meter_powerfactor1 | Energy | Number |
| Electric meter (volts) 1 | meter_voltage1 | Energy | Number |
| Electric meter (amps) 1 | meter_current1 | Energy | Number |
| Switch 2 | switch_binary2 | Switch | Switch |
| Electric meter (kWh) 2 | meter_kwh2 | Energy | Number |
| Electric meter (watts) 2 | meter_watts2 | Energy | Number |
| Electric meter (power factor) 2 | meter_powerfactor2 | Energy | Number |
| Electric meter (volts) 2 | meter_voltage2 | Energy | Number |
| Electric meter (amps) 2 | meter_current2 | Energy | Number |
| Switch 3 | switch_binary3 | Switch | Switch |
| Electric meter (kWh) 3 | meter_kwh3 | Energy | Number |
| Electric meter (watts) 3 | meter_watts3 | Energy | Number |
| Electric meter (power factor) 3 | meter_powerfactor3 | Energy | Number |
| Electric meter (volts) 3 | meter_voltage3 | Energy | Number |
| Electric meter (amps) 3 | meter_current3 | Energy | Number |
Switch the power on and off.
The switch_binary channel supports the Switch item and is in the Switch category.
Indicates the energy consumption (kWh).
The meter_kwh channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power consumption.
The meter_watts channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power factor.
The meter_powerfactor channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous voltage.
The meter_voltage channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous current consumption.
The meter_current channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates if an alarm is triggered.
The alarm_general 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 |
Switch the power on and off.
The switch_binary1 channel supports the Switch item and is in the Switch category.
Indicates the energy consumption (kWh).
The meter_kwh1 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power consumption.
The meter_watts1 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power factor.
The meter_powerfactor1 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous voltage.
The meter_voltage1 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous current consumption.
The meter_current1 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Switch the power on and off.
The switch_binary2 channel supports the Switch item and is in the Switch category.
Indicates the energy consumption (kWh).
The meter_kwh2 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power consumption.
The meter_watts2 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power factor.
The meter_powerfactor2 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous voltage.
The meter_voltage2 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous current consumption.
The meter_current2 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Switch the power on and off.
The switch_binary3 channel supports the Switch item and is in the Switch category.
Indicates the energy consumption (kWh).
The meter_kwh3 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power consumption.
The meter_watts3 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous power factor.
The meter_powerfactor3 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous voltage.
The meter_voltage3 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
Indicates the instantaneous current consumption.
The meter_current3 channel supports the Number item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.
The following table provides a summary of the 10 configuration parameters available in the TZ04. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 1 | W meter report period | Period for reporting W meter |
| 2 | kWh meter report period | Period for reporting kWh meter |
| 3 | Selected endpoint | Which endpoint is addressed by the BASIC command class |
| 4 | Switch mode | Change the external switch mode |
| 5 | Threshold of Watt for Load Caution | If threshold of wattage is reached, a meter report will be generated |
| 6 | Threshold of kWh for Load Caution | If threshold of kWh is reached, a Meter Report will be generated |
| 7 | Restore switch state mode | Restore switch state mode |
| 8 | Auto Off Timer | Auto Off Timer |
| 9 | RF off command mode | RF off command mode |
| 10 | Endpoint 3 | Endpoint 3 |
| Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
Period for reporting W meter If the setting is configured for 1 hour (value = 720), the device will report its instant power consumption every 1 hour to Z-Wave Controller. Unit: 5 seconds Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 720.
This parameter has the configuration ID config_1_2 and is of type INTEGER.
Period for reporting kWh meter If the setting is configured for 1 hour (value = 6), the device will report its total power consumption every 1 hour to Z-Wave Controller.
Unit: 10 minutes Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 6.
This parameter has the configuration ID config_2_2 and is of type INTEGER.
Which endpoint is addressed by the BASIC command class If the Controller is not using Multi_Channel command class to access the endpoint of TZ04, you may configure the endpoint value to react the Basic Command Class The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | Relay 1 + 2 |
| 2 | Relay 1 |
| 3 | Relay 2 |
The manufacturer defined default value is 1 (Relay 1 + 2).
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Change the external switch mode Manual switch S1 and S2 can be set to Edge mode, Pulse mode or Edge-Toggle mode. The default value is Edge mode.
Edge mode: This mode is suitable for toggle (bi-stable) wall switches that have an indicator point on the switch and the position corresponds to the same state of relay 1 and relay 2. If the TZ04 relay changes state due to a Z-Wave command, the switch may need to be toggled twice (On->Off or Off->On) to change the relay state.
Pulse Mode: This mode is suitable for momentary contact type wall switches to change the state of relay 1 or relay 2.
Edge-Toggle mode: This mode is suitable for normal toggle (bi-stable) switches. Every time the state of the wall switch changes the state of relay 1 or relay 2 will also change. The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | Edge mode |
| 2 | Pulse mode |
| 3 | Edge-Toggle mode |
The manufacturer defined default value is 1 (Edge mode).
This parameter has the configuration ID config_4_1 and is of type INTEGER.
If threshold of wattage is reached, a meter report will be generated
Values in the range 10 to 1500 may be set.
The manufacturer defined default value is 1500.
This parameter has the configuration ID config_5_2 and is of type INTEGER.
If threshold of kWh is reached, a Meter Report will be generated
Values in the range 1 to 10000 may be set.
The manufacturer defined default value is 10000.
This parameter has the configuration ID config_6_2 and is of type INTEGER.
Restore switch state mode Restores the switch state setting in case the device was disconnected from the power source. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Switch Off |
| 1 | Last State |
| 2 | Switch On |
The manufacturer defined default value is 1 (Last State).
This parameter has the configuration ID config_7_1 and is of type INTEGER.
Auto Off Timer Whenever the device switches to on, the auto off timer begin to count down. After the timer decrease to zero, it will switch off automatically. Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_8_2 and is of type INTEGER.
RF off command mode Whenever a switch off command, BASIC_SET, BINARY_SWITCH_SET, SWITCH_ALL_OFF, is received, it could be interpreted as 4 kinds of commands. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Switch Off |
| 1 | Ignore |
| 2 | Switch Toggle |
| 3 | Switch On |
The manufacturer defined default value is 1 (Ignore).
This parameter has the configuration ID config_9_1 and is of type INTEGER.
Endpoint 3 Multi-Channel Command is a good way to control relay1 and relay2 of TZ04 individually. The endpoint3 of TZ04 is related to both relay1 and relay2. In some condition it becomes redundant in Multi-Channel Command Class. The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | Exists |
| 2 | Doesn't Exist |
The manufacturer defined default value is 1 (Exists).
This parameter has the configuration ID config_10_1 and is of type INTEGER.
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID switchall_mode 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 TZ04 supports 3 association groups.
Association group 1 supports 1 node.
Association group 2 supports 1 node.
Association group 3 supports 1 node.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_NO_OPERATION_V1 | |
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SWITCH_BINARY_V1 | Linked to BASIC |
| COMMAND_CLASS_SWITCH_ALL_V1 | |
| COMMAND_CLASS_METER_V3 | |
| COMMAND_CLASS_MULTI_CHANNEL_V2 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_ALARM_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1 | |
| COMMAND_CLASS_ASSOCIATION_V1 | |
| COMMAND_CLASS_VERSION_V1 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SWITCH_BINARY_V1 | Linked to BASIC |
| COMMAND_CLASS_METER_V3 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SWITCH_BINARY_V1 | Linked to BASIC |
| COMMAND_CLASS_METER_V3 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SWITCH_BINARY_V1 | Linked to BASIC |
| COMMAND_CLASS_METER_V3 |
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.