homeassistant.components.mqtt.text Namespace Reference

Classes
class	MqttTextEntity

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

Variables
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
string	CONF_MAX = "max"
string	CONF_MIN = "min"
string	CONF_PATTERN = "pattern"
string	DEFAULT_NAME = "MQTT Text"
string	DEFAULT_PAYLOAD_RESET = "None"
	DISCOVERY_SCHEMA
	MQTT_TEXT_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN = vol.All(_PLATFORM_SCHEMA_BASE, valid_text_size_configuration)

Detailed Description

Support for MQTT text platform.

Function Documentation

async_setup_entry()

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

Set up MQTT text through YAML and through MQTT discovery.

Definition at line 95 of file text.py.

valid_text_size_configuration()

ConfigType homeassistant.components.mqtt.text.valid_text_size_configuration

(

ConfigType

config

)

Validate that the text length configuration is valid, throws if it isn't.

Definition at line 62 of file text.py.

Variable Documentation

_LOGGER

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

private

Definition at line 41 of file text.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.text._PLATFORM_SCHEMA_BASE

private

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_MAX, default=MAX_LENGTH_STATE_STATE): cv.positive_int,
        vol.Optional(CONF_MIN, default=0): cv.positive_int,
        vol.Optional(CONF_MODE, default=text.TextMode.TEXT): vol.In(
            [text.TextMode.TEXT, text.TextMode.PASSWORD]
        ),
        vol.Optional(CONF_PATTERN): cv.is_regex,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
    },
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 72 of file text.py.

CONF_MAX

string homeassistant.components.mqtt.text.CONF_MAX = "max"

Definition at line 45 of file text.py.

CONF_MIN

string homeassistant.components.mqtt.text.CONF_MIN = "min"

Definition at line 46 of file text.py.

CONF_PATTERN

string homeassistant.components.mqtt.text.CONF_PATTERN = "pattern"

Definition at line 47 of file text.py.

DEFAULT_NAME

string homeassistant.components.mqtt.text.DEFAULT_NAME = "MQTT Text"

Definition at line 49 of file text.py.

DEFAULT_PAYLOAD_RESET

string homeassistant.components.mqtt.text.DEFAULT_PAYLOAD_RESET = "None"

Definition at line 50 of file text.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.text.DISCOVERY_SCHEMA

Initial value:

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

Definition at line 87 of file text.py.

MQTT_TEXT_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.text.MQTT_TEXT_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        text.ATTR_MAX,
        text.ATTR_MIN,
        text.ATTR_MODE,
        text.ATTR_PATTERN,
    }
)

Definition at line 52 of file text.py.

PARALLEL_UPDATES

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

Definition at line 43 of file text.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.text.PLATFORM_SCHEMA_MODERN = vol.All(_PLATFORM_SCHEMA_BASE, valid_text_size_configuration)

Definition at line 92 of file text.py.