Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
georgezhao2010 committed Sep 8, 2023
1 parent 10d127c commit 216bfc5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Midea Meiju Codec

[![Stable](https://img.shields.io/github/v/release/georgezhao2010/midea-meiju-codec)](https://github.com/georgezhao2010/midea-meiju-codec/releases/latest)

通过网络获取你美居家庭中的设备,并且在本地配置这些设备,并通过本地更新状态及控制设备。

- 自动查找和发现设备
Expand All @@ -9,9 +11,15 @@

## 非常初期的预览版
- 仅供技术实现验证以及评估
- 目前无法控制设备,预计v0.0.3实现
- 所有设备默认可生成一个名为Status的二进制传感器,其属性中列出了设备可访问的所有属性,当然有些值不可设置

## 实体映射
映射文件位于`device_map/device_mapping.py`, 目前支持映射的实体类型如下:
- climate
- switch
- sensor
- binary_sensor

## 安装与配置
- 基于HomeAssistant Flow Config UI配置
- 在初次配置的时候,由于要安装三方Python库lupa,所以可能会转一会,正常现象,等着就行。
- 目前一个设备仅生成了一个二进制传感器Status, Status的属性中列出了设备可读的所有信息, 且会自动更新这些信息。
- 如果要求不高,使用模板将属性映射成sensor或者binary_sensor,即可实时反映设备的工作状态。
4 changes: 3 additions & 1 deletion custom_components/midea_meiju_codec/core/discover.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,5 +166,7 @@ def enum_all_broadcast():
if ip.is_IPv4 and ip.network_prefix < 32:
localNet = IPv4Network(f"{ip.ip}/{ip.network_prefix}", strict=False)
if localNet.is_private and not localNet.is_loopback and not localNet.is_link_local:
nets.append(str(localNet.broadcast_address))
addr = str(localNet.broadcast_address)
if addr not in nets:
nets.append(addr)
return nets

0 comments on commit 216bfc5

Please sign in to comment.