Capability Actions Alarm Warning Device

This capability represents a sounder, or strobe designed to alert a human to an emergency situation.

Alarm

Requests the device begin to alarm and inform a human about an emergency situation.

Options / Body

{
    "AlarmType": <type of alarm>,
    "Volume": <a floating point value between 0.0 and 1.0>,
    "Visual": <true/false>,
    "Duration": <duration of alarm in milliseconds>
}

The follow alarm types exist and may effect the alarm sound or behaviour.

• General
• Fire
• Security
• Environmental
• Panic
• Tamper
• DeviceFault
• HealthAlarm

Clear

Clear any existing alarm, silence and stop any visual indication.

No Options / Body

Alert

Requests the device perform a short alarm/alert to get the attention of a human.

Options / Body

{
    "AlarmType": <type of alarm>,
    "AlertType": <type of alert>,
    "Volume": <a floating point value between 0.0 and 1.0>,
    "Visual": <true/false>,
}

In addition to accepting an alarm type, an alert type must also be specified.

• General
• PreAlarm
• Arm
• Disarm
• Fault