homeassistant.components.mqtt.lawn_mower Namespace Reference

Classes
class	MqttLawnMower

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

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_ACTIVITY_STATE_TOPIC = "activity_state_topic"
string	CONF_ACTIVITY_VALUE_TEMPLATE = "activity_value_template"
string	CONF_DOCK_COMMAND_TEMPLATE = "dock_command_template"
string	CONF_DOCK_COMMAND_TOPIC = "dock_command_topic"
string	CONF_PAUSE_COMMAND_TEMPLATE = "pause_command_template"
string	CONF_PAUSE_COMMAND_TOPIC = "pause_command_topic"
string	CONF_START_MOWING_COMMAND_TEMPLATE = "start_mowing_command_template"
string	CONF_START_MOWING_COMMAND_TOPIC = "start_mowing_command_topic"
string	DEFAULT_NAME = "MQTT Lawn Mower"
	DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))
string	ENTITY_ID_FORMAT = lawn_mower.DOMAIN + ".{}"
string	FEATURE_DOCK = "dock"
string	FEATURE_PAUSE = "pause"
string	FEATURE_START_MOWING = "start_mowing"
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Support for MQTT lawn mowers.

Function Documentation

async_setup_entry()

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

Set up MQTT lawn mower through YAML and through MQTT discovery.

Definition at line 80 of file lawn_mower.py.

Variable Documentation

_LOGGER

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

private

Definition at line 39 of file lawn_mower.py.

CONF_ACTIVITY_STATE_TOPIC

string homeassistant.components.mqtt.lawn_mower.CONF_ACTIVITY_STATE_TOPIC = "activity_state_topic"

Definition at line 43 of file lawn_mower.py.

CONF_ACTIVITY_VALUE_TEMPLATE

string homeassistant.components.mqtt.lawn_mower.CONF_ACTIVITY_VALUE_TEMPLATE = "activity_value_template"

Definition at line 44 of file lawn_mower.py.

CONF_DOCK_COMMAND_TEMPLATE

string homeassistant.components.mqtt.lawn_mower.CONF_DOCK_COMMAND_TEMPLATE = "dock_command_template"

Definition at line 46 of file lawn_mower.py.

CONF_DOCK_COMMAND_TOPIC

string homeassistant.components.mqtt.lawn_mower.CONF_DOCK_COMMAND_TOPIC = "dock_command_topic"

Definition at line 45 of file lawn_mower.py.

CONF_PAUSE_COMMAND_TEMPLATE

string homeassistant.components.mqtt.lawn_mower.CONF_PAUSE_COMMAND_TEMPLATE = "pause_command_template"

Definition at line 48 of file lawn_mower.py.

CONF_PAUSE_COMMAND_TOPIC

string homeassistant.components.mqtt.lawn_mower.CONF_PAUSE_COMMAND_TOPIC = "pause_command_topic"

Definition at line 47 of file lawn_mower.py.

CONF_START_MOWING_COMMAND_TEMPLATE

string homeassistant.components.mqtt.lawn_mower.CONF_START_MOWING_COMMAND_TEMPLATE = "start_mowing_command_template"

Definition at line 50 of file lawn_mower.py.

CONF_START_MOWING_COMMAND_TOPIC

string homeassistant.components.mqtt.lawn_mower.CONF_START_MOWING_COMMAND_TOPIC = "start_mowing_command_topic"

Definition at line 49 of file lawn_mower.py.

DEFAULT_NAME

string homeassistant.components.mqtt.lawn_mower.DEFAULT_NAME = "MQTT Lawn Mower"

Definition at line 52 of file lawn_mower.py.

DISCOVERY_SCHEMA

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

Definition at line 77 of file lawn_mower.py.

ENTITY_ID_FORMAT

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

Definition at line 53 of file lawn_mower.py.

FEATURE_DOCK

string homeassistant.components.mqtt.lawn_mower.FEATURE_DOCK = "dock"

Definition at line 57 of file lawn_mower.py.

FEATURE_PAUSE

string homeassistant.components.mqtt.lawn_mower.FEATURE_PAUSE = "pause"

Definition at line 58 of file lawn_mower.py.

FEATURE_START_MOWING

string homeassistant.components.mqtt.lawn_mower.FEATURE_START_MOWING = "start_mowing"

Definition at line 59 of file lawn_mower.py.

PARALLEL_UPDATES

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

Definition at line 41 of file lawn_mower.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.lawn_mower.PLATFORM_SCHEMA_MODERN

Initial value:

=  MQTT_BASE_SCHEMA.extend(
    {
        vol.Optional(CONF_ACTIVITY_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_ACTIVITY_STATE_TOPIC): valid_subscribe_topic,
        vol.Optional(CONF_DOCK_COMMAND_TEMPLATE): cv.template,
        vol.Optional(CONF_DOCK_COMMAND_TOPIC): valid_publish_topic,
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
        vol.Optional(CONF_PAUSE_COMMAND_TEMPLATE): cv.template,
        vol.Optional(CONF_PAUSE_COMMAND_TOPIC): valid_publish_topic,
        vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
        vol.Optional(CONF_START_MOWING_COMMAND_TEMPLATE): cv.template,
        vol.Optional(CONF_START_MOWING_COMMAND_TOPIC): valid_publish_topic,
    },
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 61 of file lawn_mower.py.