Zigbee2MQTT

Ubisys S2

ModelS2
VendorUbisys
DescriptionPower switch S2
Exposesswitch (state), action, power_on_behavior, power, energy, linkquality
PictureUbisys S2

Notes

Configuring Inputs

In case the input(s) need to be reconfigured (e.g. to use stationary switches instead of momentary ones or vice versa) this can be done in the same way as it is being done for the ubisys C4.

(Re-)Binding and/or Decoupling

Also see the ubisys C4 documentation, example use cases:

  • Use the second input to control a different Zigbee device (S1-R only, S1 only has one input)
  • Completely decouple the input(s) from the local load

When decoupled, 'action' will be published when pressing the attached switch button.

OTA updates

This device supports OTA updates, for more information see OTA updates.

Options

How to use device type specific configuration

  • state_action: State actions will also be published as 'action' when true (default false). The value must be true or false

  • power_precision: Number of digits after decimal point for power, takes into effect on next report of device. The value must be a number with a minimum value of 0 and with a with a maximum value of 3

  • power_calibration: Calibrates the power value (percentual offset), takes into effect on next report of device. The value must be a number.

  • energy_precision: Number of digits after decimal point for energy, takes into effect on next report of device. The value must be a number with a minimum value of 0 and with a with a maximum value of 3

  • energy_calibration: Calibrates the energy value (percentual offset), takes into effect on next report of device. The value must be a number.

  • simulated_brightness: Simulate a brightness value. If this device provides a brightness_move_up or brightness_move_down action it is possible to specify the update interval and delta. The action_brightness_delta indicates the delta for each interval. Example:

simulated_brightness:
  delta: 20 # delta per interval, default = 20
  interval: 200 # interval in milliseconds, default = 200

Exposes

Switch (l1 endpoint)

The current state of this switch is in the published state under the state_l1 property (value is ON or OFF). To control this switch publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"state_l1": "ON"}, {"state_l1": "OFF"} or {"state_l1": "TOGGLE"}. To read the current state of this switch publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"state_l1": ""}.

Switch (l2 endpoint)

The current state of this switch is in the published state under the state_l2 property (value is ON or OFF). To control this switch publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"state_l2": "ON"}, {"state_l2": "OFF"} or {"state_l2": "TOGGLE"}. To read the current state of this switch publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"state_l2": ""}.

Action (enum)

Triggered action (e.g. a button click). Value can be found in the published state on the action property. It's not possible to read (/get) or write (/set) this value. The possible values are: toggle_s1, toggle_s2, on_s1, on_s2, off_s1, off_s2, recall_*_s1, recal_*_s2, brightness_move_up_s1, brightness_move_up_s2, brightness_move_down_s1, brightness_move_down_s2, brightness_stop_s1, brightness_stop_s2.

Power-on behavior (enum, l1 endpoint)

Controls the behavior when the device is powered on after power loss. Value can be found in the published state on the power_on_behavior_l1 property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"power_on_behavior_l1": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"power_on_behavior_l1": NEW_VALUE}. The possible values are: off, previous, on.

Power-on behavior (enum, l2 endpoint)

Controls the behavior when the device is powered on after power loss. Value can be found in the published state on the power_on_behavior_l2 property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"power_on_behavior_l2": ""}. To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"power_on_behavior_l2": NEW_VALUE}. The possible values are: off, previous, on.

Power (numeric)

Instantaneous measured power. Value can be found in the published state on the power property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"power": ""}. It's not possible to write (/set) this value. The unit of this value is W.

Energy (numeric)

Sum of consumed energy. Value can be found in the published state on the energy property. To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"energy": ""}. It's not possible to write (/set) this value. The unit of this value is kWh.

Linkquality (numeric)

Link quality (signal strength). Value can be found in the published state on the linkquality property. It's not possible to read (/get) or write (/set) this value. The minimal value is 0 and the maximum value is 255. The unit of this value is lqi.