Xiaomi Raw 项目使用教程

Xiaomi Raw 项目使用教程

xiaomi_rawCustom component for Home Assistant to faciliate the reverse engeneering of Xiaomi MiIO devices项目地址:https://gitcode.com/gh_mirrors/xia/xiaomi_raw

1. 项目的目录结构及介绍

Xiaomi Raw 项目的目录结构如下：

xiaomi_raw/
├── custom_components/
│   └── xiaomi_miio_raw/
│       ├── __init__.py
│       ├── sensor.py
│       ├── switch.py
│       └── manifest.json
├── tests/
│   └── e2e/
│       └── test_sensor.py
├── .flake8
├── .gitignore
├── .hound.yml
├── .pre-commit-config.yaml
├── LICENSE
├── README.md
└── hacs.json

目录结构介绍

• custom_components/xiaomi_miio_raw/: 包含自定义组件的核心文件。
  • __init__.py: 组件的初始化文件。
  • sensor.py: 传感器相关的功能实现。
  • switch.py: 开关相关的功能实现。
  • manifest.json: 组件的元数据文件。
• tests/e2e/: 包含端到端测试文件。
  • test_sensor.py: 传感器功能的端到端测试。
• .flake8: 代码风格检查配置文件。
• .gitignore: Git 忽略文件配置。
• .hound.yml: Hound 代码审查配置文件。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• hacs.json: HACS 集成配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 custom_components/xiaomi_miio_raw/__init__.py。该文件主要负责组件的初始化和注册。

主要功能

• 初始化组件。
• 注册传感器和开关实体。
• 处理配置和设备连接。

3. 项目的配置文件介绍

项目的配置文件主要涉及 configuration.yaml 文件，用于配置 Home Assistant 集成。

配置示例

sensor:
  - platform: xiaomi_miio_raw
    name: Any Xiaomi MiIO device
    host: 192.168.130.73
    token: 56197337f51f287d69a8a16cf0677379
    sensor_property: 'humidity'
    sensor_unit: '%'
    default_properties_getter: 'get_prop'
    default_properties:
      - humidity
      - power
      - temperature

switch:
  - platform: xiaomi_miio_raw
    name: Any Xiaomi MiIO device
    host: 192.168.130.73
    token: 56197337f51f287d69a8a16cf0677379
    turn_on_command: 'set_power'
    turn_on_parameters: 'on'
    turn_off_command: 'set_power'
    turn_off_parameters: 'off'

配置项说明

• platform: 指定集成类型。
• name: 设备名称。
• host: 设备 IP 地址。
• token: 设备 API 令牌。
• sensor_property: 传感器属性。
• sensor_unit: 传感器单位。
• default_properties_getter: 默认属性获取方法。
• default_properties: 默认属性列表。
• turn_on_command: 打开设备的命令。
• turn_on_parameters: 打开设备的参数。
• turn_off_command: 关闭设备的命令。
• turn_off_parameters: 关闭设备的参数。

以上是 Xiaomi Raw 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。希望对您有所帮助！

xiaomi_rawCustom component for Home Assistant to faciliate the reverse engeneering of Xiaomi MiIO devices项目地址:https://gitcode.com/gh_mirrors/xia/xiaomi_raw