MIoT-Spec: The protocol specification for Xiaomi IoT devices, is a standard designed by the Xiaomi IoT platform to describe the function definition of hardware products according to the networking mode of hardware products, the characteristics of product functions, the characteristics of user usage scenarios and the user's requirements for hardware product use experience specification.
This component uses the miot protocol to automatically integrate Xiaomi devices into HomeAssistant, and currently supports most Xiaomi IoT devices. And it supports HA Web UI, and you can easily integrate Xiaomi devices into HA without configuring yaml.
Starting from the v0.4.4 version, the component has added support for selecting the connection device mode when integrated by account:
Automatic: The component will regularly update the devices that support miot-spec in LAN, and automatically use the local connection for the supported devices (recommended)
Local: All devices filtered by the integrated configuration will use local connection. If you check the devices that do not support miot in LAN, they will be unavailable
Cloud: All devices filtered by the integrated configuration will use cloud connection. It is recommended that miio, BLE, ZigBee devices use this mode
Note: For Local mode, some devices require Home Assistant to be on the same subnet/VLAN. They will not respond to requests from a different subnet. A workaround is to NAT your Home Assistant IP to the device's subnet.
Add device using host/token:
Suitable for devices support miot-spec protocol in LAN
Config Xiaomi Cloud:
Config Xiaomi cloud for the devices integrated by host/token
# configuration.yaml
xiaomi_miot:
username: xiaomi_username
password: xiaomi_password
# server_country: cn # Location of xiaomi cloud: cn(default), de, i2, ru, sg, tw, us
# http_timeout: 15 # Timeout (seconds) for requesting the xiaomi apis
# configuration.yaml
xiaomi_miot:
language: zh # Using the built-in dictionary, currently only `zh` is supported
# https://github.com/al-one/hass-xiaomi-miot/blob/master/custom_components/xiaomi_miot/core/translation_languages.py
translations:
# Global dictionary
idle: '空闲'
busy: '工作中'
# Dictionary for specifying fan modes
fan.mode:
straight wind: '直吹模式'
natural wind: '自然风'
# Dictionary for specifying the drying modes of the washer
washer.drying_level:
moist: '微湿'
extra: '特干'
# configuration.yaml
homeassistant:
customize: !include customize.yaml
# Customize via device model
xiaomi_miot:
# https://github.com/al-one/hass-xiaomi-miot/blob/master/custom_components/xiaomi_miot/core/device_customizes.py
device_customizes:
chuangmi.plug.212a01:
miot_local: true
chunk_properties: 7
# Customize via parent entity
# customize.yaml
domain.your_entity_id:
miot_local: true # Force to read and write data in LAN (integrate by account)
miot_cloud: true # Enable miot cloud for entity (read, write, action)
miot_cloud_write: true # Enable miot cloud (only write)
miot_cloud_action: true # Enable miot cloud (only action)
check_lan: true # Check LAN connection in cloud mode
miio_properties: power,battery # Get miio properties to state attributes
miio_cloud_props: prop.power,event.dev_online
# Custom sub entities
domain.parent_entity_id:
sensor_properties: temperature,humidity,illumination # Miot properties
binary_sensor_properties: is_volume_muted,any_boolen_property
switch_properties: on,power
number_properties: volume
select_properties: mode
fan_properties: mode,fan_level
cover_properties: motor_control
light.your_entity_id:
color_temp_reverse: false # Reverse color temperature (Requires reload config entry)
yeelight_smooth_on: 2000 # milliseconds (Only for Yeelights in local mode)
yeelight_smooth_off: 3000 # milliseconds (Only for Yeelights in local mode)
climate.your_entity_id:
bind_sensor: sensor.temperature_entity,sensor.humidity_entity # Sensor entities
camera.your_entity_id:
video_attribute: 1 # https://github.com/al-one/hass-xiaomi-miot/issues/11#issuecomment-773054167
keep_streaming: true # Continuously update stream address
cover.your_entity_id:
closed_position: 5 # Change cover state to closed when position <= 5%
deviated_position: 2 # Current position deviation 2% -> 0%, 98% -> 100%
motor_reverse: true # Reverse motor state (Requires reload config entry)
position_reverse: true # Reverse motor position (Requires reload config entry)
open_texts: Open,Up
close_texts: Close,Down
media_player.mitv_entity_id:
bind_xiaoai: media_player.xiaoai_entity_id # Bind xiaoai speaker for turn on TV
domain.your_entity_id_xxxx:
interval_seconds: 30 # Seconds between each update state (Requires reload config entry)
chunk_properties: 10 # Chunk miot properties on update state (LAN)
reverse_state: true # Reverse the On/Off state of a binary sensor
Filter entity attributes
Too many entity attributes will make your HA's database very large. If some entity attributes are useless to you, you can configure exclude_state_attributes to ignore them.
