homeassistant.components.mqtt_room.sensor Namespace Reference

Classes
class	MQTTRoomSensor

Functions
dict[str, Any]	_parse_update_data (str topic, dict[str, Any] data)
str	_slugify_upper (str string)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_DISTANCE = "distance"
string	ATTR_ROOM = "room"
string	CONF_AWAY_TIMEOUT = "away_timeout"
int	DEFAULT_AWAY_TIMEOUT = 0
string	DEFAULT_NAME = "Room Sensor"
int	DEFAULT_TIMEOUT = 5
string	DEFAULT_TOPIC = "room_presence"
	MQTT_PAYLOAD
	PLATFORM_SCHEMA

Detailed Description

Support for MQTT room presence detection.

Function Documentation

_parse_update_data()

dict[str, Any] homeassistant.components.mqtt_room.sensor._parse_update_data ( str  topic, dict[str, Any]  data  )

private

Parse the room presence update.

Definition at line 195 of file sensor.py.

_slugify_upper()

str homeassistant.components.mqtt_room.sensor._slugify_upper ( str  string )

private

Return a slugified version of string, uppercased.

Definition at line 58 of file sensor.py.

async_setup_platform()

None homeassistant.components.mqtt_room.sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up MQTT room Sensor.

Definition at line 77 of file sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 34 of file sensor.py.

ATTR_DISTANCE

string homeassistant.components.mqtt_room.sensor.ATTR_DISTANCE = "distance"

Definition at line 36 of file sensor.py.

ATTR_ROOM

string homeassistant.components.mqtt_room.sensor.ATTR_ROOM = "room"

Definition at line 37 of file sensor.py.

CONF_AWAY_TIMEOUT

string homeassistant.components.mqtt_room.sensor.CONF_AWAY_TIMEOUT = "away_timeout"

Definition at line 39 of file sensor.py.

DEFAULT_AWAY_TIMEOUT

int homeassistant.components.mqtt_room.sensor.DEFAULT_AWAY_TIMEOUT = 0

Definition at line 41 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.mqtt_room.sensor.DEFAULT_NAME = "Room Sensor"

Definition at line 42 of file sensor.py.

DEFAULT_TIMEOUT

int homeassistant.components.mqtt_room.sensor.DEFAULT_TIMEOUT = 5

Definition at line 43 of file sensor.py.

DEFAULT_TOPIC

string homeassistant.components.mqtt_room.sensor.DEFAULT_TOPIC = "room_presence"

Definition at line 44 of file sensor.py.

MQTT_PAYLOAD

homeassistant.components.mqtt_room.sensor.MQTT_PAYLOAD

Initial value:

=  vol.Schema(
    vol.All(
        json_loads,
        vol.Schema(
            {
                vol.Required(ATTR_ID): cv.string,
                vol.Required(ATTR_DISTANCE): vol.Coerce(float),
            },
            extra=vol.ALLOW_EXTRA,
        ),
    )
)

Definition at line 63 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.mqtt_room.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_DEVICE_ID): cv.string,
        vol.Required(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
        vol.Optional(CONF_AWAY_TIMEOUT, default=DEFAULT_AWAY_TIMEOUT): cv.positive_int,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
).extend(mqtt.MQTT_RO_SCHEMA.schema)

Definition at line 46 of file sensor.py.