homeassistant.components.mqtt.valve Namespace Reference

Classes
class	MqttValve

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

Variables
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
string	CONF_REPORTS_POSITION = "reports_position"
string	DEFAULT_NAME = "MQTT Valve"
dictionary	DEFAULTS
	DISCOVERY_SCHEMA
	MQTT_VALVE_ATTRIBUTES_BLOCKED
tuple	NO_POSITION_KEYS
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN = vol.All(_PLATFORM_SCHEMA_BASE, _validate_and_add_defaults)
string	RESET_CLOSING_OPENING = "reset_opening_closing"

Detailed Description

Support for MQTT valve devices.

Function Documentation

_validate_and_add_defaults()

ConfigType homeassistant.components.mqtt.valve._validate_and_add_defaults ( ConfigType  config )

private

Validate config options and set defaults.

Definition at line 95 of file valve.py.

async_setup_entry()

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

Set up MQTT valve through YAML and through MQTT discovery.

Definition at line 136 of file valve.py.

Variable Documentation

_LOGGER

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

private

Definition at line 64 of file valve.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.valve._PLATFORM_SCHEMA_BASE

private

Initial value:

=  MQTT_BASE_SCHEMA.extend(
    {
        vol.Optional(CONF_COMMAND_TOPIC): valid_publish_topic,
        vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
        vol.Optional(CONF_DEVICE_CLASS): vol.Any(DEVICE_CLASSES_SCHEMA, None),
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
        vol.Optional(CONF_PAYLOAD_CLOSE): vol.Any(cv.string, None),
        vol.Optional(CONF_PAYLOAD_OPEN): vol.Any(cv.string, None),
        vol.Optional(CONF_PAYLOAD_STOP): vol.Any(cv.string, None),
        vol.Optional(CONF_POSITION_CLOSED, default=DEFAULT_POSITION_CLOSED): int,
        vol.Optional(CONF_POSITION_OPEN, default=DEFAULT_POSITION_OPEN): int,
        vol.Optional(CONF_REPORTS_POSITION, default=False): cv.boolean,
        vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
        vol.Optional(CONF_STATE_CLOSED): cv.string,
        vol.Optional(CONF_STATE_CLOSING, default=ValveState.CLOSING): cv.string,
        vol.Optional(CONF_STATE_OPEN): cv.string,
        vol.Optional(CONF_STATE_OPENING, default=ValveState.OPENING): cv.string,
        vol.Optional(CONF_STATE_TOPIC): valid_subscribe_topic,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 105 of file valve.py.

CONF_REPORTS_POSITION

string homeassistant.components.mqtt.valve.CONF_REPORTS_POSITION = "reports_position"

Definition at line 68 of file valve.py.

DEFAULT_NAME

string homeassistant.components.mqtt.valve.DEFAULT_NAME = "MQTT Valve"

Definition at line 70 of file valve.py.

DEFAULTS

dictionary homeassistant.components.mqtt.valve.DEFAULTS

Initial value:

=  {
    CONF_PAYLOAD_CLOSE: DEFAULT_PAYLOAD_CLOSE,
    CONF_PAYLOAD_OPEN: DEFAULT_PAYLOAD_OPEN,
    CONF_STATE_OPEN: ValveState.OPEN,
    CONF_STATE_CLOSED: ValveState.CLOSED,
}

Definition at line 85 of file valve.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.valve.DISCOVERY_SCHEMA

Initial value:

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

Definition at line 130 of file valve.py.

MQTT_VALVE_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.valve.MQTT_VALVE_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        valve.ATTR_CURRENT_POSITION,
    }
)

Definition at line 72 of file valve.py.

NO_POSITION_KEYS

tuple homeassistant.components.mqtt.valve.NO_POSITION_KEYS

Initial value:

=  (
    CONF_PAYLOAD_CLOSE,
    CONF_PAYLOAD_OPEN,
    CONF_STATE_CLOSED,
    CONF_STATE_OPEN,
)

Definition at line 78 of file valve.py.

PARALLEL_UPDATES

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

Definition at line 66 of file valve.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.valve.PLATFORM_SCHEMA_MODERN = vol.All(_PLATFORM_SCHEMA_BASE, _validate_and_add_defaults)

Definition at line 128 of file valve.py.

RESET_CLOSING_OPENING

string homeassistant.components.mqtt.valve.RESET_CLOSING_OPENING = "reset_opening_closing"

Definition at line 92 of file valve.py.