homeassistant.components.mqtt.humidifier Namespace Reference

Classes
class	MqttHumidifier

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

Variables
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
string	CONF_AVAILABLE_MODES_LIST = "modes"
string	CONF_DEVICE_CLASS = "device_class"
string	CONF_MODE_COMMAND_TEMPLATE = "mode_command_template"
string	CONF_MODE_COMMAND_TOPIC = "mode_command_topic"
string	CONF_MODE_STATE_TEMPLATE = "mode_state_template"
string	CONF_MODE_STATE_TOPIC = "mode_state_topic"
string	CONF_PAYLOAD_RESET_HUMIDITY = "payload_reset_humidity"
string	CONF_PAYLOAD_RESET_MODE = "payload_reset_mode"
string	CONF_TARGET_HUMIDITY_COMMAND_TEMPLATE = "target_humidity_command_template"
string	CONF_TARGET_HUMIDITY_COMMAND_TOPIC = "target_humidity_command_topic"
string	CONF_TARGET_HUMIDITY_MAX = "max_humidity"
string	CONF_TARGET_HUMIDITY_MIN = "min_humidity"
string	CONF_TARGET_HUMIDITY_STATE_TEMPLATE = "target_humidity_state_template"
string	CONF_TARGET_HUMIDITY_STATE_TOPIC = "target_humidity_state_topic"
string	DEFAULT_NAME = "MQTT Humidifier"
string	DEFAULT_PAYLOAD_OFF = "OFF"
string	DEFAULT_PAYLOAD_ON = "ON"
string	DEFAULT_PAYLOAD_RESET = "None"
	DISCOVERY_SCHEMA
	MQTT_HUMIDIFIER_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN
tuple	TOPICS

Detailed Description

Support for MQTT humidifiers.

Function Documentation

async_setup_entry()

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

Set up MQTT humidifier through YAML and through MQTT discovery.

Definition at line 183 of file humidifier.py.

valid_humidity_range_configuration()

ConfigType homeassistant.components.mqtt.humidifier.valid_humidity_range_configuration

(

ConfigType

config

)

Validate humidity range.

Ensures that the target_humidity range configuration is valid,
throws if it isn't.

Definition at line 104 of file humidifier.py.

valid_mode_configuration()

ConfigType homeassistant.components.mqtt.humidifier.valid_mode_configuration

(

ConfigType

config

)

Validate that the mode reset payload is not one of the available modes.

Definition at line 97 of file humidifier.py.

Variable Documentation

_LOGGER

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

private

Definition at line 94 of file humidifier.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.humidifier._PLATFORM_SCHEMA_BASE

private

Definition at line 118 of file humidifier.py.

CONF_AVAILABLE_MODES_LIST

string homeassistant.components.mqtt.humidifier.CONF_AVAILABLE_MODES_LIST = "modes"

Definition at line 64 of file humidifier.py.

CONF_DEVICE_CLASS

string homeassistant.components.mqtt.humidifier.CONF_DEVICE_CLASS = "device_class"

Definition at line 65 of file humidifier.py.

CONF_MODE_COMMAND_TEMPLATE

string homeassistant.components.mqtt.humidifier.CONF_MODE_COMMAND_TEMPLATE = "mode_command_template"

Definition at line 66 of file humidifier.py.

CONF_MODE_COMMAND_TOPIC

string homeassistant.components.mqtt.humidifier.CONF_MODE_COMMAND_TOPIC = "mode_command_topic"

Definition at line 67 of file humidifier.py.

CONF_MODE_STATE_TEMPLATE

string homeassistant.components.mqtt.humidifier.CONF_MODE_STATE_TEMPLATE = "mode_state_template"

Definition at line 69 of file humidifier.py.

CONF_MODE_STATE_TOPIC

string homeassistant.components.mqtt.humidifier.CONF_MODE_STATE_TOPIC = "mode_state_topic"

Definition at line 68 of file humidifier.py.

