MQTT设备跟踪器


mqtt设备跟踪器平台允许您通过手动YAML配置configuration.yaml并通过发现模式使用MQTT发现协议。

YAML配置

要在安装中使用此设备跟踪器,请添加以下内容configuration.yaml文件:

#示例Configuration.yaml条目device_tracker-平台mqtt设备paulus_oneplus位置/保卢斯”annetherese_n4位置/安德内斯

配置变量

设备 列表 必需的

带有主题的设备列表。

QoS 整数 ((可选的

主题的QoS级别。

payload_home 细绳 ((可选的,默认:家

代表设备的“家庭”状态的有效载荷值。

payload_not_home 细绳 ((可选的,默认:not_home

代表设备的“ not_home”状态的有效负载值。

source_type 细绳 ((可选的

设备跟踪器的属性,该属性会在用于跟踪的情况下影响状态。有效的选项是全球定位系统,,,,路由器,,,,蓝牙, 或者Bluetooth_le

完成YAML示例配置

#完整配置.yaml条目device_tracker-平台mqtt设备paulus_oneplus位置/保卢斯”annetherese_n4位置/安德内斯QoS1payload_home当下”payload_not_home不是当下”source_type蓝牙

用法

要设置Device_Tracker的状态,然后您需要将JSON消息发布到主题(例如,通过MQTT.PUBLISH服务)。例如,以下JSON消息将设置paulus_oneplusdevice_tracker到

{“话题”“位置/保卢斯”,,,,“有效载荷”“当下”}

发现模式

MQTT Device_Tracker也得到了支持MQTT发现。这与上面的YAML配置不同。在这里,可以通过遵循以下主题名称约定的发现主题来创建Device_Tracker:/device_tracker/[/] /config以及以下定义的特定格式的JSON消息内容。

配置变量

可用性 列表 ((可选的

MQTT主题列表订阅以接收可用性(在线/离线)更新。不得一起使用availability_topic

payload_available 细绳 ((可选的,默认:在线

代表可用状态的有效载荷。

payload_not_available 细绳 ((可选的,默认:离线

代表不可用状态的有效载荷。

话题 细绳 必需的

MQTT主题订阅以接收可用性(在线/离线)更新。

value_template 模板 ((可选的

定义a模板从中提取设备的可用性话题。为了确定设备的可用性结果,将与payload_availablepayload_not_available

availability_mode 细绳 ((可选的,默认:最新

什么时候可用性已配置,这控制了将实体设置为可用的。有效的条目是全部,,,,任何, 和最新的。如果设置为全部,,,,payload_available在实体被标记为在线之前,必须在所有配置的可用性主题上收到。如果设置为任何,,,,payload_available在实体被标记为在线之前,必须在至少一个配置的可用性主题上收到。如果设置为最新的, 最后payload_available或者payload_not_available在任何配置的可用性主题上都收到了可用性。

availability_template 模板 ((可选的

定义a模板从中提取设备的可用性availability_topic。为了确定设备的可用性结果,将与payload_availablepayload_not_available

availability_topic 细绳 ((可选的

MQTT主题订阅以接收可用性(在线/离线)更新。不得一起使用可用性

设备 地图 ((可选的

有关设备的信息此设备跟踪器是将其联系在一起的一部分设备注册表。必须至少存在一个标识符或连接以识别设备。

configuration_url 细绳 ((可选的

可以管理此设备配置的网页的链接。可以是HTTP或HTTPS链接。

连接 列表|地图 ((可选的

该设备与外界的连接列表作为元组列表[Connection_Type,Connection_Identifier]。例如,网络接口的MAC地址:'Connections':['Mac','02:5B:26:A8:DC:12']

身份标识 列表|细绳 ((可选的

唯一标识设备的ID列表。例如序列号。

制造商 细绳 ((可选的

设备的制造商。

模型 细绳 ((可选的

设备的模型。

姓名 细绳 ((可选的

设备的名称。

建议_area 细绳 ((可选的

如果该设备还没有,则建议一个区域。

sw_version 细绳 ((可选的

设备的固件版本。

via_device 细绳 ((可选的

该设备与家庭助理之间路由消息的设备的标识符。必威是什么此类设备的示例是枢纽或子设备的父设备。这用于在家庭助理中显示设备拓扑。必威是什么

图标 图标 ((可选的

图标对于实体。

JSON_ATTRIBUTES_TEMPLATE 模板 ((可选的

定义a模板从收到的消息中提取JSON字典JSON_ATTRIBUTES_TOPIC。使用示例可以在MQTT传感器文档。

JSON_ATTRIBUTES_TOPIC 细绳 ((可选的

MQTT主题订阅以接收JSON字典有效载荷,然后将设置为Device_Tracker属性。使用示例可以在MQTT传感器文档。

姓名 细绳 ((可选的

MQTT Device_Tracker的名称。

object_id 细绳 ((可选的

代替姓名用于自动生成ENTITY_ID

payload_available 细绳 ((可选的,默认:在线

代表可用状态的有效载荷。

payload_home 细绳 ((可选的,默认:家

代表设备的“家庭”状态的有效载荷值。

payload_not_available 细绳 ((可选的,默认:离线

代表不可用状态的有效载荷。

payload_not_home 细绳 ((可选的,默认:not_home

代表设备的“ not_home”状态的有效负载值。

QoS 整数 ((可选的,默认:0

国家主题的最大QoS级别。

source_type 细绳 ((可选的

设备跟踪器的属性,该属性会在用于跟踪的情况下影响状态。有效的选项是全球定位系统,,,,路由器,,,,蓝牙, 或者Bluetooth_le

state_topic 细绳 必需的

MQTT主题订阅以接收设备跟踪器状态更改。

唯一身份 细绳 ((可选的

唯一标识此Device_Tracker的ID。如果两个Device_Tracker具有相同的唯一ID,则家庭助理将引起例外。必威是什么

value_template 模板 ((可选的

定义a模板返回设备跟踪器状态。

发现示例

您可以使用Discovery协议创建新的设备跟踪器,并使用命令行工具设置其状态Mosquitto_pub发货蚊子或者蚊子客户包装发送MQTT消息。

创建Device_Tracker:

Mosquitto_pub-H127.0.0.1-thome-sassistant/device_tracker/a4567d663 eaf/config-m'{“ state_topic”:“ a4567d663aef/state”,“ name”:“我的跟踪器”,“ payload_home”:“ home”,“ payload_not_home”:“ not_home”}'

将设备跟踪器的状态设置为“家”:

Mosquitto_pub-H127.0.0.1-tA4567D663EAF/州-m'家'