hasscc / meiju Goto Github PK

View Code? Open in Web Editor NEW

67.0 5.0 4.0 305 KB

Midea Meiju (美的美居) For HomeAssistant

License: Apache License 2.0

Python 4.50% Lua 95.50%

meiju midea custom-component home-assistant iot

meiju's Introduction

Midea Meiju for HomeAssistant

Installing

Download and copy custom_components/meiju folder to custom_components folder in your HomeAssistant config folder

# Auto install via terminal shell
wget -q -O - https://cdn.jsdelivr.net/gh/hasscc/get/get | HUB_DOMAIN=ghproxy.com/github.com DOMAIN=meiju REPO_PATH=hasscc/meiju ARCHIVE_TAG=main bash -

Config

# configuration.yaml

meiju:
  # Single account
  username: 18866668888 # Username of Meiju APP (美的美居)
  password: abcdefghijk # Password
  devices:
    - device_id: 160123456789001
      host: 192.168.1.101
    - device_id: 160123456789002
      host: 192.168.1.102

  # Multiple accounts
  accounts:
    - username: 18866668881
      password: password1
      devices:
        - device_id: 160123456789003
          host: 192.168.1.123
    - username: 18866668882
      password: password2
      scan_interval: 00:00:20
      devices:
        - device_id: 160123456789004
          host: 192.168.1.234
          scan_interval: 00:00:15

  # https://github.com/hasscc/meiju/blob/main/custom_components/meiju/device_customizes.yaml
  customizes:
    B3: # Device type or sn8
      get_extra: {10: 0x31}
      set_extra: {10: 0x21}
      sensors:
        status:
          byte: 11
          dict: [power_off, power_on, working]
          attrs_template: |-
            {{ {
              'preheat': bytes[26]|bitwise_and(0x02) > 0,
              'cooling': bytes[26]|bitwise_and(0x08) > 0,
            } }}
      binary_sensors:
        upstair_door:
          byte: 21
          state_template: '{{ value|bitwise_and(0x04) > 0 }}'
      switches:
        power:
          byte: 11
          on_extra: {16: 0x01, 22: 0x01}
          off_extra: {16: 0x00, 22: 0x00}
        lock:
          byte: 21
          on_value: 0x01
          off_value: 0x00
      selects:
        mode:
          byte: 12
          options:
            0: {name: 空闲, extra: {11: 0x00}}
            23: {name: 保洁(75分钟75℃), extra: {13: 75, 14: 15, 27: 60}}
            26: {name: 长效存储(15分钟60℃), extra: {13: 60, 14: 15, 27: 0}}
          set_extra: {11: 0x02}
      numbers:
        upstair_temp:
          byte: 13
          step: 5
          min: 60
          max: 125

Services

Get Meiju Devices

service: meiju.get_devices
data:
  username: 18866668881
  throw: true # Show result in HA notifications

Request Meiju API

service: meiju.request_api
data:
  entity_id: sensor.xac_xxxxxx_info # Any sensor entity in the account
  username: 18866668881 # Optional if entity_id is specified
  api: /appliance/home/list/get
  params:
    homegroupId: 666666

Send control command to device

service: meiju.send_command
data:
  entity_id: sensor.xac_xxxxxx_info
  command: AA BB CC # Command bytes like: FF 00 AA
                    # [0xAA, 0xFF, 0x00]
                    # {11: 0xAA, 13: 0xBB}

Get Meiju device Lua script

service: meiju.get_lua
data:
  entity_id: sensor.xac_xxxxxx_info

Get Meiju device plugin

service: meiju.get_plugin
data:
  entity_id: sensor.xac_xxxxxx_info

Thanks

meiju's People

Stargazers

Watchers

Forkers

blindlight86 hellkun ichenlife delandhan

meiju's Issues

希望组建一个共建交流群

如题

美的乐享3，协议不同，大佬帮忙看下

搞了好久，查询可以，控制不了，大佬，麻烦帮忙看下，谢谢
https://github.com/yingying77/midea-lexiang-3/blob/main/T_0000_AC_23096361_2022051705.lua

当前版本提示调用业务系统异常

在我的HomeAssistant中使用该插件添加美的JSQ30-MJ3热水器时程序出现错误，提示

Logger: homeassistant.setup
Source: setup.py:288
First occurred: 15:36:12 (1 occurrences)
Last logged: 15:36:12

