The openHAB Documentation Has Moved

The documentation has moved to openhab.org/docs and openhab.org/addons.

Please use the link below to be redirected to the new version of this article, and update your bookmarks.

HKZW-SO05 Smart Plug

This describes the Z-Wave device HKZW-SO05, manufactured by Hank with the thing type UID of hank_so05_00_000.

HKZW-SO05 product image

The HKZW-SO05 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 from other devices.

Overview

Smart plug is a Z-Wave Switch plugin module specifically used to enable Z-Wave command and control (on/off) of any plug-in tool. It can report wattage consumption or kWh energy usage. Smart Plug is also a security Z-Wave device and supports the Over The Air (OTA) feature for the product’s firmware upgrade.

HKZW-SO05 is a Smart Plug based on Z-Wave plus specification

The features list:

1) Supports 1xAC output and 2xUSB outputs;

2) AC output switch on/off by manual or Z-Wave command;

3) RGB LED indicates the Z-Wave network range;

4) RGB LED indicates the load power;

5) Z-Wave plus compatible (500 serials product);

6) supporting power meter;

7) supporting repeater role;

Supporting firmware OTA;

Inclusion Information

Automatic Z-Wave network inclusion:

1) Set the Z-Wave network main controller into inclusion mode.

2) Insert the Plug into a socket.

3) Auto-inclusion will be activated, i.e. Plug automatically starts looking for Z-Wave network controller. Auto-inclusion activation is signaled by a single, RGB LED indicator blink fast in blue.

4) Smart Plug should be recognized and automatically included into the Z-Wave network.

Manual Z-Wave network inclusion:

1) Connect the power supply.

2) Set the Z-Wave network main controller into inclusion mode.

3) Triple click the Z-button, RGB LED indicator should blink fast in blue.

4) Smart Plug should be recognized and included into the Z-Wave network.

Included as a secure device:

1) Connect the power supply.

2) Set the Z-Wave network main controller into secure inclusion mode.

3) Press and hold the Z-button for more than 3 seconds, RGB LED indicator should blink fast in green.

4) Smart Plug should be recognized and included into the Z-Wave security network.

Exclusion Information

To remove Smart Plug from the Z-Wave network:

1) Insert the plug into a socket.

2) Set the Z-Wave network main controller into exclusion mode.

3) Triple click the Z-button.

4) RGB LED indicator will blink orange till the removing process is completed, then the indicator will keep orange for 3 seconds.

Channels

The following table summarises the channels available for the HKZW-SO05 -:

Channel Channel Id Category Item Type
Switch switch_binary Switch Switch
Scene Number scene_number   Number
Electric meter (kWh) meter_kwh Energy Number
Electric meter (watts) meter_watts Energy Number
Electric meter (volts) meter_voltage Energy Number
Electric meter (amps) meter_current Energy Number

Switch

Switch the power on and off.

The switch_binary channel supports the Switch item and is in the Switch category.

Scene Number

Triggers when a scene button is pressed.

The scene_number channel supports the Number item.

Electric meter (kWh)

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.

Electric meter (watts)

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.

Electric meter (volts)

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.

Electric meter (amps)

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.

Device Configuration

The following table provides a summary of the 10 configuration parameters available in the HKZW-SO05. Detailed information on each parameter can be found in the sections below.

Param Name Description
20 Overload Protection Turn off if the load power exceeds 0.5A for more than 5s.
21 Device Status After Power Failure. Define how the Plug reacts after the power supply is back on.
24 Load Status Change Notification Send notification to associated devices when load is changed.
27 Indicator Modes The RGB LED indicator will indicate the load.
151 Power Report Threshold Power threashold for when to send reports to associated devices
152 Power Report Percentage Threshold Percentage threshold for when to send report to associated devices
171 Power Report Frequence The interval of sending power report to association device.
172 Energy Report Frequence The interval of sending energy report to association device.
173 Voltage Report Frequency The interval of sending voltage report to association device.
174 Electricity Report Frequency The interval of sending electricity report to association device.
  Switch All Mode Set the mode for the switch when receiving SWITCH ALL commands

Parameter 20: Overload Protection

Turn off if the load power exceeds 0.5A for more than 5s.

The following option values may be configured -:

Value Description
0 Function Disabled
1 Function enabled

The manufacturer defined default value is 1 (Function enabled).

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

Parameter 21: Device Status After Power Failure.

Define how the Plug reacts after the power supply is back on.

The following option values may be configured -:

Value Description
0 Memorizes its state after a power failure
1 Always on after power failure.
2 Always off after power failure.

The manufacturer defined default value is 0 (Memorizes its state after a power failure).

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

Parameter 24: Load Status Change Notification

Send notification to associated devices when load is changed.

The following option values may be configured -:

Value Description
0 Function is disabled
1 Send Basic Report
2 Only when load condition is not changed by command.

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

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

Parameter 27: Indicator Modes

The RGB LED indicator will indicate the load.

The following option values may be configured -:

Value Description
0 Will work in indicator mode.
1 Indicate load for 5 seconds after load has changed.

The manufacturer defined default value is 0 (Will work in indicator mode.).

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

Parameter 151: Power Report Threshold

Power threashold for when to send reports to associated devices When the change value of the load power exceeds the threshold, the meter report is send to associated devices. 0 – The function is disabled. Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 50.

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

Parameter 152: Power Report Percentage Threshold

Percentage threshold for when to send report to associated devices When the change value of the load power exceeds the threshold, the meter report is send to associated devices.

0 – The function is disabled. Values in the range 0 to 255 may be set.

The manufacturer defined default value is 10.

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

Parameter 171: Power Report Frequence

The interval of sending power report to association device. The interval of sending power report to association device.

0 = The function is disabled. Values in the range 5 to 2678400 may be set.

The manufacturer defined default value is 30.

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

Parameter 172: Energy Report Frequence

The interval of sending energy report to association device. The interval of sending energy report to association device.

0 = The function is disabled. Values in the range 5 to 2678400 may be set.

The manufacturer defined default value is 300.

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

Parameter 173: Voltage Report Frequency

The interval of sending voltage report to association device. The interval of sending voltage report to association device.

0 = The function is disabled. Values in the range 0 to 2678400 may be set.

The manufacturer defined default value is 0.

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

Parameter 174: Electricity Report Frequency

The interval of sending electricity report to association device. The interval of sending electricity report to association device.

0 = The function is disabled. Values in the range 0 to 2678400 may be set.

The manufacturer defined default value is 0.

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

Switch All Mode

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

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 HKZW-SO05 supports 1 association group.

Group 1: Lifeline

Meter, Basic etc. This group supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

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_SCENE_ACTIVATION_V1  
COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1  
COMMAND_CLASS_METER_V3  
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1  
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1  
COMMAND_CLASS_ZWAVEPLUS_INFO_V1  
COMMAND_CLASS_CONFIGURATION_V1  
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1  
COMMAND_CLASS_POWERLEVEL_V1  
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1  
COMMAND_CLASS_ASSOCIATION_V2  
COMMAND_CLASS_VERSION_V2  

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