homeassistant.components.mqtt.siren Namespace Reference

Classes
class	MqttSiren

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_AVAILABLE_TONES = "available_tones"
string	CONF_COMMAND_OFF_TEMPLATE = "command_off_template"
string	CONF_STATE_OFF = "state_off"
string	CONF_STATE_ON = "state_on"
string	CONF_SUPPORT_DURATION = "support_duration"
string	CONF_SUPPORT_VOLUME_SET = "support_volume_set"
string	DEFAULT_NAME = "MQTT Siren"
string	DEFAULT_PAYLOAD_OFF = "OFF"
string	DEFAULT_PAYLOAD_ON = "ON"
	DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))
string	ENTITY_ID_FORMAT = siren.DOMAIN + ".{}"
	MQTT_SIREN_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN
string	STATE = "state"
dictionary	SUPPORTED_ATTRIBUTES
	SUPPORTED_BASE = SirenEntityFeature.TURN_OFF | SirenEntityFeature.TURN_ON

Detailed Description

Support for MQTT sirens.

Function Documentation

async_setup_entry()

None homeassistant.components.mqtt.siren.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Set up MQTT siren through YAML and through MQTT discovery.

Definition at line 113 of file siren.py.

Variable Documentation

_LOGGER

homeassistant.components.mqtt.siren._LOGGER = logging.getLogger(__name__)

private

Definition at line 110 of file siren.py.

CONF_AVAILABLE_TONES

string homeassistant.components.mqtt.siren.CONF_AVAILABLE_TONES = "available_tones"

Definition at line 66 of file siren.py.

CONF_COMMAND_OFF_TEMPLATE

string homeassistant.components.mqtt.siren.CONF_COMMAND_OFF_TEMPLATE = "command_off_template"

Definition at line 67 of file siren.py.

CONF_STATE_OFF

string homeassistant.components.mqtt.siren.CONF_STATE_OFF = "state_off"

Definition at line 69 of file siren.py.

CONF_STATE_ON

string homeassistant.components.mqtt.siren.CONF_STATE_ON = "state_on"

Definition at line 68 of file siren.py.

CONF_SUPPORT_DURATION

string homeassistant.components.mqtt.siren.CONF_SUPPORT_DURATION = "support_duration"

Definition at line 70 of file siren.py.

CONF_SUPPORT_VOLUME_SET

string homeassistant.components.mqtt.siren.CONF_SUPPORT_VOLUME_SET = "support_volume_set"

Definition at line 71 of file siren.py.

DEFAULT_NAME

string homeassistant.components.mqtt.siren.DEFAULT_NAME = "MQTT Siren"

Definition at line 60 of file siren.py.

DEFAULT_PAYLOAD_OFF

string homeassistant.components.mqtt.siren.DEFAULT_PAYLOAD_OFF = "OFF"

Definition at line 62 of file siren.py.

DEFAULT_PAYLOAD_ON

string homeassistant.components.mqtt.siren.DEFAULT_PAYLOAD_ON = "ON"

Definition at line 61 of file siren.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.siren.DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))

Definition at line 91 of file siren.py.

ENTITY_ID_FORMAT

string homeassistant.components.mqtt.siren.ENTITY_ID_FORMAT = siren.DOMAIN + ".{}"

Definition at line 64 of file siren.py.

MQTT_SIREN_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.siren.MQTT_SIREN_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        ATTR_AVAILABLE_TONES,
        ATTR_DURATION,
        ATTR_TONE,
        ATTR_VOLUME_LEVEL,
    }
)

Definition at line 93 of file siren.py.

PARALLEL_UPDATES

int homeassistant.components.mqtt.siren.PARALLEL_UPDATES = 0

Definition at line 58 of file siren.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.siren.PLATFORM_SCHEMA_MODERN

Initial value:

=  MQTT_RW_SCHEMA.extend(
    {
        vol.Optional(CONF_AVAILABLE_TONES): cv.ensure_list,
        vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
        vol.Optional(CONF_COMMAND_OFF_TEMPLATE): cv.template,
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
        vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
        vol.Optional(CONF_STATE_OFF): cv.string,
        vol.Optional(CONF_STATE_ON): cv.string,
        vol.Optional(CONF_STATE_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_SUPPORT_DURATION, default=True): cv.boolean,
        vol.Optional(CONF_SUPPORT_VOLUME_SET, default=True): cv.boolean,
    },
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 75 of file siren.py.

STATE

string homeassistant.components.mqtt.siren.STATE = "state"

Definition at line 73 of file siren.py.

SUPPORTED_ATTRIBUTES

dictionary homeassistant.components.mqtt.siren.SUPPORTED_ATTRIBUTES

Initial value:

=  {
    ATTR_DURATION: SirenEntityFeature.DURATION,
    ATTR_TONE: SirenEntityFeature.TONES,
    ATTR_VOLUME_LEVEL: SirenEntityFeature.VOLUME_SET,
}

Definition at line 104 of file siren.py.

SUPPORTED_BASE

homeassistant.components.mqtt.siren.SUPPORTED_BASE = SirenEntityFeature.TURN_OFF | SirenEntityFeature.TURN_ON

Definition at line 102 of file siren.py.