Error during setup of component meiju
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/setup.py", line 288, in _async_setup_component
    result = await task
             ^^^^^^^^^^
  File "/config/custom_components/meiju/__init__.py", line 100, in async_setup
    await acc.update_devices(cfg.get(CONF_DEVICES) or [])
  File "/config/custom_components/meiju/__init__.py", line 505, in update_devices
    await dvc.auth_device()
  File "/config/custom_components/meiju/__init__.py", line 632, in auth_device
    token, key = await self.hass.async_add_executor_job(self.account.cloud.gettoken, udpid)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/concurrent/futures/thread.py", line 58, in run
    result = self.fn(*self.args, **self.kwargs)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/msmart/cloud.py", line 190, in gettoken
    response = self.api_request(
               ^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/msmart/cloud.py", line 109, in api_request
    self.handle_api_error(int(response['code']), response['msg'])
  File "/usr/local/lib/python3.11/site-packages/msmart/cloud.py", line 275, in handle_api_error
    handler()
  File "/usr/local/lib/python3.11/site-packages/msmart/cloud.py", line 261, in throw
    raise ValueError(error_code, message)
ValueError: (40404, '调用业务系统异常(访问地址不存在) [no Route matched with those values]')

用户名和密码检查是正确的，也有热水器信息返回。

此错误来自自定义集成。

Logger: custom_components.meiju
Source: custom_components/meiju/__init__.py:496
Integration: Midea Meiju (documentation, issues)
First occurred: 15:36:12 (1 occurrences)
Last logged: 15:36:12

211106239999999, e3, 51109999, 0000E353151101719181712000357YX4,0000, 204, 燃气热水器

尝试连接代码中的地址，该网址返回内容和错误提示一样
{"msg":"调用业务系统异常(访问地址不存在) [no Route matched with those values]","code":40404}
怀疑美的更改了业务网址导致该故障发生，期待作者大大看一下。

怎么样全面支持美的美居中所有的智能家电吗

现在使用homeassistant通过易微联绑定了美的的空调，但是易微联不支持美的的洗碗机和电风扇这些职能产品，这边有其他什么办法吗

如何适配未支持的美的设备？

首先在这里感谢 @mac-zhou @blindlight86 @vividmuse 等各位大佬对美的美的设备协议和美居APP接口的不懈努力，此插件的只要功能即将美的设备的读写命令通过yaml转换为HA实体。美的设备的读写命令是通过字节(byte)数组传输的，因此适配美的设备需要一点编程基础。

当前阶段，本插件仅支持yaml配置，后续会支持通过UI集成

Yaml配置

# configuration.yaml
meiju:
  # 单个账号
  username: 18866668888 # 美居APP账号
  password: abcdefghijk # 美居APP密码
  devices: # 设备列表
    - device_id: 160123456789001 # 设备ID
      host: 192.168.1.101        # 设备IP
    - device_id: 160123456789002
      host: 192.168.1.102
  # 多个账号
  accounts:
    - username: 18866668881 # 账号1
    - username: 18866668882 # 账号2
      devices: # 设备列表
customizes: # 设备自定义

customizes: 根据设备类型或SN8(型号)为设备解析命令成HA实体的配置，类似于HA的template，可以为设备添加不同类型的实体以展示状态和控制设备
- get_extra: {10: 0x31} 配置查询状态命令索引为10的byte值为0x31，部分设备为0x03或其他
- set_extra: {10: 0x21} 配置控制设备命令索引为10的byte值为0x21
- sensors: 添加sensor传感器实体
  - byte: 11 表示该实体的状态在状态byte数组的第12位上(索引为11)
  - dict: 字典或数组，映射状态值
  - state_template: 实体状态模板
  - attrs_template: 实体属性模板，返回字典
  - 上述选项其他实体通用
- binary_sensors: 添加二元传感器实体，同sensors
  - state_template: 实体状态模板，返回布尔
- switches: 添加开关实体
  - on_value: 0x01 byte位上的值等于此值时表示开
  - off_value: 0x00 byte位上的值等于此值时表示关
  - on_extra: 打开时设置额外的byte数据，字典类型
  - off_extra: 关闭时设置额外的byte数据，字典类型
- selects: 添加下拉选择实体，如：模式
  - set_extra: 选中选项时设置额外的byte数据
  - options: 下拉选项，字典类型，key为byte位上的值
    - value为字符串时，表示显示的选项名称
    - name: 选项名称
    - extra: 选中时额外的byte数据，字典类型
- numbers: 添加数值实体，如：目标温度
  - max: 最大值
  - min: 最小值
  - step: 步长，默认1
Lua脚本为美居APP编解码设备命令的程序，在lua脚本中可以找到每个设备属性/功能对应的byte位是多少，以及值的含义
- 通过meiju.get_lua服务获取设备的lua脚本
- 通过vscode或其他IDE格式化lua代码，插件的lua目录下有常用设备的lua
- 分析lua文件中各byte位的含义，不同设备的lua规范不一致，因此需要有编程基础
  - byte数组的前10位(索引0-9)为头信息，其中第10位(索引为9)为命令类型(0x02控制 0x03读取)
  - byte数组的第11位(索引10)为请求/响应类型，各设备可能不一样，参考get_extra set_extra
  - 第12位开始通常为各属性或功能的值，部分lua会把头信息移除，因此这些lua中命令body的起始索引是从1或0开始
  - lua文件中可能会根据设备的具体型号来使用不同的byte值，通常使用设备的modelNumber或sn8来区分，这两种型号可以在info实体的属性中找到
JS插件为美居APP中设备控制页面的代码，在js插件代码中可以找到不同型号的设备有哪些功能及选项，比如有哪些模式。
- 通过meiju.get_plugin服务获取设备的JS插件代码
目前该自定义插件仍在开发中，主要开发工作为将lua及js中的命令通过yaml转换成HA实体。由于个人精力的原因，适配不同设备是个漫长的过程，希望有编程能力的同学可以参考以上内容和device_customizes.yaml一起参与适配。

话说device_id是怎么获取的？

我在美的美居的app里找不到这个值……