Mapping Zigbee2MQTT → Gladys for the Heiman HS2WD-E siren

Hello,

Following the discussion on Zigbee2MQTT → Gladys mapping for alarms, I am creating a specific topic for the Heiman HS2WD-E indoor siren.

I am using this siren with Zigbee2MQTT. It is well recognized and reported in Gladys, but some features exposed by Zigbee2MQTT do not seem to be currently mapped to Gladys features.

The goal would be to be able to directly use the different functions of the siren in Gladys, especially from scenes, without having to manually send MQTT commands.

Equipment:

  • Brand: Heiman
  • Model: HS2WD-E
  • Type: indoor siren
  • Integration: Zigbee2MQTT

Zigbee2MQTT Documentation:

Original topic:

doc zigbee:

Model HS2WD-E
Vendor Heiman
Description Smart siren
Exposes battery, max_duration, warning
Picture Heiman HS2WD-E

Triggering the alarm

The alarm can be triggered by publishing to zigbee2mqtt/FRIENDLY_NAME/set message

{"warning": {"duration": 10, "mode": "emergency", "strobe": false}}.

Where:

  • duration: the number of seconds the alarm will be on (max is 1800 seconds)
  • mode: stop or emergency
  • strobe: true or false will let the strobe flash once during the alarm

Exposes

Battery (numeric)

Remaining battery in %, can take up to 24 hours before reported.

Value can be found in the published state on the battery property.

It’s not possible to read (/get) or write (/set) this value.

The minimal value is 0 and the maximum value is 100.

The unit of this value is %.

Max duration (numeric)

Max duration of Siren.

Value can be found in the published state on the max_duration property.

To read (/get) the value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/get with payload {"max_duration": ""}.

To write (/set) a value publish a message to topic zigbee2mqtt/FRIENDLY_NAME/set with payload {"max_duration": NEW_VALUE}.

The minimal value is 0 and the maximum value is 600.

The unit of this value is s.

Warning (composite)

Can be set by publishing to zigbee2mqtt/FRIENDLY_NAME/set with payload {"warning": {"strobe": VALUE, "strobe_duty_cycle": VALUE, "duration": VALUE, "mode": VALUE}}

  • strobe (binary): Turn on/off the strobe (light) during warning allowed values: true or false
  • strobe_duty_cycle (numeric): Length of the flash cycle max value is 10
  • duration (numeric): Duration in seconds of the alarm unit is s
  • mode (enum): Mode of the warning (sound effect) allowed values: stop, emergency

Thanks :slightly_smiling_face: