homeassistant.components.mqtt.water_heater Namespace Reference

Classes
class	MqttWaterHeater

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

Variables
	_DISCOVERY_SCHEMA_BASE = _PLATFORM_SCHEMA_BASE.extend({}, extra=vol.REMOVE_EXTRA)
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
dictionary	COMMAND_TEMPLATE_KEYS
string	DEFAULT_NAME = "MQTT Water Heater"
	DISCOVERY_SCHEMA
	MQTT_WATER_HEATER_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN
tuple	TOPIC_KEYS
tuple	VALUE_TEMPLATE_KEYS

Detailed Description

Support for MQTT water heater devices.

Function Documentation

async_setup_entry()

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

Set up MQTT water heater device through YAML and through MQTT discovery.

Definition at line 166 of file water_heater.py.

Variable Documentation

_DISCOVERY_SCHEMA_BASE

homeassistant.components.mqtt.water_heater._DISCOVERY_SCHEMA_BASE = _PLATFORM_SCHEMA_BASE.extend({}, extra=vol.REMOVE_EXTRA)

private

Definition at line 159 of file water_heater.py.

_LOGGER

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

private

Definition at line 73 of file water_heater.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.water_heater._PLATFORM_SCHEMA_BASE

private

Definition at line 113 of file water_heater.py.

COMMAND_TEMPLATE_KEYS

dictionary homeassistant.components.mqtt.water_heater.COMMAND_TEMPLATE_KEYS

Initial value:

=  {
    CONF_MODE_COMMAND_TEMPLATE,
    CONF_TEMP_COMMAND_TEMPLATE,
    CONF_POWER_COMMAND_TEMPLATE,
}

Definition at line 96 of file water_heater.py.

DEFAULT_NAME

string homeassistant.components.mqtt.water_heater.DEFAULT_NAME = "MQTT Water Heater"

Definition at line 77 of file water_heater.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.water_heater.DISCOVERY_SCHEMA

Initial value:

=  vol.All(
    _DISCOVERY_SCHEMA_BASE,
)

Definition at line 161 of file water_heater.py.

MQTT_WATER_HEATER_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.water_heater.MQTT_WATER_HEATER_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        water_heater.ATTR_CURRENT_TEMPERATURE,
        water_heater.ATTR_MAX_TEMP,
        water_heater.ATTR_MIN_TEMP,
        water_heater.ATTR_TEMPERATURE,
        water_heater.ATTR_OPERATION_LIST,
        water_heater.ATTR_OPERATION_MODE,
    }
)

Definition at line 79 of file water_heater.py.

PARALLEL_UPDATES

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

Definition at line 75 of file water_heater.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.water_heater.PLATFORM_SCHEMA_MODERN

Initial value:

=  vol.All(
    _PLATFORM_SCHEMA_BASE,
)

Definition at line 155 of file water_heater.py.

TOPIC_KEYS

tuple homeassistant.components.mqtt.water_heater.TOPIC_KEYS

Initial value:

=  (
    CONF_CURRENT_TEMP_TOPIC,
    CONF_MODE_COMMAND_TOPIC,
    CONF_MODE_STATE_TOPIC,
    CONF_POWER_COMMAND_TOPIC,
    CONF_TEMP_COMMAND_TOPIC,
    CONF_TEMP_STATE_TOPIC,
)

Definition at line 103 of file water_heater.py.

VALUE_TEMPLATE_KEYS

tuple homeassistant.components.mqtt.water_heater.VALUE_TEMPLATE_KEYS

Initial value:

=  (
    CONF_CURRENT_TEMP_TEMPLATE,
    CONF_MODE_STATE_TEMPLATE,
    CONF_TEMP_STATE_TEMPLATE,
)

Definition at line 90 of file water_heater.py.