alarm_mute

Last updated on June 17, 2024

Data type: BOOL.

Usage method: stores the device state without changing it.

Purpose: controls the sound notification settings when the sensor is triggered:

• true — turn off sound notification.
• false — turn on sound notification.

Devices with this function

• sensor_gas — gas sensor.
• sensor_smoke — smoke sensor.

Examples of voice commands

No voice commands are available.

Function description for a device model

The function must be added to the model descriptions of all devices that support it.

"features": [
    "alarm_mute",
    // ...
 ]

Function state description example

In the example, the sensor will not sound an alarm when triggered.

{
    "states": [
        {
            "key": "alarm_mute",
            "value": {
                "type": "BOOL",
                "bool_value": true
            }
        }
    ]
}