Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ SHELL ["/bin/bash", "-c"]
RUN <<EOF
export TARGETARCH=${TARGETARCH/arm64/aarch64}
export TARGETARCH=${TARGETARCH/amd64/x86_64}
curl -o pagefind.tar.gz https://github.com/CloudCannon/pagefind/releases/download/v$PAGEFIND_VERSION/pagefind-v$PAGEFIND_VERSION-$TARGETARCH-unknown-linux-musl.tar.gz -L
curl -o pagefind.tar.gz https://github.com/Pagefind/pagefind/releases/download/v$PAGEFIND_VERSION/pagefind-v$PAGEFIND_VERSION-$TARGETARCH-unknown-linux-musl.tar.gz -L
tar xzf pagefind.tar.gz
rm pagefind.tar.gz
mv pagefind /usr/bin
Expand Down
12 changes: 6 additions & 6 deletions content/components/sensor/xiaomi_ble.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
description: "Instructions for setting up Xiaomi Mi Home (Mijia) bluetooth-based sensors in ESPHome."
description: "Instructions for setting up Xiaomi Mi Home (Mijia) Bluetooth-based sensors in ESPHome."
title: "Xiaomi Mijia BLE Sensors"
params:
seo:
description: Instructions for setting up Xiaomi Mi Home (Mijia) bluetooth-based sensors in ESPHome.
description: Instructions for setting up Xiaomi Mi Home (Mijia) Bluetooth-based sensors in ESPHome.
image: xiaomi_mijia_logo.jpg
---

The `xiaomi_ble` sensor platform lets you track the output of Xiaomi Bluetooth Low Energy devices using the {{< docref "/components/esp32_ble_tracker" >}}. This component will track, for example, the temperature, humidity, moisture, conductivity, illuminance, formaldehyde, mosquito tablet and battery level of the device every time the sensor sends out a BLE broadcast. Contrary to other implementations, `xiaomi_ble` listens passively to advertisement packets and does not pair with the device. Hence ESPHome has no impact on battery life. Thus, if you only use such sensors, you can safely set `scan_parameters.active: false` in `esp32_ble_tracker` configuration, to save from spamming your RF environment with useless scan requests.

> [!NOTE]
> You may alternatively use ESPHome's {{< docref "/components/bluetooth_proxy" >}} component to forward sensor data to Home Assistant and have Mija devices configured using its own Mija BLE component. This should work for the devices flashed with [PVVX MiThermometer](https://github.com/pvvx/ATC_MiThermometer) custom firmware, as well as the regular, stock firmware.
> You may alternatively use ESPHome's {{< docref "/components/bluetooth_proxy" >}} component to forward sensor data to Home Assistant and have Mijia devices configured using its own Mijia BLE component. This should work for the devices flashed with [PVVX MiThermometer](https://github.com/pvvx/ATC_MiThermometer) custom firmware, as well as the regular, stock firmware.

## Supported Devices

