MQTT按钮


mqtt按钮平台可让您在按下前端按钮或调用按钮按服务时发送MQTT消息。这可用于公开远程设备的某些服务,例如重新启动。

配置

#示例Configuration.yaml条目按钮-平台mqttcommand_topic家庭/卧室/开关1/重新启动”

配置变量

可用性 列表 ((可选的

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_template 模板 ((可选的

定义a模板生成有效载荷以发送到command_topic

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 细绳 ((可选的

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

device_class device_class ((可选的,默认:无

类型/类按钮将图标设置在前端。

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

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

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

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

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

payload_press 细绳 ((可选的,默认:按

有效载荷发送以触发按钮。

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

国家主题的最大QoS级别。默认值为0,也将用于发布消息。

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

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

唯一身份 细绳 ((可选的

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

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

例子

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

完整配置

下面的示例显示了按钮的完整配置。

#示例Configuration.yaml条目按钮-平台mqtt唯一身份buthroom_switch_reboot_btn姓名重新开始卧室转变”command_topic家庭/卧室/switch1/命令”payload_press重新开始”可用性-话题家庭/卧室/开关1/可用”QoS0保持错误的Entity_Category配置”device_class重新开始”