homeassistant.components.mqtt.number Namespace Reference

Classes
class	MqttNumber

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

Variables
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
string	CONF_MAX = "max"
string	CONF_MIN = "min"
string	CONF_STEP = "step"
string	DEFAULT_NAME = "MQTT Number"
string	DEFAULT_PAYLOAD_RESET = "None"
	DISCOVERY_SCHEMA
	MQTT_NUMBER_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Configure number in a device through MQTT topic.

Function Documentation

async_setup_entry()

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

Set up MQTT number through YAML and through MQTT discovery.

Definition at line 109 of file number.py.

validate_config()

ConfigType homeassistant.components.mqtt.number.validate_config

(

ConfigType

config

)

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

Definition at line 71 of file number.py.

Variable Documentation

_LOGGER

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

private

Definition at line 51 of file number.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.number._PLATFORM_SCHEMA_BASE

private

Initial value:

=  MQTT_RW_SCHEMA.extend(
    {
        vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
        vol.Optional(CONF_DEVICE_CLASS): vol.Any(
            vol.All(vol.Lower, vol.Coerce(NumberDeviceClass)), None
        ),
        vol.Optional(CONF_MAX, default=DEFAULT_MAX_VALUE): vol.Coerce(float),
        vol.Optional(CONF_MIN, default=DEFAULT_MIN_VALUE): vol.Coerce(float),
        vol.Optional(CONF_MODE, default=NumberMode.AUTO): vol.Coerce(NumberMode),
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_PAYLOAD_RESET, default=DEFAULT_PAYLOAD_RESET): cv.string,
        vol.Optional(CONF_STEP, default=DEFAULT_STEP): vol.All(
            vol.Coerce(float), vol.Range(min=1e-3)
        ),
        vol.Optional(CONF_UNIT_OF_MEASUREMENT): vol.Any(cv.string, None),
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
    },
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 79 of file number.py.

CONF_MAX

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

Definition at line 56 of file number.py.

CONF_MIN

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

Definition at line 55 of file number.py.

CONF_STEP

string homeassistant.components.mqtt.number.CONF_STEP = "step"

Definition at line 57 of file number.py.

DEFAULT_NAME

string homeassistant.components.mqtt.number.DEFAULT_NAME = "MQTT Number"

Definition at line 59 of file number.py.

DEFAULT_PAYLOAD_RESET

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

Definition at line 60 of file number.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.number.DISCOVERY_SCHEMA

Initial value:

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

Definition at line 103 of file number.py.

MQTT_NUMBER_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.number.MQTT_NUMBER_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        number.ATTR_MAX,
        number.ATTR_MIN,
        number.ATTR_STEP,
    }
)

Definition at line 62 of file number.py.

PARALLEL_UPDATES

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

Definition at line 53 of file number.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.number.PLATFORM_SCHEMA_MODERN

Initial value:

=  vol.All(
    _PLATFORM_SCHEMA_BASE,
    validate_config,
)

Definition at line 98 of file number.py.