Expand Down Expand Up @@ -582,7 +582,7 @@ To set up an encrypted device such as the LYWSD03MMC (with Xiaomi stock firmware

### LYWSD03MMC/MHO-C401

If the LYWSD03MMC or MHO-C401 sensor is operated with the Xiaomi stock firmware, you can use the [TeLink flasher application](https://atc1441.github.io/TelinkFlasher.html) to easily generate a new bind key and upload the key to the device without the need to flash a new firmware (see figure). For this, you load the flasher [webpage](https://atc1441.github.io/TelinkFlasher.html) with a [supported browser](https://github.com/WebBluetoothCG/web-bluetooth/blob/master/implementation-status.md) and connect the device by pressing "Connect". After the connection is established, you press the "Do Activation" button and the new key will be shown in the "Mi Bind Key" field. The key can be copied directly into the sensor YAML configuration.
If the LYWSD03MMC or MHO-C401 sensor is operated with the Xiaomi stock firmware, you can use the [TeLink flasher application](https://atc1441.github.io/TelinkFlasher.html) to easily generate a new bind key and upload the key to the device without the need to flash a new firmware (see figure). For this, you load the flasher [webpage](https://atc1441.github.io/TelinkFlasher.html) with a [supported browser](https://github.com/WebBluetoothCG/web-bluetooth/blob/main/implementation-status.md) and connect the device by pressing "Connect". After the connection is established, you press the "Do Activation" button and the new key will be shown in the "Mi Bind Key" field. The key can be copied directly into the sensor YAML configuration.

{{< img src="telink_flasher.jpg" alt="Image" caption="Telink flasher application." width="100.0%" class="align-center" >}}

Expand All @@ -593,7 +593,7 @@ If the LYWSD03MMC or MHO-C401 sensor is operated with the Xiaomi stock firmware,

The method to obtain a new bind key for the CGDK2 sensor is similar to the method for the LYWSD03MMC sensor, except a modified version of the flasher application is used.

For this, you load the [application](https://zaluthar.github.io/TelinkFlasher.html) with a [supported browser](https://github.com/WebBluetoothCG/web-bluetooth/blob/master/implementation-status.md) and connect the device by pressing "Connect". After the connection is established, you press the "Do Activation" button and the new key will be shown in the "Mi Bind Key" field. The key can be copied directly into the sensor YAML configuration.
For this, you load the [application](https://zaluthar.github.io/TelinkFlasher.html) with a [supported browser](https://github.com/WebBluetoothCG/web-bluetooth/blob/main/implementation-status.md) and connect the device by pressing "Connect". After the connection is established, you press the "Do Activation" button and the new key will be shown in the "Mi Bind Key" field. The key can be copied directly into the sensor YAML configuration.

### Other encrypted devices

Expand All @@ -613,7 +613,7 @@ For this, you load the [application](https://zaluthar.github.io/TelinkFlasher.ht
- Another option is to use a SSL packet sniffer. It can be setup on either an Android phone or the iPhone. Instructions how to obtain the
key using Android can be found in [in this tutorial](https://github.com/ahpohl/xiaomi_lywsd03mmc) on GitHub.
Instructions how to obtain the key using an iPhone can be found in
[custom-components/sensor.mitemp_bt](https://github.com/custom-components/sensor.mitemp_bt/blob/master/faq.md#my-sensors-ble-advertisements-are-encrypted-how-can-i-get-the-key)
[custom-components/ble_monitor](https://custom-components.github.io/ble_monitor/faq#encryption-keys)
on GitHub. Once the traffic between the Mi Home app and the Xiaomi servers has been recorded, the bind key will show in clear text:

```text
Expand Down
2 changes: 1 addition & 1 deletion content/guides/diy.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ unless it's truly exceptional, etc.
- [ESPHome configs](https://github.com/nuttytree/ESPHome-Devices) by {{< ghuser name="nuttytree" >}}
- [Control LG UD79-B monitor via UART](https://github.com/kquinsland/lg-m43mu79-esp-home-bridge) by {{< ghuser name="kquinsland" >}}
- [ESPHome AXA Remote 2 control](https://github.com/galagaking/espaxa/) by {{< ghuser name="galagaking" >}}
- [ESPHome WF-DS01 TuyaMCU based dimmable bedside touch lamp](https://github.com/davet2001/miscellaneous/blob/master/tuyamcu_ws-df01_touchlamp.yaml) by {{< ghuser name="davet2001" >}}
- [ESPHome WF-DS01 TuyaMCU based dimmable bedside touch lamp](https://github.com/davet2001/miscellaneous/blob/main/tuyamcu_ws-df01_touchlamp.yaml) by {{< ghuser name="davet2001" >}}
- [Universal menu system for devices with rotary encoder with push and SSD1306 I2C display](https://github.com/mikosoft83/pithy_screen_menu_system) by {{< ghuser name="mikosoft83" >}}
- [Show heart rate sensor values sent over Bluetooth Low Energy on a display](https://github.com/koenvervloesem/ESPHome-Heart-Rate-Display) by {{< ghuser name="koenvervloesem" >}}
- [ESPHome floor heating controller (proportional valves)](https://github.com/nliaudat/floor-heating-controller) by {{< ghuser name="nliaudat" >}}
Expand Down
2 changes: 1 addition & 1 deletion themes/esphome-theme/theme.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: ESPHome Theme
license: MIT
licenselink: https://github.com/esphome/esphome-docs/LICENSE.md
licenselink: https://github.com/esphome/esphome-docs/blob/current/LICENSE.md
description: Custom theme for ESPHome documentation
homepage: https://esphome.io/
tags:
Expand Down