CONF_PAYLOAD_RESET_HUMIDITY

string homeassistant.components.mqtt.humidifier.CONF_PAYLOAD_RESET_HUMIDITY = "payload_reset_humidity"

Definition at line 71 of file humidifier.py.

CONF_PAYLOAD_RESET_MODE

string homeassistant.components.mqtt.humidifier.CONF_PAYLOAD_RESET_MODE = "payload_reset_mode"

Definition at line 70 of file humidifier.py.

CONF_TARGET_HUMIDITY_COMMAND_TEMPLATE

string homeassistant.components.mqtt.humidifier.CONF_TARGET_HUMIDITY_COMMAND_TEMPLATE = "target_humidity_command_template"

Definition at line 72 of file humidifier.py.

CONF_TARGET_HUMIDITY_COMMAND_TOPIC

string homeassistant.components.mqtt.humidifier.CONF_TARGET_HUMIDITY_COMMAND_TOPIC = "target_humidity_command_topic"

Definition at line 73 of file humidifier.py.

CONF_TARGET_HUMIDITY_MAX

string homeassistant.components.mqtt.humidifier.CONF_TARGET_HUMIDITY_MAX = "max_humidity"

Definition at line 75 of file humidifier.py.

CONF_TARGET_HUMIDITY_MIN

string homeassistant.components.mqtt.humidifier.CONF_TARGET_HUMIDITY_MIN = "min_humidity"

Definition at line 74 of file humidifier.py.

CONF_TARGET_HUMIDITY_STATE_TEMPLATE

string homeassistant.components.mqtt.humidifier.CONF_TARGET_HUMIDITY_STATE_TEMPLATE = "target_humidity_state_template"

Definition at line 76 of file humidifier.py.

CONF_TARGET_HUMIDITY_STATE_TOPIC

string homeassistant.components.mqtt.humidifier.CONF_TARGET_HUMIDITY_STATE_TOPIC = "target_humidity_state_topic"

Definition at line 77 of file humidifier.py.

DEFAULT_NAME

string homeassistant.components.mqtt.humidifier.DEFAULT_NAME = "MQTT Humidifier"

Definition at line 79 of file humidifier.py.

DEFAULT_PAYLOAD_OFF

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

Definition at line 81 of file humidifier.py.

DEFAULT_PAYLOAD_ON

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

Definition at line 80 of file humidifier.py.

DEFAULT_PAYLOAD_RESET

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

Definition at line 82 of file humidifier.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.humidifier.DISCOVERY_SCHEMA

Initial value:

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

Definition at line 165 of file humidifier.py.

MQTT_HUMIDIFIER_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.humidifier.MQTT_HUMIDIFIER_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        humidifier.ATTR_HUMIDITY,
        humidifier.ATTR_MAX_HUMIDITY,
        humidifier.ATTR_MIN_HUMIDITY,
        humidifier.ATTR_MODE,
        humidifier.ATTR_AVAILABLE_MODES,
    }
)

Definition at line 84 of file humidifier.py.

PARALLEL_UPDATES

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

Definition at line 62 of file humidifier.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.humidifier.PLATFORM_SCHEMA_MODERN

Initial value:

=  vol.All(
    _PLATFORM_SCHEMA_BASE,
    valid_humidity_range_configuration,
    valid_mode_configuration,
)

Definition at line 159 of file humidifier.py.

TOPICS

tuple homeassistant.components.mqtt.humidifier.TOPICS

Initial value:

=  (
    CONF_ACTION_TOPIC,
    CONF_STATE_TOPIC,
    CONF_COMMAND_TOPIC,
    CONF_CURRENT_HUMIDITY_TOPIC,
    CONF_TARGET_HUMIDITY_STATE_TOPIC,
    CONF_TARGET_HUMIDITY_COMMAND_TOPIC,
    CONF_MODE_STATE_TOPIC,
    CONF_MODE_COMMAND_TOPIC,
)

Definition at line 171 of file humidifier.py.