home-assistant/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-12-10 14:46:47 -06:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/siren.markdown
c0ffeeca7 89b5af33bd
States: add unavailable and unknown (#34809) 
* States: add unavailable and unknown

* rephrase intro

* Make states lowercase

* Update source/_integrations/humidifier.markdown

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>

* Revert "Make states lowercase"

This reverts commit daf7f06630c4a2cc1f7e7fe5d043d9754a79cd1d.

* Apply bold to the UI string of state names

* Climate: fix grammar

---------

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
2024-09-18 15:36:17 +02:00

2.3 KiB
Raw Blame History

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.
Siren
2021.8 siren internal
@home-assistant/core
@raman325
entity

The Siren {% term integration %} is built for the controlling and monitoring of siren/chime devices.

{% include integrations/building_block_integration.md %}

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 {% term 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.