Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.device_tracker Namespace Reference

Classes

class  MqttDeviceTracker
 

Functions

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

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_PAYLOAD_HOME = "payload_home"
 
string CONF_PAYLOAD_NOT_HOME = "payload_not_home"
 
string CONF_SOURCE_TYPE = "source_type"
 
string DEFAULT_PAYLOAD_RESET = "None"
 
 DEFAULT_SOURCE_TYPE = SourceType.GPS
 
 DISCOVERY_SCHEMA
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA_MODERN = vol.All(PLATFORM_SCHEMA_MODERN_BASE, valid_config)
 
 PLATFORM_SCHEMA_MODERN_BASE
 

Detailed Description

Support for tracking MQTT enabled devices identified.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.mqtt.device_tracker.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up MQTT event through YAML and through MQTT discovery.

Definition at line 79 of file device_tracker.py.

◆ valid_config()

ConfigType homeassistant.components.mqtt.device_tracker.valid_config ( ConfigType  config)
Check if there is a state topic or json_attributes_topic.

Definition at line 49 of file device_tracker.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.mqtt.device_tracker._LOGGER = logging.getLogger(__name__)
private

Definition at line 37 of file device_tracker.py.

◆ CONF_PAYLOAD_HOME

string homeassistant.components.mqtt.device_tracker.CONF_PAYLOAD_HOME = "payload_home"

Definition at line 41 of file device_tracker.py.

◆ CONF_PAYLOAD_NOT_HOME

string homeassistant.components.mqtt.device_tracker.CONF_PAYLOAD_NOT_HOME = "payload_not_home"

Definition at line 42 of file device_tracker.py.

◆ CONF_SOURCE_TYPE

string homeassistant.components.mqtt.device_tracker.CONF_SOURCE_TYPE = "source_type"

Definition at line 43 of file device_tracker.py.

◆ DEFAULT_PAYLOAD_RESET

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

Definition at line 45 of file device_tracker.py.

◆ DEFAULT_SOURCE_TYPE

homeassistant.components.mqtt.device_tracker.DEFAULT_SOURCE_TYPE = SourceType.GPS

Definition at line 46 of file device_tracker.py.

◆ DISCOVERY_SCHEMA

homeassistant.components.mqtt.device_tracker.DISCOVERY_SCHEMA
Initial value:
1 = vol.All(
2  PLATFORM_SCHEMA_MODERN_BASE.extend({}, extra=vol.REMOVE_EXTRA), valid_config
3 )

Definition at line 74 of file device_tracker.py.

◆ PARALLEL_UPDATES

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

Definition at line 39 of file device_tracker.py.

◆ PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.device_tracker.PLATFORM_SCHEMA_MODERN = vol.All(PLATFORM_SCHEMA_MODERN_BASE, valid_config)

Definition at line 71 of file device_tracker.py.

◆ PLATFORM_SCHEMA_MODERN_BASE

homeassistant.components.mqtt.device_tracker.PLATFORM_SCHEMA_MODERN_BASE
Initial value:
1 = MQTT_BASE_SCHEMA.extend(
2  {
3  vol.Optional(CONF_STATE_TOPIC): valid_subscribe_topic,
4  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
5  vol.Optional(CONF_NAME): vol.Any(cv.string, None),
6  vol.Optional(CONF_PAYLOAD_HOME, default=STATE_HOME): cv.string,
7  vol.Optional(CONF_PAYLOAD_NOT_HOME, default=STATE_NOT_HOME): cv.string,
8  vol.Optional(CONF_PAYLOAD_RESET, default=DEFAULT_PAYLOAD_RESET): cv.string,
9  vol.Optional(CONF_SOURCE_TYPE, default=DEFAULT_SOURCE_TYPE): vol.Coerce(
10  SourceType
11  ),
12  },
13 ).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 58 of file device_tracker.py.