homeassistant.components.mqtt.debug_info Namespace Reference

Classes
class	TimestampedPublishMessage

Functions
dict[str, Any]	_info_for_entity (HomeAssistant hass, str entity_id)
dict[str, Any]	_info_for_trigger (HomeAssistant hass, tuple[str, str] trigger_key)
None	add_entity_discovery_data (HomeAssistant hass, DiscoveryInfoType discovery_data, str entity_id)
None	add_subscription (HomeAssistant hass, str subscription, str|None entity_id)
None	add_trigger_discovery_data (HomeAssistant hass, tuple[str, str] discovery_hash, DiscoveryInfoType discovery_data, str device_id)
dict[str, list[Any]]	info_for_config_entry (HomeAssistant hass)
dict[str, list[Any]]	info_for_device (HomeAssistant hass, str device_id)
None	log_message (HomeAssistant hass, str entity_id, str topic, PublishPayloadType payload, int qos, bool retain)
None	remove_entity_data (HomeAssistant hass, str entity_id)
None	remove_subscription (HomeAssistant hass, str subscription, str|None entity_id)
None	remove_trigger_discovery_data (HomeAssistant hass, tuple[str, str] discovery_hash)
None	update_entity_discovery_data (HomeAssistant hass, DiscoveryInfoType discovery_payload, str entity_id)
None	update_trigger_discovery_data (HomeAssistant hass, tuple[str, str] discovery_hash, DiscoveryInfoType discovery_payload)

Variables
int	STORED_MESSAGES = 10

Detailed Description

Helper to handle a set of topics to subscribe to.

Function Documentation

_info_for_entity()

dict[str, Any] homeassistant.components.mqtt.debug_info._info_for_entity ( HomeAssistant  hass, str  entity_id  )

private

Definition at line 144 of file debug_info.py.

_info_for_trigger()

dict[str, Any] homeassistant.components.mqtt.debug_info._info_for_trigger ( HomeAssistant  hass, tuple[str, str]   trigger_key  )

private

Definition at line 198 of file debug_info.py.

add_entity_discovery_data()

None homeassistant.components.mqtt.debug_info.add_entity_discovery_data	(	HomeAssistant	hass,
		DiscoveryInfoType	discovery_data,
		str	entity_id
	)

Add discovery data.

Definition at line 85 of file debug_info.py.

add_subscription()

None homeassistant.components.mqtt.debug_info.add_subscription	(	HomeAssistant	hass,
		str	subscription,
		str | None	entity_id
	)

Prepare debug data for subscription.

Definition at line 55 of file debug_info.py.

add_trigger_discovery_data()

None homeassistant.components.mqtt.debug_info.add_trigger_discovery_data	(	HomeAssistant	hass,
		tuple[str, str]	discovery_hash,
		DiscoveryInfoType	discovery_data,
		str	device_id
	)

Add discovery data.

Definition at line 113 of file debug_info.py.

info_for_config_entry()

dict[str, list[Any]] homeassistant.components.mqtt.debug_info.info_for_config_entry

(

HomeAssistant

hass

)

Get debug info for all entities and triggers.

Definition at line 211 of file debug_info.py.

info_for_device()

dict[str, list[Any]] homeassistant.components.mqtt.debug_info.info_for_device	(	HomeAssistant	hass,
		str	device_id
	)

Get debug info for a device.

Definition at line 229 of file debug_info.py.

log_message()

None homeassistant.components.mqtt.debug_info.log_message	(	HomeAssistant	hass,
		str	entity_id,
		str	topic,
		PublishPayloadType	payload,
		int	qos,
		bool	retain
	)

Log an outgoing MQTT message.

Definition at line 33 of file debug_info.py.

remove_entity_data()

None homeassistant.components.mqtt.debug_info.remove_entity_data	(	HomeAssistant	hass,
		str	entity_id
	)

Remove discovery data.

Definition at line 107 of file debug_info.py.

remove_subscription()

None homeassistant.components.mqtt.debug_info.remove_subscription	(	HomeAssistant	hass,
		str	subscription,
		str | None	entity_id
	)

Remove debug data for subscription if it exists.

Definition at line 72 of file debug_info.py.

remove_trigger_discovery_data()

None homeassistant.components.mqtt.debug_info.remove_trigger_discovery_data	(	HomeAssistant	hass,
		tuple[str, str]	discovery_hash
	)

Remove discovery data.

Definition at line 137 of file debug_info.py.

update_entity_discovery_data()

None homeassistant.components.mqtt.debug_info.update_entity_discovery_data	(	HomeAssistant	hass,
		DiscoveryInfoType	discovery_payload,
		str	entity_id
	)

Update discovery data.

Definition at line 95 of file debug_info.py.

update_trigger_discovery_data()

None homeassistant.components.mqtt.debug_info.update_trigger_discovery_data	(	HomeAssistant	hass,
		tuple[str, str]	discovery_hash,
		DiscoveryInfoType	discovery_payload
	)

Update discovery data.

Definition at line 126 of file debug_info.py.

Variable Documentation

STORED_MESSAGES

int homeassistant.components.mqtt.debug_info.STORED_MESSAGES = 10

Definition at line 19 of file debug_info.py.