Skip to content

Commit

Permalink
✍️ update readme (#357)
Browse files Browse the repository at this point in the history
* Update README.md - new Configuration path+YAML config reload
  • Loading branch information
pplucky authored Jan 6, 2022
1 parent a38c51d commit 8c8ce09
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ wget -q -O - https://cdn.jsdelivr.net/gh/al-one/hass-xiaomi-miot/install.sh | ba

## Config

> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > [🧩 Integrations](https://my.home-assistant.io/redirect/integrations) > [➕ Add Integration](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot) > 🔍 Search `Xiaomi Miot Auto`
> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > Devices and Services > [🧩 Integrations](https://my.home-assistant.io/redirect/integrations) > [➕ Add Integration](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot) > 🔍 Search `Xiaomi Miot Auto`
Or click: [![Add Integration](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot)

Expand All @@ -54,9 +54,8 @@ xiaomi_miot:
# server_country: cn # location of xiaomi cloud: cn(default), de, i2, ru, sg, us
```

> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > [🧩 Integrations](https://my.home-assistant.io/redirect/integrations) > Xiaomi Miot Auto > Options > ☑️ Enable miot cloud
> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > Devices and Services > [🧩 Integrations](https://my.home-assistant.io/redirect/integrations) > Xiaomi Miot Auto > Options > ☑️ Enable miot cloud
### Config translation languages:

```yaml
# configuration.yaml
Expand Down Expand Up @@ -155,6 +154,10 @@ xiaomi_miot:
- motion_video_latest
```

### YAML configuration reloading
Starting from the v0.4.16 version, the component has added support for configuration reloading (to avoid having to restart [HomeAssistant](https://www.home-assistant.io) instance after a YAML configuration change):
> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > Settings > [🖥️ Server Controls](https://my.home-assistant.io/redirect/server_controls) > YAML configuration reloading > 🔍 Look for `Xiaomi Miot Auto` (almost at the bottom of the list)


## [Supported Devices](https://github.com/al-one/hass-xiaomi-miot/issues/12)

Expand Down Expand Up @@ -299,7 +302,7 @@ logger:
custom_components.xiaomi_miot: debug
```

> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > [✍️ Logs](https://my.home-assistant.io/redirect/logs)
> [⚙️ Configuration](https://my.home-assistant.io/redirect/config) > Settings > [✍️ Logs](https://my.home-assistant.io/redirect/logs)


## Obtain miio token
Expand Down
11 changes: 8 additions & 3 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ wget -q -O - https://cdn.jsdelivr.net/gh/al-one/hass-xiaomi-miot/install.sh | HU
<a name="config"></a>
## 配置

> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > [🧩 集成](https://my.home-assistant.io/redirect/integrations) > [➕ 添加集成](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot) > 🔍 搜索 `Xiaomi Miot Auto`
> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > 设备与服务 > [🧩 集成](https://my.home-assistant.io/redirect/integrations) > [➕ 添加集成](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot) > 🔍 搜索 `Xiaomi Miot Auto`
或者点击: [![添加集成](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=xiaomi_miot)

Expand Down Expand Up @@ -62,7 +62,7 @@ xiaomi_miot:
# server_country: cn # 小米云服务器位置: cn(默认), de, i2, ru, sg, us
```

> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > [🧩 集成](https://my.home-assistant.io/redirect/integrations) > Xiaomi Miot Auto > 选项 > ☑️ 开启云端模式
> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > 设备与服务 > [🧩 集成](https://my.home-assistant.io/redirect/integrations) > Xiaomi Miot Auto > 选项 > ☑️ 开启云端模式
<a name="config-translation-languages"></a>
### 配置翻译词典:
Expand Down Expand Up @@ -166,6 +166,11 @@ xiaomi_miot:
- motion_video_latest
```

<a name="yaml-configuration-reloading"></a>
### YAML配置重载
自v0.4.16版本开始,本插件支持配置重载(修改YAML配置后无需重启[HomeAssistant](https://www.home-assistant.io)):
> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > 设置 > [🖥️ 服务控制](https://my.home-assistant.io/redirect/server_controls) > 配置重载 > 🔍 `重载 XIAOMI MIOT AUTO`


<a name="supported-devices"></a>
## [支持的设备](https://github.com/al-one/hass-xiaomi-miot/issues/12)
Expand Down Expand Up @@ -318,7 +323,7 @@ logger:
custom_components.xiaomi_miot: debug
```

> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > [✍️ 日志](https://my.home-assistant.io/redirect/logs)
> [⚙️ 配置](https://my.home-assistant.io/redirect/config) > 设置 > [✍️ 日志](https://my.home-assistant.io/redirect/logs)


<a name="obtain-miio-token"></a>
Expand Down

0 comments on commit 8c8ce09

Please sign in to comment.