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.

MSP-3-1-X1 Z-Wave Plus Micro Smart Plug ON/OFF

This describes the Z-Wave device MSP-3-1-X1, manufactured by ID-RF with the thing type UID of nodon_msp31x1_00_000.

The MSP-3-1-X1 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 MSP-3-1-X1 -:

Channel Channel Id Category Item Type
Switch switch_binary Switch Switch
Electric meter (watts) meter_watts Energy Number
Electric meter (kWh) meter_kwh Energy Number
Reset Meter meter_reset Energy Switch
Alarm (power) alarm_power Door Switch
Alarm (system) alarm_system   Switch

Switch

Switch the power on and off.

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

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.

Reset Meter

Reset the meter.

The meter_reset channel supports the Switch item and is in the Energy category.

Alarm (power)

Indicates if a power alarm is triggered.

The alarm_power 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

Alarm (system)

Indicates if a system alarm is triggered.

The alarm_system 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

Device Configuration

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

Param Name Description
1 Default State Status after a power outage or after being plugged
3 Follow State Allows to enable or disable Group 2 & Group 3
4 Always On Forces the Micro Smart Plug status to be ON
21 Power Auto-Sending Report Power report for changes of x % W
22 Overload Report Switch off Micro Smart Plug in case the power is above x W
23 Energy Auto-Sending Report Auto energy report if value changes of x Wh
24 Metering Heartbeat Reporting intervall for power and energy to lifeline.
25 Power High Threshold Defines the High Threshold value in W.
26 Power Low Threshold Defines the Low Threshold value in W.
27 Power Threshold Action Defines actions if the power Low/High Threshold are reached.
  Switch All Mode Set the mode for the switch when receiving SWITCH ALL commands

Parameter 1: Default State

Status after a power outage or after being plugged This parameter defines the status of the Micro Smart Plug after a power outage or after being plugged The following option values may be configured -:

Value Description
0 OFF
1 ON
2 Status before power outage

The manufacturer defined default value is 2 (Status before power outage).

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

Parameter 3: Follow State

Allows to enable or disable Group 2 & Group 3 This parameter allows to enable or disable Group 2 & Group 3

The value may be the sum of available values. For example, if you want to enable Group 2 & 3, the parameter value is 1+2=3 The following option values may be configured -:

Value Description
0 Group 2 & Group 3 disable
1 Group 2 enable
2 Group 3 enable
3 Group 2 & Group 3 enable

The manufacturer defined default value is 3 (Group 2 & Group 3 enable).

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

Parameter 4: Always On

Forces the Micro Smart Plug status to be ON This parameter forces the Micro Smart Plug status to be ON. While enable it is not possible to switch OFF the plug (local or wireless). The following option values may be configured -:

Value Description
0 Always ON disable
1 Always ON enable

The manufacturer defined default value is 0 (Always ON disable).

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

Parameter 21: Power Auto-Sending Report

Power report for changes of x % W This parameter will send a power report automatically if the power value changes of x % W (Watt) compared to the last report. The following option values may be configured, in addition to values in the range 0 to 100 -:

Value Description
0 Power Auto-Polling Report Disable
10 Power Auto-Polling Report Enable if 10%
20 Power Auto-Polling Report Enable if 20 %
30 Power Auto-Polling Report Enable if 30 %
40 Power Auto-Polling Report Enable if 40 %
50 Power Auto-Polling Report Enable if 50 %
60 Power Auto-Polling Report Enable if 60 %
70 Power Auto-Polling Report Enable if 70 %
80 Power Auto-Polling Report Enable if 80 %
90 Power Auto-Polling Report Enable if 90 %
100 Power Auto-Polling Report Enable if 100%

The manufacturer defined default value is 10 (Power Auto-Polling Report Enable if 10%).

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

Parameter 22: Overload Report

Switch off Micro Smart Plug in case the power is above x W This parameter will switch off the Micro Smart Plug in case the power is above x W (Watt) and send an alarm to the primary controller. This parameter has the highest execution priority between all the metering configurations for security reason. The following option values may be configured, in addition to values in the range 0 to 2000 -:

Value Description
0 Overload Report Disable (Not Recommended)
50 Overload Report enable with a upper limit of 50 W
100 Overload Report enable with a upper limit of 100 W
150 Overload Report enable with a upper limit of 150 W
200 Overload Report enable with a upper limit of 200 W
250 Overload Report enable with a upper limit of 250 W
500 Overload Report enable with a upper limit of 500 W
1000 Overload Report enable with a upper limit of 1000 W
1500 Overload Report enable with a upper limit of 1500 W
2000 Overload Report enable with a upper limit of 2000 W

The manufacturer defined default value is 2000 (Overload Report enable with a upper limit of 2000 W).

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

Parameter 23: Energy Auto-Sending Report

Auto energy report if value changes of x Wh This parameter will send a new energy report automatically if the energy value changes of x Wh (Watt-hour) compared to the last report. The following option values may be configured, in addition to values in the range 0 to 65535 -:

