Siren
The Siren integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] is built for the controlling and monitoring of siren/chime devices.
Building block integration
This siren is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.
A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this siren building block to provide entities, services, and other functionality that you can use in your automations or dashboards.
If one of your integrations features this building block, this page documents the functionality the siren building block offers.
The state of a siren entity
The state of a siren entity can be either On or Off.
In addition, the entity can have the following states:
- Unavailable: The entity is currently unavailable.
- Unknown: The state is not yet known.
Actions
Siren actions
Available actionsActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called sequence. [Learn more]: siren.turn_on, siren.turn_off, siren.toggle
Action siren.turn_on
Turn the siren on.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | String or list of strings that point at entity_id’s of sirens to control. |
There are three optional input parameters that can be passed into the action depending on whether or not your device supports them. Check the device’s integration documentation for more details.
| Parameter Name | Input Type | Notes |
|---|---|---|
tone |
string or integer
|
When the available_tones property is a map, either the key or value can be used. |
duration |
integer |
|
volume_level |
float between 0 and 1 |
Action siren.turn_off
Turn the siren off.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | String or list of strings that point at entity_id’s of sirens to control. |
Action siren.toggle
Toggle the siren on/off.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | String or list of strings that point at entity_id’s of sirens to control. |