MQTT锁


mqtt锁定平台使您可以控制启用的MQTT锁。

配置

在理想的情况下,MQTT设备将具有state_topic发布状态更改。如果这些消息是用保持标志,MQTT锁将在订阅后接收即时状态更新,并以正确的状态开始。否则,锁的初始状态将是错误的/解锁。

当一个state_topic不可用,锁将在乐观的模式下工作。在此模式下,锁将在每个命令后立即更改状态。否则,锁将等待设备的状态确认(来自state_topic)。

即使有状态主题可用,也可以强迫乐观的模式。如果经历不正确的锁定操作,请尝试启用它。

锁必须支持开锁。锁可以选择支持打开,(例如,除了在闩锁之外打开螺栓),在这种情况下,payload_open在配置中需要。如果锁处于乐观模式,它将将状态更改为解锁处理时打开命令。

要在安装中启用MQTT锁,请将以下内容添加到您的configuration.yaml文件:

#示例Configuration.yaml条目mqtt-command_topic家庭/前门/套装”

以前的配置格式

配置变量

可用性 列表 ((可选的

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主题订阅以接收可用性(在线/离线)更新。不得一起使用可用性

command_topic 细绳 必需的

MQTT主题发布命令以更改锁定状态。

设备 地图 ((可选的

有关设备的信息,此锁是将其绑定到的一部分设备注册表。只能通过MQTT发现什么时候唯一身份设置。必须至少存在一个标识符或连接以识别设备。

configuration_url 细绳 ((可选的

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

连接 列表 ((可选的

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

身份标识 字符串|列表 ((可选的

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

制造商 细绳 ((可选的

设备的制造商。

模型 细绳 ((可选的

设备的模型。

姓名 细绳 ((可选的

设备的名称。

建议_area 细绳 ((可选的

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

sw_version 细绳 ((可选的

设备的固件版本。

via_device 细绳 ((可选的

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

enabled_by_default 布尔 ((可选的,默认:正确

标志,该标志首先添加时定义是否应启用实体。

编码 细绳 ((可选的,默认:UTF-8

收到和已发布消息的有效载荷的编码。调成“”禁用传入有效载荷的解码。

Entity_Category 细绳 ((可选的,默认:无

类别实体。

图标 图标 ((可选的

图标对于实体。

JSON_ATTRIBUTES_TEMPLATE 模板 ((可选的

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

JSON_ATTRIBUTES_TOPIC 细绳 ((可选的

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

姓名 细绳 ((可选的,默认:MQTT锁

锁的名称。

object_id 细绳 ((可选的

代替姓名用于自动生成ENTITY_ID

乐观的 布尔 ((可选的

标志定义锁定是否在乐观模式下工作。

默认:

真的如果不state_topic定义,否则错误的

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

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

payload_lock 细绳 ((可选的,默认:锁

有效载荷已发送到锁锁定。

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

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

payload_unlock 细绳 ((可选的,默认:解锁

有效载荷已发送到锁以解锁。

payload_open 细绳 ((可选的,默认:打开

有效载荷已发送到锁以打开它。

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

国家主题的最大QoS级别。

保持 布尔 ((可选的,默认:false

是否已发表的消息应在是否有保留标志。

state_locked 细绳 ((可选的,默认:锁定

锁定时,有效载荷发送给锁定。

state_topic 细绳 ((可选的

MQTT主题订阅以接收状态更新。

state_unlocked 细绳 ((可选的,默认:解锁

解锁锁定时,有效载荷发送给了锁。

唯一身份 细绳 ((可选的

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

value_template 细绳 ((可选的

定义a模板从有效载荷中提取值。

确保您的主题完全匹配。一些主题/一些主题是不同的主题。

例子

在本节中,您将找到一些如何使用此锁的现实示例。

完整配置

下面的示例显示了MQTT锁定的完整配置。

#示例Configuration.yaml条目mqtt-姓名前门state_topic家庭辅助/前门/”command_topic家庭辅助/前门/套装”payload_lock锁”payload_unlock开锁”state_locked锁”state_unlocked开锁”乐观的错误的QoS1保持真的value_template{{{value.x}}””

请密切关注保留消息以保持状态,因为您不想重新启动某些东西时偶然地解锁门。

对于检查,您可以使用命令行工具Mosquitto_pub发货蚊子发送MQTT消息。这使您可以手动操作锁:

Mosquitto_pub-H127.0.0.1-t家庭辅助/前门/套装-m“锁”