From 83f013bbf6aeb3001445517faf41539fe52edde7 Mon Sep 17 00:00:00 2001 From: unknown Date: Fri, 22 Sep 2023 15:06:29 +0800 Subject: [PATCH] documentation --- README.md | 25 ++++++++++++++----------- README_hans.md | 48 ++++++++++++++++++++++++++---------------------- 2 files changed, 40 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index a7180957..573db40e 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ This component inspired from the repository at [@mac-zhou](https://github.com/ma Thanks also to [@NeoAcheron](https://github.com/NeoAcheron/midea-ac-py). -If this component is helpful for you, please star it, it encourages me a lot. +⭐If this component is helpful for you, please star it, it encourages me a lot. -***Note: Home Assistant 2022.5 or higher required for this integration*** +***❗Note: Home Assistant 2022.5 or higher required for this integration*** # Supported brands @@ -70,23 +70,22 @@ Search 'Midea AC LAN' in HACS and install, or copy all files in `custom_componen Restart Home Assistant. # Add device -***Note: First, set a static IP address for your appliance in the router, in case the IP address of the appliance changes after set-up.*** +***❗Note: First, set a static IP address for your appliance in the router, in case the IP address of the appliance changes after set-up.*** After installation, search and add component Midea AC LAN in Home Assistant integrations page. Or click [![Configuration](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=midea_ac_lan) -***Note: During the configuration process, you may be asked to enter your Midea account and password. It's necessary to retrieve appliance information (Token and Key) from Midea cloud server. After all appliances configured, you can remove the Midea account configuration without affecting the use of the appliance.*** +***❗Note: During the configuration process, you may be asked to enter your Midea account and password. It's necessary to retrieve appliance information (Token and Key) from Midea cloud server. After all appliances configured, you can remove the Midea account configuration without affecting the use of the appliance.*** -## Automatically -This component could auto-discover and list Midea M-Smart appliances in network, select one and add it in. You could repeat the above action to add multiple devices. +After the account is configured, Click 'ADD DEVICE' once more to add new device. You could repeat the above action to add multiple devices. -***Note: Automatic configuration requires your appliances and your Home Assistant must be in the same sub-network. Otherwise, devices may not be auto-discovered. Check this by yourself.*** +## Discovery automatically +Using this option, the component could auto-discover and list Midea M-Smart appliances in network or specified IP address, select one and add it in. -## By IP -If auto-discover could not work, you could try to discover the appliance with the specified IP Address. +***❗Note: Discovery automatically requires your appliances and your Home Assistant must be in the same sub-network. Otherwise, devices may not be auto-discovered. Check this by yourself.*** -## Manually +## Configure manually If you already know following information, you could add the appliance manually. - Appliance code - Appliance type (one of [Supported appliances](README.md#supported-appliances)) @@ -96,6 +95,10 @@ If you already know following information, you could add the appliance manually. - Token - Key +## List all appliances only +Using this option, you can list all discoverable Midea M-Smart devices on the network, along with their IDs, types, SNs, and other information. + +***❗Note: For certain reasons, not all supported devices may be listed here.*** # Configure @@ -110,7 +113,7 @@ Set the IP address of device. You can reset this when your device IP is changed. Set the interval for actively refreshing the status of a single device (the unit is second) (30 by default and 0 means not refresh actively) Mostly the status update of Midea devices relies on the active information notification of the device, in which condition the status update in HA still works normally even if the refresh interval is set to be “0”. This component will also actively query the device status at regular intervals, and the default time is 30 seconds. Some devices do not have active information notifications when their status changed, so synchronization with the status in HA will be slower. If you are very concerned about the synchronization speed of the status, you can try to set a shorter status refresh interval. -***None: shorter refresh interval may mean more power consumption*** +***❗Note: shorter refresh interval may mean more power consumption*** ## Extra sensor and switch entities After configuration, one of few main entity (e.g. climate entity) may be generated . If you want to make the attributes to extra sensor and switch entities, click CONFIGURE in Midea AC LAN integration card to choose (if your devices supported). diff --git a/README_hans.md b/README_hans.md index a4803229..8a8c9a00 100644 --- a/README_hans.md +++ b/README_hans.md @@ -11,13 +11,13 @@ - 生成额外的传感器和开关方便进行设备控制. - 与设备保持TCP长连接以便实时同步设备状态. -本集成部分技术来源来自 [@mac-zhou](https://github.com/mac-zhou/midea-msmart)，他的美的midea-msmart提供了类似的功能。 该组件包括来自他的项目中经过改写的部分代码。 +本集成部分技术来源来自 [@mac-zhou](https://github.com/mac-zhou/midea-msmart), 他的美的midea-msmart提供了类似的功能。 该组件包括来自他的项目中经过改写的部分代码。 同时感谢[@NeoAcheron](https://github.com/NeoAcheron/midea-ac-py) -如果本集成对你有所帮助，请不吝为它点个星，这将是对我的极大激励。 +⭐如果本集成对你有所帮助, 请不吝为它点个星, 这将是对我的极大激励。 -***注意: 本集成需要Home Assistant 2022.5或更高版本*** +***❗注意: 本集成需要Home Assistant 2022.5或更高版本*** # 已支持的品牌 @@ -65,28 +65,27 @@ | FD | 加湿器 | [FD_hans.md](doc/FD_hans.md) | # 安装 -在HACS中搜索'Midea AC LAN'并安装，或者从[Latest release](https://github.com/georgezhao2010/midea_ac_lan/releases/latest)下载最新的Release版本，将其中的`custom_components/midea_ac_lan`放到你的Home Assistant的`custom_components/midea_ac_lan`中。 +在HACS中搜索'Midea AC LAN'并安装, 或者从[Latest release](https://github.com/georgezhao2010/midea_ac_lan/releases/latest)下载最新的Release版本, 将其中的`custom_components/midea_ac_lan`放到你的Home Assistant的`custom_components/midea_ac_lan`中。 重启Home Assistant # 添加设备 -***注意: 首先，在路由器上为你的设备设置一个静态IP地址，以防设置后设备的IP地址发生改变。*** +***❗注意: 首先, 在路由器上为你的设备设置一个静态IP地址, 以防设置后设备的IP地址发生改变。*** -安装之后，在Home Assistant的集成界面搜索添加集成Midea AC LAN, 如果需要添加多台设备，多次添加本集成并执行自动配置即可。 +安装之后, 在Home Assistant的集成界面搜索添加集成Midea AC LAN, 如果需要添加多台设备, 多次添加本集成并执行自动配置即可。 或者直接点击 [![Configuration](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=midea_ac_lan) -***注意: 配置过程中，可能会要求输入你的美的账号及密码，这是因为需要去美的云服务器获取设备的信息 (Token and Key)。在完成所有设备配置后，可以删除美的账户配置，不影响设备的使用*** +***❗注意: 配置过程中, 可能会要求输入你的美的账号及密码, 这是因为需要去美的云服务器获取设备的信息 (Token and Key)。在完成所有设备配置后, 可以删除美的账户配置, 不影响设备的使用*** -## 自动 -自动配置会自动搜索网络上的美的M-Smart设备，并将搜索到的设备列出，选择一个设备执行添加。多台设备执行多次添加即可。 +完成美的账户配置之后, 点击'添加设备'进行设备添加。你可以多次重复操作以添加多台设备。 -***注意: 自动配置要求设备必须与HA在同一网段，否则可能搜索不到设备，请自行确认这点*** +## Discovery automatically / 自动搜索 +使用此选项, 组件会列出网络上或者指定IP地址上的设备, 选择一个并进行添加。 -## 指定IP地址 -如果自动配置无法完成，可以尝试通过指定IP地址的方式搜索设备并进行配置。 +***❗注意: 自动配置要求设备必须与HA在同一网段, 否则可能搜索不到设备, 请自行确认这点*** -## 手动 +## Configure manually / 手动配置 如果之前你已经通过其它集成手工配置过设备, 并知道以下信息, 也可以进行手动配置 - 设备ID - 设备类型 ([已支持的设备](README_hans.md#%E5%B7%B2%E6%94%AF%E6%8C%81%E7%9A%84%E8%AE%BE%E5%A4%87)之一) @@ -96,29 +95,34 @@ - Token - Key +## List all appliances only / 仅列出所有设备 + +使用此选择, 可以列出网络中所有可以被搜索到的美的M-Smart设备, 以及他们的ID, 类型, SN等信息 + +***❗注意: 出于某些原因, 可能不是所有受支持的设备都能于此列出*** # 配置 集成配置位于`配置 -> 设备与服务 -> Midea AC LAN -> 设备 -> 选项`。 -在配置中，你可以在设备IP改变后重新指定IP地址，也可以增加扩展的传感器或开关等实体或者自定义你的设备。 +在配置中, 你可以在设备IP改变后重新指定IP地址, 也可以增加扩展的传感器或开关等实体或者自定义你的设备 ## IP地址 -指定设备的IP地址。当你的设备IP地址变动后，可以重新设定它。 +指定设备的IP地址。当你的设备IP地址变动后, 可以重新设定它 ## 刷新间隔 指定单台设备的主动状态刷新间隔 (单位为秒) (默认值为30, 设0代表不进行主动刷新) -大部分的美的设备在自身状态改变时会主动发送通知，在这种情况下，即使将改值设为0，也不会影响HA中的设备状态更新。组件默认每间隔30秒会进行主动刷新。部分设备没有状态改变时主动通知的机制，状态同步就会表现得很慢，这种情况下可以尝试更短的主动状态更新间隔。 +大部分的美的设备在自身状态改变时会主动发送通知, 在这种情况下, 即使将改值设为0, 也不会影响HA中的设备状态更新。组件默认每间隔30秒会进行主动刷新。部分设备没有状态改变时主动通知的机制, 状态同步就会表现得很慢, 这种情况下可以尝试更短的主动状态更新间隔。 -***注意: 更小的更新间隔意味着更多的能源消耗*** +***❗注意: 更小的更新间隔意味着更多的能源消耗*** ## 额外的传感器及开关实体 -配置完成后, 可能会默认生成一个或几个主要实体(比如climate实体)。如果需要其它属性生成为扩展的传感器及开关实体，在Midea AC LAN集成卡片上点击'选项'，并选择要生成的传感器及开关(如果你的设备支持该属性)。 +配置完成后, 可能会默认生成一个或几个主要实体(比如climate实体)。如果需要其它属性生成为扩展的传感器及开关实体, 在Midea AC LAN集成卡片上点击'选项', 并选择要生成的传感器及开关(如果你的设备支持该属性)。 ## 自定义 -某些类型的设备有它们自己的自定义项，可以通过自定义项定制设备的特点。如果你的设备无法正常工作，也许你需要自定义它。请参阅设备文档以获取具体信息。 +某些类型的设备有它们自己的自定义项, 可以通过自定义项定制设备的特点。如果你的设备无法正常工作, 也许你需要自定义它。请参阅设备文档以获取具体信息。 自定义的格式必须是JSON。 -如果要设置多个自定义项，请注意遵循JSON的格式要求 +如果要设置多个自定义项, 请注意遵循JSON的格式要求 示例 ```json @@ -126,7 +130,7 @@ ``` # 调试 -要打开调试日志输出，在configuration.yaml中做如下配置 +要打开调试日志输出, 在configuration.yaml中做如下配置 ```yaml logger: default: warn @@ -135,6 +139,6 @@ logger: ``` # 支持我的工作 -如果喜欢这个集成，可以使用支付宝或者微信支付赞助我来支持我的工作。 +如果喜欢这个集成, 可以使用支付宝或者微信支付赞助我来支持我的工作。 ![alipay](doc/images/alipay.png) ![wechatpay](doc/images/wechatpay.png) \ No newline at end of file