| layout | title |
|---|---|
documentation |
WPS104 - ZWave |
{% include base.html %}
This describes the Z-Wave device WPS104, manufactured by wiDom with the thing type UID of widom_wps104_00_000.
The device is in the category of Wall Switch, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
The WPS104 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.
WiDom Energy Driven Switch is a device designed to monitor all parameters, usage, faults and overloads of your electrical system. Unlike an ordinary energy meter, WiDom Energy Driven Switch can be installed to monitor an entire electricity network or a section of the latter.
· Active Energy-saving management
Automatically connects and disconnects a specific load if the established threshold limit is exceeded, or supplies the required power, momentarily excluding non-priority loads.
· Management and prevention of electrical faults
Identifies malfunctions based on irregular consumptions and to the maximum time of activity.
· Electrical overload management
Notifies or disconnects non-priority loads in the eventuality of system overloads.
If the device is not included into a Z-Wave network, a single click on the (B) button or on the external switch will launch the process of traditional inclusion. If the device inclusion procedure does not start within 2 seconds, the Network Wide Inclusion network will be launched lasting a variable amount of time between 15-30 seconds
Only a controller can remove a device from the network. WiDom Energy Driven Switch is compatible with all Z-Wave certified controllers. After the exclusion procedure has been activated by the controller, the device can be removed, putting it in Exclusion Mode by three consecutive clicks on the (B) button or on the external switch, when available.
The following table summarises the channels available for the WPS104 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|---|---|---|---|---|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Sensor (power) | sensor_power | sensor_power | Energy | Number |
| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number |
| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number |
| Electric meter (amps) | meter_current | meter_current | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Meter Reset | meter_reset | meter_reset | Energy | Switch |
Switch the power on and off.
The switch_binary channel is of type switch_binary and supports the Switch item and is in the Switch category.
Indicates the energy consumption (kWh).
The sensor_power channel is of type sensor_power and 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 is of type meter_voltage and 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 is of type meter_powerfactor and 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 is of type meter_current and 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 is of type meter_watts and 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 energy consumption (kWh).
The meter_kwh channel is of type meter_kwh and 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.
Reset the meter.
The meter_reset channel is of type meter_reset and supports the Switch item and is in the Energy category.
The following table provides a summary of the 32 configuration parameters available in the WPS104. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 1 | Device Status | How to control the relay |
| 20 | Device status upon receipt of a Basic Set command | Device status upon receipt of a Basic Set command |
| 30 | Overcurrent Level | Sets the overcurrent level |
| 31 | Overcurrent Time | Sets the time to recognize an overcurrent event. |
| 32 | Next State | Defines the next state if an overcurrent event occurr |
| 33 | Meter Reset | Provides total operating time from last meter reset |
| 34 | Energy flow | Determines whether if energy consumed or energy produced. |
| 35 | UP Power Level | Sets the level of instantaneous power in Watts |
| 36 | UP Power Time | Sets the time in seconds |
| 37 | UP Power State | Defines the next status case of a UP Power event |
| 38 | UP Power Associated | Defines the status of Group 2 devices |
| 39 | DOWN Power Level | Sets the level of instantaneous power in Watts |
| 40 | DOWN Power Time | Sets the time in seconds |
| 41 | DOWN Power State | Defines the next state case of a DOWN Power event |
| 42 | DOWN Power Associated | Defines the status of Group 3 devices |
| 43 | Energy Level | Sets the energy level in KWh |
| 44 | Energy Limit State | Defines the next state in case of Energy Limit event |
| 45 | Variation Instantaneous Power | Defines the percentage variation of instantaneous power |
| 46 | Report Time Frequency | Defines the time in minutes |
| 47 | Variation Total Energy | Defines the increase energy to generate a report |
| 48 | Nominal Voltage | Defines the nominal voltage value in tenths of volts |
| 49 | Fall In Maximum Voltage | Defines, the nominal value for max voltage fall permitted |
| 50 | Electric parameters | Defines which parameters will be subjected to notification |
| 51 | Voltage RMS value | Reading of this parameter returns the value of voltage RMS |
| 52 | Current RMS value | Returns the value of current RMS expressed in hundredths of Amperes. |
| 53 | Power Factor | Returns the value of power factor as a percentage |
| 54 | Total energy consumed | Returns the value of total energy consumed expressed in Wh (thousandths of KWh). |
| 55 | Total energy produced | Returns the value of total energy consumed expressed in Wh (thousandths of KWh). |
| 60 | Start-up status | Defines the status of the device following a restart. |
| 61 | Configuration reset | Defines which parameters should be reset to default values. |
| 62 | Type of external switch | Defines the type of external switch connected to the device. |
| 63 | Load Control | Defines the load control mode |
| Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
How to control the relay Controlling the relay by means of a single click on the external switch or on the integrated button. The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | TOGGLE:ON/OFF |
| 2 | On |
| 3 | Off |
| 4 | IGNORE |
The manufacturer defined default value is 1 (TOGGLE:ON/OFF).
This parameter has the configuration ID config_1_1 and is of type INTEGER.
Device status upon receipt of a Basic Set command The final status achieved by the device when it receives a Basic Set command through the Z-Wave network. The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | AS_RECEIVED |
| 2 | IGNORE_IF_ON |
| 3 | IGNORE_IF_OFF |
| 4 | IGNORE |
The manufacturer defined default value is 1 (AS_RECEIVED).
This parameter has the configuration ID config_20_1 and is of type INTEGER.
Sets the overcurrent level Sets the current level above which the time spent above that level is measured.
Version C: From 0 to 4500[1] hundredths of Amperes – Default Value: 4500 Hundredths of Amperes
Version S: From 0 to 1250 hundredths of Amperes – Default Value: 1250 Hundredths of Amperes Values in the range 0 to 4500 may be set.
The manufacturer defined default value is 4500.
This parameter has the configuration ID config_30_2 and is of type INTEGER.
Sets the time to recognize an overcurrent event. Sets the time beyond which, in the case of overcurrent at a level higher than that established in parameter 30, an OverCurrent event occurs.
From 0 to 10800 Seconds (3 Hours) – Default Value: 10 Seconds Values in the range 0 to 10800 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_31_2 and is of type INTEGER.
Defines the next state if an overcurrent event occurr Defines the next state of the device if an overcurrent event has occurred The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | IGNORE |
| 1 | On |
| 2 | Off |
| 3 | TOGGLE |
The manufacturer defined default value is 0 (IGNORE).
This parameter has the configuration ID config_32_1 and is of type INTEGER.
Provides total operating time from last meter reset Provides total operating time from last meter reset. When set to 0 it resets the cumulative values of energy and total operating time. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Reset Meter and time |
| 1 | Greater than 0 – IGNORE |
The manufacturer defined default value is 1 (Greater than 0 – IGNORE ).
This parameter has the configuration ID config_33_4 and is of type INTEGER.
Determines whether if energy consumed or energy produced. Determines whether energy events are related to energy consumed or energy produced. The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | CONSUMED |
| 2 | PRODUCED |
The manufacturer defined default value is 1 (CONSUMED).
This parameter has the configuration ID config_34_1 and is of type INTEGER.
Sets the level of instantaneous power in Watts The upper limit power threshold detector determines when instantaneous power remains above the threshold point (UP Power Level) beyond a specified duration (UP Power Time). When this happens, a UP Power Event occurs.
Sets the level of instantaneous power in Watts beyond which time of permanence above this level is calculated.
Version C: From 0 to 11250[1] – Default value: 11250
Version S: From 0 to 3000 – Default value: 3000 Values in the range 0 to 11250 may be set.
The manufacturer defined default value is 11250.
This parameter has the configuration ID config_35_2 and is of type INTEGER.
Sets the time in seconds Sets the time in seconds beyond which, if instantaneous power remains at levels exceeding threshold defined by parameter 35, a UP Power event occurs.
From 0 to 10800 seconds (3 Hours) – Default value: 10 Seconds Values in the range 0 to 10800 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_36_2 and is of type INTEGER.
Defines the next status case of a UP Power event Defines the next status of the device in the case of a UP Power event occurring. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | IGNORE |
| 1 | On |
| 2 | Off |
| 3 | TOGGLE |
The manufacturer defined default value is 0 (IGNORE).
This parameter has the configuration ID config_37_1 and is of type INTEGER.
Defines the status of Group 2 devices Defines the status of associated devices in the presence of a UP Power event.
From: 1 to 99 for dimming purpose
0 (OFF) and -1(ON) for switching ON/OFF.
Default: 0 – OFF Values in the range -1 to 99 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_38_1 and is of type INTEGER.
Sets the level of instantaneous power in Watts Sets the level of instantaneous power beyond which the time of permanence below this level is calculated.
From 0 to 11250 Watt – Default value: 0 W Values in the range 0 to 11250 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_39_2 and is of type INTEGER.
Sets the time in seconds Sets the time beyond which, if instantaneous power remains at levels below threshold defined by parameter 39, a DOWN Power event occurs. From 0 to 10800 Seconds (3 Hours) – Default value: 10 Seconds Values in the range 0 to 10800 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_40_2 and is of type INTEGER.
Defines the next state case of a DOWN Power event Defines the next state of the device in the case of a DOWN Power event occurring. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | IGNORE |
| 1 | On |
| 2 | Off |
| 3 | TOGGLE |
The manufacturer defined default value is 0 (IGNORE).
This parameter has the configuration ID config_41_1 and is of type INTEGER.
Defines the status of Group 3 devices Defines the status of associated devices in the presence of a DOWN Power event.
From: 1 to 99 for dimming purpose
– 0 (OFF) and -1(ON) for switching ON/OFF.
Default: 0 – OFF Values in the range -1 to 99 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_42_1 and is of type INTEGER.
Sets the energy level in KWh Sets the energy level that once exceeded an Energy Limit event occurs**.**
From 0 to 2.000.000 KWh – Default value: 2.000.000 KWh Values in the range 0 to 2000000 may be set.
The manufacturer defined default value is 2000000.
This parameter has the configuration ID config_43_4 and is of type INTEGER.
Defines the next state in case of Energy Limit event Defines the next state of the device in the case of an Energy Limit event occurring. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | IGNORE |
| 1 | On |
| 2 | Off |
| 3 | TOGGLE |
The manufacturer defined default value is 0 (IGNORE).
This parameter has the configuration ID config_44_1 and is of type INTEGER.
Defines the percentage variation of instantaneous power Defines the percentage variation of instantaneous power determining the sending of the report**.**
From: 1 (1%) to 100 (100%) Default value: 10 – 10% Values in the range 1 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_45_1 and is of type INTEGER.
Defines the time in minutes Defines the maximum time in minutes since the previous report beyond which an Instantaneous Power Report will still be sent.
From: 1 to 100 minutes. Default value: 10 minutes Values in the range 1 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_46_1 and is of type INTEGER.
Defines the increase energy to generate a report Defines the increase of total energy required to generate a report listing the level of total energy to the devices associated to the Energy Notification Group The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | IGNORE: No report provided. |
| 1 | No report provided. |
| 2 | Report at 1 hundredth of KWh. |
| 3 | Report at 1 tenth of KWh |
| 4 | Report at 1 KWh |
The manufacturer defined default value is 3 (Report at 1 tenth of KWh).
This parameter has the configuration ID config_47_1 and is of type INTEGER.
Defines the nominal voltage value in tenths of volts Defines the nominal voltage value in tenths of volts. Together with parameter No. 49 this is used by the automatic notification system to send reports on variations of voltage.
Default value: 2300
From: 1100 to 2500 Values in the range 1100 to 2500 may be set.
The manufacturer defined default value is 2300.
This parameter has the configuration ID config_48_2 and is of type INTEGER.
Defines, the nominal value for max voltage fall permitted Defines, as a percentage, the nominal value for permitted fall in maximum voltage.
From: 1 (1%) to 100 (100%) Default value: 10 – 10% Values in the range 1 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_49_1 and is of type INTEGER.
Defines which parameters will be subjected to notification Defines which electric parameters, other than power, will be subjected to automatic notification.
The value to be set for this parameter must be calculated as the sum of values associated to the individual electric parameter indicated in the table of Manual.
To send report only for Power please set the value to 0.
To send report only for Power and Energy please set the value to 2 (0+2).
To send report for Power, Energy, Voltage, Current, Power Factor please set the value to 30 (0+2+4+8+16).
By default the report are sent for (Power, Energy, Voltage, Current, Power Factor) 0+2+4+8+16à30
Default value: 30
Permitted values: From 0 to 62 Values in the range 0 to 62 may be set.
The manufacturer defined default value is 30.
This parameter has the configuration ID config_50_2 and is of type INTEGER.
Reading of this parameter returns the value of voltage RMS Reading of this parameter returns the value of voltage RMS at the time of the reading expressed in tenths of Volts. Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_51_2 and is of type INTEGER.
This is a read only parameter.
Returns the value of current RMS expressed in hundredths of Amperes.
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_52_2 and is of type INTEGER.
This is a read only parameter.
Returns the value of power factor as a percentage
Values in the range 0 to 255 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_53_1 and is of type INTEGER.
This is a read only parameter.
Returns the value of total energy consumed expressed in Wh (thousandths of KWh).
Values in the range 0 to 4294967295 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_54_4 and is of type INTEGER.
This is a read only parameter.
Returns the value of total energy consumed expressed in Wh (thousandths of KWh).
Values in the range 0 to 4294967295 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_55_4 and is of type INTEGER.
This is a read only parameter.
Defines the status of the device following a restart.
The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | ON: Device on |
| 2 | OFF: Device off |
| 3 | PREVIOUS STATUS: Status prior to restart |
The manufacturer defined default value is 3 (PREVIOUS STATUS: Status prior to restart).
This parameter has the configuration ID config_60_1 and is of type INTEGER.
Defines which parameters should be reset to default values.
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | FACTORY RESET |
| 1 | ASSOCIATIONS RESET |
| 2 | CONFIGURATIONS RESET |
| 4 | IGNORE: No action is performed. |
The manufacturer defined default value is 4 (IGNORE: No action is performed.).
This parameter has the configuration ID config_61_1 and is of type INTEGER.
Defines the type of external switch connected to the device.
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | IGNORE |
| 1 | BUTTON |
| 2 | SWITCH |
| 4 | AUTOMATIC RECOGNITION |
The manufacturer defined default value is 4 (AUTOMATIC RECOGNITION).
This parameter has the configuration ID config_62_1 and is of type INTEGER.
Defines the load control mode
The following option values may be configured -:
| Value | Description |
|---|---|
| 1 | DIRECT CONTROL |
| 2 | CONTROL_BY_NORMALLY_OPEN_CONTACTOR |
| 3 | CONTROL_BY_NORMALLY_CLOSED_CONTACTOR |
| 4 | AS_AN_EXTERNAL_INDICATOR: |
The manufacturer defined default value is 1 (DIRECT CONTROL).
This parameter has the configuration ID config_63_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 WPS104 supports 3 association groups.
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. Devices who will receive notification on: status changes; energy level and power; local reset of the device
Received commands: Basic Report, Device Reset Locally Notification, Meter Report, Multilevel Sensor: Power Report
Association group 1 supports 8 nodes.
Devices controlled from Up Power Event
Association group 2 supports 8 nodes.
Devices controlled from Down Power Event
Association group 3 supports 8 nodes.
| 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_SENSOR_MULTILEVEL_V3 | |
| 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.