homeassistant.components.mqtt.switch Namespace Reference

Classes
class	MqttSwitch

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

Variables
string	CONF_STATE_OFF = "state_off"
string	CONF_STATE_ON = "state_on"
string	DEFAULT_NAME = "MQTT Switch"
string	DEFAULT_PAYLOAD_OFF = "OFF"
string	DEFAULT_PAYLOAD_ON = "ON"
	DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Support for MQTT switches.

Function Documentation

async_setup_entry()

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

Set up MQTT switch through YAML and through MQTT discovery.

Definition at line 70 of file switch.py.

Variable Documentation

CONF_STATE_OFF

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

Definition at line 52 of file switch.py.

CONF_STATE_ON

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

Definition at line 51 of file switch.py.

DEFAULT_NAME

string homeassistant.components.mqtt.switch.DEFAULT_NAME = "MQTT Switch"

Definition at line 48 of file switch.py.

DEFAULT_PAYLOAD_OFF

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

Definition at line 50 of file switch.py.

DEFAULT_PAYLOAD_ON

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

Definition at line 49 of file switch.py.

DISCOVERY_SCHEMA

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

Definition at line 67 of file switch.py.

PARALLEL_UPDATES

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

Definition at line 46 of file switch.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.switch.PLATFORM_SCHEMA_MODERN

Initial value:

=  MQTT_RW_SCHEMA.extend(
    {
        vol.Optional(CONF_COMMAND_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_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_DEVICE_CLASS): vol.Any(DEVICE_CLASSES_SCHEMA, None),
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 54 of file switch.py.