MQTT粉丝


mqtt风扇平台使您可以控制启用MQTT的风扇。

配置

在理想的情况下,MQTT设备将具有state_topic发布状态更改。如果这些消息是用保持标志,MQTT风扇将在订阅后获得即时状态更新,并以正确的状态开始。否则,风扇的初始状态将是未知。MQTT设备可以将当前状态重置为未知用一个没有任何有效载荷。

当一个state_topic不可用,风扇将在乐观的模式下工作。在此模式下,风扇将在每个命令后立即更改状态。否则,风扇将等待设备的状态确认(来自state_topic)。初始状态设置为错误的/离开在乐观的模式下。

即使一个state_topic可用。如果您经历了不正确的风扇操作,请尝试启用它。

要在安装中启用MQTT粉丝,请添加以下内容configuration.yaml文件:

#示例Configuration.yaml条目扇子-平台mqttcommand_topic卧室_FAN/ON/SET”

配置变量

可用性 列表 ((可选的

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

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

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

乐观的 布尔 ((可选的

标志定义风扇是否在乐观模式下工作

默认:

真的如果没有定义状态主题,否则错误的

OSCILLATION_COMMAND_TEMPLATE 模板 ((可选的

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

oscillation_command_topic 细绳 ((可选的

MQTT主题发布命令以更改振荡状态。

oscillation_state_topic 细绳 ((可选的

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

OSCILLATION_VALUE_TEMPLATE 细绳 ((可选的

定义a模板从振荡中提取值。

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

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

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

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

payload_off 细绳 ((可选的,默认:关闭

代表停止状态的有效载荷。

payload_on 细绳 ((可选的,默认:ON

代表运行状态的有效载荷。

payload_oscillation_off 细绳 ((可选的,默认:oscillate_off

代表振荡状态的有效载荷。

payload_oscillation_on 细绳 ((可选的,默认:oscillate_on

代表状态振荡的有效载荷。

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

一个特殊的有效载荷重置百分比状态属性为没有任何当收到百分比_STATE_TOPIC

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

一个特殊的有效载荷重置PRESET_MODE状态属性为没有任何当收到PRESET_MODE_STATE_TOPIC

百分比_command_template 模板 ((可选的

定义a模板生成有效载荷以发送到百分比_command_topic

百分比_command_topic 细绳 ((可选的

MQTT主题发布命令以根据百分比更改风扇速度状态。

百分比_STATE_TOPIC 细绳 ((可选的

MQTT主题根据百分比订阅以接收风扇速度。

百分比_value_template 细绳 ((可选的

定义a模板提取百分比从接收到的有效载荷的价值百分比_STATE_TOPIC

preset_mode_command_template 模板 ((可选的

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

PRESET_MODE_COMMAND_TOPIC 细绳 ((可选的

MQTT主题发布命令以更改预设模式。

PRESET_MODE_STATE_TOPIC 细绳 ((可选的

MQTT主题订阅以基于预设的风扇速度。

PRESET_MODE_VALUE_TEMPLATE 细绳 ((可选的

定义a模板提取PRESET_MODE从接收到的有效载荷的价值PRESET_MODE_STATE_TOPIC

PRESET_MODES 列表 ((可选的, 默认: []

预设模式列表该风扇能够运行。常见的例子包括汽车,,,,聪明的,,,,,,,,生态微风

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

国家主题的最大QoS级别。

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

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

speed_range_max 整数 ((可选的,默认:100

数字输出范围的最大值(代表100%)。速度的数量speed_range/100将确定百分比

speed_range_min 整数 ((可选的,默认:1

数字输出范围的最小值(离开不包括,所以speed_range_min-1代表0%)。speed_range / 100中的速度数将确定百分比

state_topic 细绳 ((可选的

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

state_value_template 细绳 ((可选的

定义a模板从国家提取值。

唯一身份 细绳 ((可选的

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

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

例子

在本节中,您可以找到一些如何使用此风扇的真实示例。

完整配置

下面的示例显示了使用百分比和预设模式的MQTT风扇的完整配置。速度范围内有10个速度,因此百分比= 100 /10步= 10.0%。

#使用基于百分比的速度使用预设模式configuration.yaml示例扇子-平台mqtt姓名卧室扇子”state_topic卧室_FAN/ON/状态”command_topic卧室_FAN/ON/SET”oscillation_state_topic卧室_FAN/振荡/状态”oscillation_command_topic卧室_FAN/振荡/集合”百分比_STATE_TOPICbuthroom_fan/speed/persationage_state”百分比_command_topic卧室_FAN/速度/百分比”PRESET_MODE_STATE_TOPICbuthroom_fan/preset/preset_mode_state”PRESET_MODE_COMMAND_TOPICbuthroom_fan/preset/preset_mode”PRESET_MODES-汽车”-聪明的”-哇”-生态”-微风”QoS0payload_on真的”payload_off错误的”payload_oscillation_on真的”payload_oscillation_off错误的”speed_range_min1speed_range_max10

使用命令模板配置

此示例演示了如何将命令模板与JSON输出一起使用。

#示例configuration.yaml带有命令模板扇子-平台mqtt姓名卧室扇子”command_topic卧室_FAN/ON/SET”command_template{状态:'{{{价值}}'}””oscillation_command_topic卧室_FAN/振荡/集合”OSCILLATION_COMMAND_TEMPLATE{振荡:'{{{价值}}'}””百分比_command_topic卧室_FAN/速度/百分比”百分比_command_template{百分比:'{{{价值}}'}””PRESET_MODE_COMMAND_TOPICbuthroom_fan/preset/preset_mode”preset_mode_command_template{PRESET_MODE:'{{{价值}}'}””PRESET_MODES-汽车”-聪明的”-哇”-生态”-微风”