homeassistant.components.mqtt.sensor Namespace Reference

Classes
class	MqttSensor

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

Variables
	_LOGGER = logging.getLogger(__name__)
	_PLATFORM_SCHEMA_BASE
string	CONF_EXPIRE_AFTER = "expire_after"
string	CONF_LAST_RESET_VALUE_TEMPLATE = "last_reset_value_template"
string	CONF_SUGGESTED_DISPLAY_PRECISION = "suggested_display_precision"
bool	DEFAULT_FORCE_UPDATE = False
string	DEFAULT_NAME = "MQTT Sensor"
	DISCOVERY_SCHEMA
	MQTT_SENSOR_ATTRIBUTES_BLOCKED
int	PARALLEL_UPDATES = 0
	PLATFORM_SCHEMA_MODERN

Detailed Description

Support for MQTT sensors.

Function Documentation

async_setup_entry()

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

Set up MQTT sensor through YAML and through MQTT discovery.

Definition at line 124 of file sensor.py.

validate_sensor_state_and_device_class_config()

ConfigType homeassistant.components.mqtt.sensor.validate_sensor_state_and_device_class_config

(

ConfigType

config

)

Validate the sensor options, state and device class config.

Definition at line 81 of file sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 48 of file sensor.py.

_PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.sensor._PLATFORM_SCHEMA_BASE

private

Initial value:

=  MQTT_RO_SCHEMA.extend(
    {
        vol.Optional(CONF_DEVICE_CLASS): vol.Any(DEVICE_CLASSES_SCHEMA, None),
        vol.Optional(CONF_EXPIRE_AFTER): cv.positive_int,
        vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
        vol.Optional(CONF_LAST_RESET_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_NAME): vol.Any(cv.string, None),
        vol.Optional(CONF_OPTIONS): cv.ensure_list,
        vol.Optional(CONF_SUGGESTED_DISPLAY_PRECISION): cv.positive_int,
        vol.Optional(CONF_STATE_CLASS): vol.Any(STATE_CLASSES_SCHEMA, None),
        vol.Optional(CONF_UNIT_OF_MEASUREMENT): vol.Any(cv.string, None),
    }
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 66 of file sensor.py.

CONF_EXPIRE_AFTER

string homeassistant.components.mqtt.sensor.CONF_EXPIRE_AFTER = "expire_after"

Definition at line 52 of file sensor.py.

CONF_LAST_RESET_VALUE_TEMPLATE

string homeassistant.components.mqtt.sensor.CONF_LAST_RESET_VALUE_TEMPLATE = "last_reset_value_template"

Definition at line 53 of file sensor.py.

CONF_SUGGESTED_DISPLAY_PRECISION

string homeassistant.components.mqtt.sensor.CONF_SUGGESTED_DISPLAY_PRECISION = "suggested_display_precision"

Definition at line 54 of file sensor.py.

DEFAULT_FORCE_UPDATE

bool homeassistant.components.mqtt.sensor.DEFAULT_FORCE_UPDATE = False

Definition at line 64 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.mqtt.sensor.DEFAULT_NAME = "MQTT Sensor"

Definition at line 63 of file sensor.py.

DISCOVERY_SCHEMA

homeassistant.components.mqtt.sensor.DISCOVERY_SCHEMA

Initial value:

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

Definition at line 118 of file sensor.py.

MQTT_SENSOR_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.sensor.MQTT_SENSOR_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        sensor.ATTR_LAST_RESET,
        sensor.ATTR_STATE_CLASS,
    }
)

Definition at line 56 of file sensor.py.

PARALLEL_UPDATES

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

Definition at line 50 of file sensor.py.

PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.sensor.PLATFORM_SCHEMA_MODERN

Initial value:

=  vol.All(
    _PLATFORM_SCHEMA_BASE,
    validate_sensor_state_and_device_class_config,
)

Definition at line 113 of file sensor.py.