Value Description
0 Energy Auto-Polling Report Disable
1000 Energy Auto-Polling Report enable if 1000 Wh variation
2000 Energy Auto-Polling Report enable if 2000 Wh variation
3000 Energy Auto-Polling Report enable if 3000 Wh variation
4000 Energy Auto-Polling Report enable if 4000 Wh variation
5000 Energy Auto-Polling Report enable if 5000 Wh variation
10000 Energy Auto-Polling Report enable if 10.000 Wh variation
20000 Energy Auto-Polling Report enable if 20.000 Wh variation
30000 Energy Auto-Polling Report enable if 30.000 Wh variation
40000 Energy Auto-Polling Report enable if 40.000 Wh variation
50000 Energy Auto-Polling Report enable if 50.000 Wh variation
60000 Energy Auto-Polling Report enable if 60.000 Wh variation
65535 Energy Auto-Polling Report enable if 65.535 Wh variation

The manufacturer defined default value is 1000 (Energy Auto-Polling Report enable if 1000 Wh variation).

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

Parameter 24: Metering Heartbeat

Reporting intervall for power and energy to lifeline. Whatever other metering reports, this parameter will send one power and one energy report to the lifeline every x s (Seconds). The following option values may be configured, in addition to values in the range 0 to 65535 -:

Value Description
0 Metering Pulse disable
3600 Metering Pulse enable and send report every hour
21600 Metering Pulse enable and send report every 6 hours
43200 Metering Pulse enable and send report every 12 hours

The manufacturer defined default value is 3600 (Metering Pulse enable and send report every hour).

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

Parameter 25: Power High Threshold

Defines the High Threshold value in W. This parameter defines the High Threshold power value. The following option values may be configured, in addition to values in the range 0 to 65535 -:

Value Description
0 Power High Threshold disable
10 Power High Threshold enable with the value from 10 W
20 Power High Threshold enable with the value from 20 W
30 Power High Threshold enable with the value from 30 W
40 Power High Threshold enable with the value from 40 W
50 Power High Threshold enable with the value from 50 W
100 Power High Threshold enable with the value from 100 W
200 Power High Threshold enable with the value from 200 W
300 Power High Threshold enable with the value from 300 W
400 Power High Threshold enable with the value from 400 W
500 Power High Threshold enable with the value from 500 W
1000 Power High Threshold enable with the value from 1000 W
1500 Power High Threshold enable with the value from 1500 W
2000 Power High Threshold enable with the value from 2000 W

The manufacturer defined default value is 20 (Power High Threshold enable with the value from 20 W).

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

Parameter 26: Power Low Threshold

Defines the Low Threshold value in W. This parameter defines the Low Threshold power value. The following option values may be configured, in addition to values in the range 0 to 65535 -:

Value Description
0 Power Low Threshold disable
5 Power Low Threshold enable with the value from 5 W
10 Power Low Threshold enable with the value from 10 W
20 Power Low Threshold enable with the value from 20 W
30 Power Low Threshold enable with the value from 30 W
40 Power Low Threshold enable with the value from 40 W
50 Power Low Threshold enable with the value from 50 W
100 Power Low Threshold enable with the value from 100 W
200 Power Low Threshold enable with the value from 200 W
300 Power Low Threshold enable with the value from 300 W
400 Power Low Threshold enable with the value from 400 W
500 Power Low Threshold enable with the value from 500 W
1000 Power Low Threshold enable with the value from 1000 W
1500 Power Low Threshold enable with the value from 1500 W
2000 Power Low Threshold enable with the value from 2000 W

The manufacturer defined default value is 5 (Power Low Threshold enable with the value from 5 W).

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

Parameter 27: Power Threshold Action

Defines actions if the power Low/High Threshold are reached. This parameter will define the Micro Smart Plug actions if the power Low and High Threshold are reached.

The value may be the sum of available values. For example, if you want:

  • Power High Threshold Action is enable and sent ON to Group 4 (3)
  • Power Low Threshold Action is enable and sent OFF to Group 5 (4)

the parameter value must be 3+4=7. The following option values may be configured -:

Value Description
0 Power Threshold Action is disable.
1 Power High Group 4 OFF
3 Power High Group 4 ON
4 Power Low Group 5 OFF
5 Power High Group 4 OFF & Power Low Group 5 OFF
7 Power High Group 4 ON & Power Low Group 5 OFF
12 Power High Group 5 ON
13 Power High Group 4 OFF & Power Low Gourp 5 ON
15 Power High Group 4 ON & Power Low Group 5 ON

The manufacturer defined default value is 7 (Power High Group 4 ON & Power Low Group 5 OFF).

This parameter has the configuration ID config_27_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 MSP-3-1-X1 supports 6 association groups.

Group 1: Lifetime

Report Information to Main Controller. This group supports 5 nodes.

Group 2: Follow State

Send status if local button is used to associated devices. This group supports 5 nodes.

Group 3: Follow Comp State

Send status if local button is used to associated devices. This group supports 5 nodes.

Group 4: Metering High Threshold

Send ON/OFF command to associated devices if threshold reached This group supports 5 nodes.

Group 5: Metering Low Threshold

Send ON/OFF command to associated devices if threshold reached This group supports 5 nodes.

Group 6: Metering - Report

Report metering to devices in this group. 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_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_ALARM_V4  
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1  
COMMAND_CLASS_POWERLEVEL_V1  
COMMAND_CLASS_PROTECTION_V2  
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1  
COMMAND_CLASS_ASSOCIATION_V2  
COMMAND_CLASS_VERSION_V2  
COMMAND_CLASS_INDICATOR_V1  

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