homeassistant.components.mqtt.event Namespace Reference

Classes
class	MqttEvent

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

Variables
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
string	CONF_EVENT_TYPES = "event_types"
bool	DEFAULT_FORCE_UPDATE = False
string	DEFAULT_NAME = "MQTT Event"
	DEVICE_CLASS_SCHEMA = vol.All(vol.Lower, vol.Coerce(EventDeviceClass))
	DISCOVERY_SCHEMA
	MQTT_EVENT_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Support for MQTT events.

Function Documentation

async_setup_entry()

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

Set up MQTT event through YAML and through MQTT discovery.

Definition at line 73 of file event.py.

Variable Documentation

_LOGGER

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

private

Definition at line 39 of file event.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.event._PLATFORM_SCHEMA_BASE

private

Initial value:

=  MQTT_RO_SCHEMA.extend(
    {
        vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASS_SCHEMA,
        vol.Optional(CONF_NAME): vol.Any(None, cv.string),
        vol.Required(CONF_EVENT_TYPES): vol.All(cv.ensure_list, [cv.string]),
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 56 of file event.py.

CONF_EVENT_TYPES

string homeassistant.components.mqtt.event.CONF_EVENT_TYPES = "event_types"

Definition at line 43 of file event.py.

DEFAULT_FORCE_UPDATE

bool homeassistant.components.mqtt.event.DEFAULT_FORCE_UPDATE = False

Definition at line 53 of file event.py.

DEFAULT_NAME

string homeassistant.components.mqtt.event.DEFAULT_NAME = "MQTT Event"

Definition at line 52 of file event.py.

DEVICE_CLASS_SCHEMA

homeassistant.components.mqtt.event.DEVICE_CLASS_SCHEMA = vol.All(vol.Lower, vol.Coerce(EventDeviceClass))

Definition at line 54 of file event.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.event.DISCOVERY_SCHEMA

Initial value:

=  vol.All(
    _PLATFORM_SCHEMA_BASE.extend({}, extra=vol.REMOVE_EXTRA),
)

Definition at line 68 of file event.py.

MQTT_EVENT_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.event.MQTT_EVENT_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        event.ATTR_EVENT_TYPE,
        event.ATTR_EVENT_TYPES,
    }
)

Definition at line 45 of file event.py.

PARALLEL_UPDATES

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

Definition at line 41 of file event.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.event.PLATFORM_SCHEMA_MODERN

Initial value:

=  vol.All(
    _PLATFORM_SCHEMA_BASE,
)

Definition at line 64 of file event.py.