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.

WPS104 Energy Driven Switch

This describes the Z-Wave device WPS104, manufactured by wiDom with the thing type UID of widom_wps104_00_000.

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

Overview

No device information is provided in the database. Consider updating the database to improve the documentation.

Channels

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

Channel Channel Id Category Item Type
Switch switch_binary Switch Switch
Sensor (power) sensor_power Energy Number
Electric meter (volts) meter_voltage Energy Number
Electric meter (power factor) meter_powerfactor Energy Number
Electric meter (amps) meter_current Energy Number
Electric meter (watts) meter_watts Energy Number
Electric meter (kWh) meter_kwh Energy Number

Switch

Switch the power on and off.

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

Sensor (power)

Indicates the energy consumption (kWh).

The sensor_power 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 (power factor)

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.

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.

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 (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.

Device Configuration

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   Controlling the relay by means of a single click on the external switch or on the integrated button. TOGGLE: If initial status is ON, then final status is OFF. If initial status is OFF, then final status is ON. ON: If the initial status
20 Device Status The final status achieved by the device when it receives a Basic Set command through the Z-Wave network. Available Parameters are; AS RECIEVED: If received command is ON, then final status is ON. If received command is OFF, then final status
30 Overcurrent Level Sets the current level above which the time spent above that level is measured. Defined value is divided by 100.
31 Overcurrent Time Sets the time beyond which, in the case of overcurrent at a level higher than that established in parameter 30, an OverCurrent event occurs.
32 Next State Defines the next state of the device if an overcurrent event has occurred. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains its statu
33 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.
34 Energy flow Determines whether energy events are related to energy consumed or energy produced. Available Parameters are: CONSUMED - Events will be active for Consumed energy flows to which the positive sign will be attributed. PRODUCED - Events will be
35 UP Power Level Sets the level of instantaneous power in Watts beyond which time of permanence above this level is calculated. 0 W - 11250 W Define level of instantaneous power.
36 UP Power Time Sets the time in seconds beyond which, if instantaneous power remains at levels exceeding threshold defined by parameter 35, a UP Power event occurs. 0 sec - 10800 sec Define time parameter.
37 UP Power State Defines the next status of the device in the case of a UP Power event occurring. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains its
38 UP Power Associated Sets the level of instantaneous power beyond which the time of permanence below this level is calculated. 0 - Associated devices are switched OFF. -1 - Associated devices are switched ON. 1 - 99 Set parameter for dimming purposes.
39 DOWN Power Level Sets the level of instantaneous power beyond which the time of permanence below this level is calculated. 0 W - 11250 W Define level of instantaneous power.
40 DOWN Power Time SSets the time beyond which, if instantaneous power remains at levels below threshold defined by parameter 39, a DOWN Power event occurs. 0 sec - 10800 sec. Define time parameter.
41 DOWN Power State Defines the next state of the device in the case of a DOWN Power event occurring. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains it
42 DOWN Power Associated Defines the status of associated devices in the presence of a DOWN Power event. 0 - Associated devices are switched OFF. -1 - Associated devices are switched ON. 1 - 99 Set parameter for dimming purposes.
43 DOWN Power Associated Sets the energy level that once exceeded an Energy Limit event occurs. Available Range: 0 KWh - 2000000 KWh
44 Energy Limit State Defines the next state of the device in the case of an Energy Limit event occurring. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains
45 Variation Instantaneous Power Defines the percentage variation of instantaneous power determining the sending of the report. Available Range: 1 % - 100 %
46 Report Time Frequency Defines the percentage variation of instantaneous power determining the sending of the report. Available Range: 1 min - 100 mins
47 Variation Total Energy 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.
48 Nominal Voltage 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. Available Range: 1100 v - 2500 v
49 Fall In Maximum Voltage Defines, as a percentage, the nominal value for permitted fall in maximum voltage. Available Range: 1 - 100%
50 Electric parameters subjected to automatic 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: Power=0, Energy=2,
51 Voltage RMS value Reading of this parameter returns the value of voltage RMS at the time of the reading expressed in tenths of Volts.
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. Available Parameters are: 1 - DIRECT CONTROL The external load is controlled directly by the relay. Reference diagram local load control. 2 - The external load is controlled by a contactor that in a resting sta
  Switch All Mode Set the mode for the switch when receiving SWITCH ALL commands

Parameter 1:

Controlling the relay by means of a single click on the external switch or on the integrated button. TOGGLE: If initial status is ON, then final status is OFF. If initial status is OFF, then final status is ON. ON: If the initial status

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.

Parameter 20: Device Status

The final status achieved by the device when it receives a Basic Set command through the Z-Wave network. Available Parameters are; AS RECIEVED: If received command is ON, then final status is ON. If received command is OFF, then final status

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.

Parameter 30: Overcurrent Level

Sets the current level above which the time spent above that level is measured. Defined value is divided by 100.

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.

Parameter 31: Overcurrent Time

Sets the time beyond which, in the case of overcurrent at a level higher than that established in parameter 30, an OverCurrent event occurs.

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.

Parameter 32: Next State

Defines the next state of the device if an overcurrent event has occurred. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains its statu

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.

Parameter 33: 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 Meter parameters, including total operating time, will be reset.
1 Greater than 0 – IGNORE (The meter will not be reset.)

The manufacturer defined default value is 0 (Meter parameters, including total operating time, will be reset.).

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

Parameter 34: Energy flow

Determines whether energy events are related to energy consumed or energy produced. Available Parameters are: CONSUMED - Events will be active for Consumed energy flows to which the positive sign will be attributed. PRODUCED - Events will be

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.

Parameter 35: UP Power Level

Sets the level of instantaneous power in Watts beyond which time of permanence above this level is calculated. 0 W - 11250 W Define level of instantaneous power.

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.

Parameter 36: UP Power Time

Sets the time in seconds beyond which, if instantaneous power remains at levels exceeding threshold defined by parameter 35, a UP Power event occurs. 0 sec - 10800 sec Define time parameter.

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.

Parameter 37: UP Power State

Defines the next status of the device in the case of a UP Power event occurring. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains its

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.

Parameter 38: UP Power Associated

Sets the level of instantaneous power beyond which the time of permanence below this level is calculated. 0 - Associated devices are switched OFF. -1 - Associated devices are switched ON. 1 - 99 Set parameter for dimming purposes.

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.

Parameter 39: DOWN Power Level

Sets the level of instantaneous power beyond which the time of permanence below this level is calculated. 0 W - 11250 W Define level of instantaneous power.

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.

Parameter 40: DOWN Power Time

SSets the time beyond which, if instantaneous power remains at levels below threshold defined by parameter 39, a DOWN Power event occurs. 0 sec - 10800 sec. Define time parameter.

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.

Parameter 41: DOWN Power State

Defines the next state of the device in the case of a DOWN Power event occurring. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains it

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.

Parameter 42: DOWN Power Associated

Defines the status of associated devices in the presence of a DOWN Power event. 0 - Associated devices are switched OFF. -1 - Associated devices are switched ON. 1 - 99 Set parameter for dimming purposes.

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.

Parameter 43: DOWN Power Associated

Sets the energy level that once exceeded an Energy Limit event occurs. Available Range: 0 KWh - 2000000 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.

Parameter 44: Energy Limit State

Defines the next state of the device in the case of an Energy Limit event occurring. Available Parameters: IGNORE - The device maintains the initial status. ON - If the initial status is OFF the system switches to ON; conversely, it maintains

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.

Parameter 45: Variation Instantaneous Power

Defines the percentage variation of instantaneous power determining the sending of the report. Available Range: 1 % - 100 %

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.

Parameter 46: Report Time Frequency

Defines the percentage variation of instantaneous power determining the sending of the report. Available Range: 1 min - 100 mins

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.

Parameter 47: Variation Total Energy

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.

Parameter 48: Nominal Voltage

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. Available Range: 1100 v - 2500 v

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.

Parameter 49: Fall In Maximum Voltage

Defines, as a percentage, the nominal value for permitted fall in maximum voltage. Available Range: 1 - 100%

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.

Parameter 50: Electric parameters subjected to automatic 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: Power=0, Energy=2,

Values in the range 0 to 62 may be set.

The manufacturer defined default value is 0.

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

Parameter 51: Voltage RMS value

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.

Parameter 52: Current RMS value

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.

Parameter 53: Power Factor

Returns the value of power factor as a percentage

Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 54: Total energy consumed

Returns the value of total energy consumed expressed in Wh (thousandths of KWh).

Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 55: Total energy produced

Returns the value of total energy consumed expressed in Wh (thousandths of KWh).

Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 60: Start-up status

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.

Parameter 61: Configuration reset

Defines which parameters should be reset to default values.

The following option values may be configured -:

Value Description
0 FACTORY RESET: The device is reset to the original factory settings.
1 ASSOCIATIONS RESET: All associations and only the associations are res
2 CONFIGURATIONS RESET: The associations are maintained while all other
3 IGNORE: No action is performed.

The manufacturer defined default value is 3 (IGNORE: No action is performed.).

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

Parameter 62: Type of external switch

Defines the type of external switch connected to the device.

The following option values may be configured -:

Value Description
0 IGNORE: The external switch is not connected or not present.
1 BUTTON: The external switch is a normally open button.
2 SWITCH: The external switch is a traditional switch.
3 AUTOMATIC RECOGNITION:

The manufacturer defined default value is 3 (AUTOMATIC RECOGNITION:).

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

Parameter 63: Load Control

Defines the load control mode. Available Parameters are: 1 - DIRECT CONTROL The external load is controlled directly by the relay. Reference diagram local load control. 2 - The external load is controlled by a contactor that in a resting sta

The following option values may be configured -:

Value Description
1 DIRECT CONTROL
2 CONTROL BY MEANS OF A CONTACTOR WITH NORMALLY OPEN COMMAND:
3 CONTROL BY MEANS OF A CONTACTOR WITH NORMALLY CLOSED COMMAND:
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.

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 WPS104 supports 3 association groups.

Group 1: Lifeline Group

This group supports 8 nodes.

Group 2: Up Power Level Group

This group supports 8 nodes.

Group 3: Down Power Level Group

This group supports 8 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1  
COMMAND_CLASS_BASIC_V0  
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.