Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.notify Namespace Reference

Classes

class  MqttNotify
 

Functions

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

Variables

string DEFAULT_NAME = "MQTT notify"
 
 DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA_MODERN
 

Detailed Description

Support for MQTT notify.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.mqtt.notify.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up MQTT notify through YAML and through MQTT discovery.

Definition at line 39 of file notify.py.

Variable Documentation

◆ DEFAULT_NAME

string homeassistant.components.mqtt.notify.DEFAULT_NAME = "MQTT notify"

Definition at line 25 of file notify.py.

◆ DISCOVERY_SCHEMA

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

Definition at line 36 of file notify.py.

◆ PARALLEL_UPDATES

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

Definition at line 23 of file notify.py.

◆ PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.notify.PLATFORM_SCHEMA_MODERN
Initial value:
1 = MQTT_BASE_SCHEMA.extend(
2  {
3  vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
4  vol.Required(CONF_COMMAND_TOPIC): valid_publish_topic,
5  vol.Optional(CONF_NAME): vol.Any(cv.string, None),
6  vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
7  }
8 ).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 27 of file notify.py.