mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-28 13:57:04 +00:00
2602651bdc
* Rename Services to Actions in integrations: S * Update source/_integrations/scene.markdown * Update source/_integrations/scene.markdown * tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
2.1 KiB
2.1 KiB
title, description, ha_category, ha_release, ha_domain, ha_quality_scale, ha_codeowners, ha_integration_type
| title | description | ha_category | ha_release | ha_domain | ha_quality_scale | ha_codeowners | ha_integration_type | |||
|---|---|---|---|---|---|---|---|---|---|---|
| Siren | Instructions on how to set up siren devices within Home Assistant. |
|
2021.8 | siren | internal |
|
entity |
The Siren integration is built for the controlling and monitoring of siren/chime devices.
{% include integrations/building_block_integration.md %}
Actions
Siren actions
Available actions: 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. |