Xiaomi refactor (#361)
* refactored xiaomi sensors * sorted xiaomi sensor alphabetically * updated xiaomi docs to mention marketing names * fixed old changelog * fix ref links * fix bar length
This commit is contained in:
Alexander Leisentritt
Otto Winter
parent
8834354dd8
commit
9ff3e95aab
|
|
@ -25,8 +25,8 @@ Version 1.8.0
|
|||
RDM6300, components/binary_sensor/rdm6300, rdm6300.jpg
|
||||
|
||||
BLE RSSI, components/sensor/ble_rssi, bluetooth.svg
|
||||
Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg
|
||||
Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg
|
||||
Xiaomi HHCCJCY01, components/sensor/xiaomi_hhccjcy01, xiaomi_hhccjcy01.jpg
|
||||
Xiaomi LYWSDCGQ, components/sensor/xiaomi_lywsdcgq, xiaomi_lywsdcgq.jpg
|
||||
|
||||
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg
|
||||
HX711, components/sensor/hx711, hx711.jpg
|
||||
|
|
@ -55,7 +55,7 @@ This release mainly focuses on these new features:
|
|||
of bugs with a lot of integrations.
|
||||
- :doc:`Displays! </components/display/index>`
|
||||
- NFC/RFID Readers (:doc:`PN532 </components/binary_sensor/pn532>` and :doc:`RDM6300 </components/binary_sensor/rdm6300>`)
|
||||
- New :doc:`ESP32 BLE integrations </components/esp32_ble_tracker>` like :doc:`Xiaomi MiFlora </components/sensor/xiaomi_miflora>`
|
||||
- New :doc:`ESP32 BLE integrations </components/esp32_ble_tracker>` like :doc:`Xiaomi HHCCJCY01 </components/sensor/xiaomi_hhccjcy01>`
|
||||
- Core Changes like the addition of the :ref:`SPI bus <spi>` and :ref:`UART bus <uart>`
|
||||
- Lots of new :ref:`light effects <light-effects>` and support for cold-white/warm-white lights.
|
||||
- A LOGO FOR THIS PROJECT!!! Thanks a lot to `@messimore <https://github.com/messismore>`__ for
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 9.0 KiB After Width: | Height: | Size: 9.0 KiB |
|
|
@ -1,24 +1,24 @@
|
|||
Xiaomi ClearGrass BLE Sensor
|
||||
============================
|
||||
Xiaomi CGG1 BLE Sensor
|
||||
======================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Xiaomi ClearGrass E-Ink bluetooth-based temperature and humidity sensors in ESPHome.
|
||||
:image: xiaomi_cleargrass.jpg
|
||||
:keywords: Xiaomi, ClearGrass, BLE, E-Ink, Bluetooth
|
||||
:description: Instructions for setting up Xiaomi ClearGrass CGG1 E-Ink bluetooth-based temperature and humidity sensors in ESPHome.
|
||||
:image: xiaomi_cgg1.jpg
|
||||
:keywords: Xiaomi, ClearGrass, BLE, E-Ink, Bluetooth, CGG1
|
||||
|
||||
The ``xiaomi_cleargrass`` sensor platform lets you track the output of Xiaomi ClearGrass Bluetooth
|
||||
The ``xiaomi_cgg1`` sensor platform lets you track the output of Xiaomi CGG1 Bluetooth
|
||||
Low Energy devices using the :doc:`/components/esp32_ble_tracker`. This component will track the
|
||||
temperature, humidity and optionally the battery level of the ClearGrass device every time the
|
||||
temperature, humidity and optionally the battery level of the CGG1 device every time the
|
||||
sensor sends out a BLE broadcast. Note that contrary to other implementations, ESPHome can track as
|
||||
many ClearGrass devices at once as you want.
|
||||
many CGG1 devices at once as you want.
|
||||
|
||||
.. figure:: images/xiaomi_cleargrass-full.jpg
|
||||
.. figure:: images/xiaomi_cgg1-full.jpg
|
||||
:align: center
|
||||
:width: 80.0%
|
||||
|
||||
Xiaomi ClearGrass Temperature and Humidity Sensor over BLE.
|
||||
Xiaomi CGG1 Temperature and Humidity Sensor over BLE.
|
||||
|
||||
.. figure:: images/xiaomi_cleargrass-ui.jpg
|
||||
.. figure:: images/xiaomi_cgg1-ui.jpg
|
||||
:align: center
|
||||
:width: 80.0%
|
||||
|
||||
|
|
@ -28,19 +28,19 @@ many ClearGrass devices at once as you want.
|
|||
esp32_ble_tracker:
|
||||
|
||||
sensor:
|
||||
- platform: xiaomi_cleargrass
|
||||
- platform: xiaomi_cgg1
|
||||
mac_address: 7A:80:8E:19:36:BA
|
||||
temperature:
|
||||
name: "Xiaomi ClearGrass Temperature"
|
||||
name: "Xiaomi CGG1 Temperature"
|
||||
humidity:
|
||||
name: "Xiaomi ClearGrass Humidity"
|
||||
name: "Xiaomi CGG1 Humidity"
|
||||
battery_level:
|
||||
name: "Xiaomi ClearGrass Battery Level"
|
||||
name: "Xiaomi CGG1 Battery Level"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **mac_address** (**Required**, MAC Address): The MAC address of the Xiaomi ClearGrass device.
|
||||
- **mac_address** (**Required**, MAC Address): The MAC address of the Xiaomi CGG1 device.
|
||||
- **temperature** (*Optional*): The information for the temperature sensor.
|
||||
|
||||
- **name** (**Required**, string): The name for the temperature sensor.
|
||||
|
|
@ -63,8 +63,8 @@ Configuration variables:
|
|||
Setting Up Devices
|
||||
------------------
|
||||
|
||||
To set up Xiaomi ClearGrass devices you first need to find their MAC Address so that ESPHome can
|
||||
identify them. So first, create a simple configuration without any ``xiaomi_cleargrass`` entries
|
||||
To set up Xiaomi CGG1 devices you first need to find their MAC Address so that ESPHome can
|
||||
identify them. So first, create a simple configuration without any ``xiaomi_cgg1`` entries
|
||||
like so:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
|
@ -72,17 +72,17 @@ like so:
|
|||
esp32_ble_tracker:
|
||||
|
||||
After uploading the ESP32 will immediately try to scan for BLE devices such as the Xiaomi
|
||||
ClearGrass. When it detects these sensors, it will automatically parse the BLE message print a
|
||||
CGG1. When it detects these sensors, it will automatically parse the BLE message print a
|
||||
message like this one:
|
||||
|
||||
.. code::
|
||||
|
||||
Xiaomi ClearGrass 7A:80:8E:19:36:BA Got temperature=23.4°C, humidity=65.0%
|
||||
Got Xiaomi CGG1 7A:80:8E:19:36:BA Got temperature=23.4°C, humidity=65.0%
|
||||
|
||||
Note that it can sometimes take some time for the first BLE broadcast to be received. You can speed
|
||||
up the process by pressing the grey bluetooth button on the back of the device.
|
||||
|
||||
Then just copy the address (``7A:80:8E:19:36:BA``) into a new ``sensor.xiaomi_cleargrass`` platform
|
||||
Then just copy the address (``7A:80:8E:19:36:BA``) into a new ``sensor.xiaomi_cgg1`` platform
|
||||
entry like in the configuration example at the top.
|
||||
|
||||
.. note::
|
||||
|
|
@ -94,11 +94,11 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`/components/esp32_ble_tracker`
|
||||
- :doc:`/components/sensor/xiaomi_mijia`
|
||||
- :doc:`/components/sensor/xiaomi_miflora`
|
||||
- :doc:`/components/sensor/xiaomi_lywsdcgq`
|
||||
- :doc:`/components/sensor/xiaomi_hhccjcy01`
|
||||
- :doc:`/components/sensor/xiaomi_lywsd02`
|
||||
- :doc:`/components/sensor/index`
|
||||
- :apiref:`xiaomi_cleargrass/xiaomi_cleargrass.h`
|
||||
- :apiref:`xiaomi_cgg1/xiaomi_cgg1.h`
|
||||
- `Xiaomi Mijia BLE protocol <https://github.com/mspider65/Xiaomi-Mijia-Bluetooth-Temperature-and-Humidity-Sensor>`__
|
||||
by `@mspider65 <https://github.com/mspider65>`__
|
||||
- `OpenMQTTGateway <https://github.com/1technophile/OpenMQTTGateway>`__ by `@1technophile <https://github.com/1technophile>`__
|
||||
|
|
@ -1,16 +1,16 @@
|
|||
Xiaomi MiFlora BLE Sensor
|
||||
=========================
|
||||
Xiaomi HHCCJCY01 BLE Sensor
|
||||
===========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Xiaomi Mi Flora bluetooth-based plant monitors in ESPHome.
|
||||
:image: xiaomi_miflora.jpg
|
||||
:keywords: Xiaomi, Mi Flora, BLE, Bluetooth
|
||||
:description: Instructions for setting up Xiaomi Mi Flora HHCCJCY01 bluetooth-based plant monitors in ESPHome.
|
||||
:image: xiaomi_hhccjcy01.jpg
|
||||
:keywords: Xiaomi, Mi Flora, BLE, Bluetooth, HHCCJCY01
|
||||
|
||||
The ``xiaomi_miflora`` sensor platform lets you track the output of Xiaomi MiFlora Bluetooth Low Energy
|
||||
The ``xiaomi_hhccjcy01`` sensor platform lets you track the output of Xiaomi HHCCJCY01 Bluetooth Low Energy
|
||||
devices using the :doc:`/components/esp32_ble_tracker`. This component will track the
|
||||
temperature, humidity and optionally the battery level of the MiFlora device every time the sensor
|
||||
temperature, humidity and optionally the battery level of the HHCCJCY01 device every time the sensor
|
||||
sends out a BLE broadcast. Note that contrary to other implementations, ESPHome can track as many
|
||||
MiFlora devices at once as you want.
|
||||
HHCCJCY01 devices at once as you want.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
|
@ -18,23 +18,23 @@ MiFlora devices at once as you want.
|
|||
esp32_ble_tracker:
|
||||
|
||||
sensor:
|
||||
- platform: xiaomi_miflora
|
||||
- platform: xiaomi_hhccjcy01
|
||||
mac_address: '94:2B:FF:5C:91:61'
|
||||
temperature:
|
||||
name: "Xiaomi MiFlora Temperature"
|
||||
name: "Xiaomi HHCCJCY01 Temperature"
|
||||
moisture:
|
||||
name: "Xiaomi MiFlora Moisture"
|
||||
name: "Xiaomi HHCCJCY01 Moisture"
|
||||
illuminance:
|
||||
name: "Xiaomi MiFlora Illuminance"
|
||||
name: "Xiaomi HHCCJCY01 Illuminance"
|
||||
conductivity:
|
||||
name: "Xiaomi MiFlora Soil Conductivity"
|
||||
name: "Xiaomi HHCCJCY01 Soil Conductivity"
|
||||
battery_level:
|
||||
name: "Xiaomi MiFlora Battery Level"
|
||||
name: "Xiaomi HHCCJCY01 Battery Level"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **mac_address** (**Required**, MAC Address): The MAC address of the Xiaomi MiFlora device.
|
||||
- **mac_address** (**Required**, MAC Address): The MAC address of the Xiaomi HHCCJCY01 device.
|
||||
- **temperature** (*Optional*): The information for the temperature sensor.
|
||||
|
||||
- **name** (**Required**, string): The name for the temperature sensor.
|
||||
|
|
@ -67,7 +67,7 @@ Configuration variables:
|
|||
|
||||
.. note::
|
||||
|
||||
This integration requires the MiFlora device to have a recent firmware version, see
|
||||
This integration requires the device to have a recent firmware version, see
|
||||
https://github.com/esphome/issues/issues/260#issuecomment-487684720 for more info.
|
||||
|
||||
The ``battery_level`` does not appear to work with some firmware versions of the device (the other sensors
|
||||
|
|
@ -76,25 +76,25 @@ Configuration variables:
|
|||
Setting Up Devices
|
||||
------------------
|
||||
|
||||
Before you can even scan for the MiFlora sensor, you need to activate it using the Flower Care app. Set it up there and you'll be able to discover it.
|
||||
Before you can even scan for the sensor, you need to activate it using the Flower Care app. Set it up there and you'll be able to discover it.
|
||||
|
||||
To set up Xiaomi MiFlora devices you first need to find their MAC Address so that ESPHome can
|
||||
identify them. So first, create a simple configuration without any ``xiaomi_miflora`` entries like so:
|
||||
To set up Xiaomi HHCCJCY01 devices you first need to find their MAC Address so that ESPHome can
|
||||
identify them. So first, create a simple configuration without any ``xiaomi_hhccjcy01`` entries like so:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
esp32_ble_tracker:
|
||||
|
||||
After uploading the ESP32 will immediately try to scan for BLE devices such as the Xiaomi MiFlora. When
|
||||
After uploading the ESP32 will immediately try to scan for BLE devices such as the Xiaomi HHCCJCY01. When
|
||||
it detects these sensors, it will automatically parse the BLE message print a message like this one:
|
||||
|
||||
.. code::
|
||||
|
||||
Xiaomi MiFlora 94:2B:FF:5C:91:61 Got temperature=23.4°C
|
||||
Got Xiaomi HHCCJCY01 94:2B:FF:5C:91:61 Got temperature=23.4°C
|
||||
|
||||
Note that it can sometimes take some time for the first BLE broadcast to be received.
|
||||
|
||||
Then just copy the address (``94:2B:FF:5C:91:61``) into a new ``sensor.xiaomi_miflora`` platform entry like
|
||||
Then just copy the address (``94:2B:FF:5C:91:61``) into a new ``sensor.xiaomi_hhccjcy01`` platform entry like
|
||||
in the configuration example at the top.
|
||||
|
||||
.. note::
|
||||
|
|
@ -106,8 +106,8 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`/components/esp32_ble_tracker`
|
||||
- :doc:`/components/sensor/xiaomi_mijia`
|
||||
- :doc:`/components/sensor/xiaomi_lywsdcgq`
|
||||
- :doc:`/components/sensor/index`
|
||||
- :apiref:`xiaomi_miflora/xiaomi_miflora.h`
|
||||
- :apiref:`xiaomi_hhccjcy01/xiaomi_hhccjcy01.h`
|
||||
- `OpenMQTTGateway <https://github.com/1technophile/OpenMQTTGateway>`__ by `@1technophile <https://github.com/1technophile>`__
|
||||
- :ghedit:`Edit`
|
||||
|
|
@ -83,8 +83,8 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`/components/esp32_ble_tracker`
|
||||
- :doc:`/components/sensor/xiaomi_mijia`
|
||||
- :doc:`/components/sensor/xiaomi_miflora`
|
||||
- :doc:`/components/sensor/xiaomi_lywsdcgq`
|
||||
- :doc:`/components/sensor/xiaomi_hhccjcy01`
|
||||
- :doc:`/components/sensor/index`
|
||||
- :apiref:`xiaomi_lywsd02/xiaomi_lywsd02.h`
|
||||
- `Xiaomi Mijia BLE protocol <https://github.com/mspider65/Xiaomi-Mijia-Bluetooth-Temperature-and-Humidity-Sensor>`__
|
||||
|
|
|
|||
|
|
@ -1,24 +1,24 @@
|
|||
Xiaomi MiJia BLE Sensor
|
||||
=======================
|
||||
Xiaomi LYWSDCGQ BLE Sensor
|
||||
==========================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up Xiaomi Mi Jia bluetooth-based temperature and humidity sensors in ESPHome.
|
||||
:image: xiaomi_miflora.jpg
|
||||
:keywords: Xiaomi, Mi Jia, BLE, Bluetooth
|
||||
:description: Instructions for setting up Xiaomi Mi Jia LYWSDCGQ bluetooth-based temperature and humidity sensors in ESPHome.
|
||||
:image: xiaomi_lywsdcgq.jpg
|
||||
:keywords: Xiaomi, Mi Jia, BLE, Bluetooth, LYWSDCGQ
|
||||
|
||||
The ``xiaomi_mijia`` sensor platform lets you track the output of Xiaomi MiJia Bluetooth Low Energy
|
||||
The ``xiaomi_lywsdcgq`` sensor platform lets you track the output of Xiaomi LYWSDCGQ Bluetooth Low Energy
|
||||
devices using the :doc:`/components/esp32_ble_tracker`. This component will track the
|
||||
temperature, humidity and optionally the battery level of the MiJia device every time the sensor
|
||||
temperature, humidity and optionally the battery level of the device every time the sensor
|
||||
sends out a BLE broadcast. Note that contrary to other implementations, ESPHome can track as many
|
||||
MiJia devices at once as you want.
|
||||
LYWSDCGQ devices at once as you want.
|
||||
|
||||
.. figure:: images/xiaomi_mijia-full.jpg
|
||||
.. figure:: images/xiaomi_lywsdcgq-full.jpg
|
||||
:align: center
|
||||
:width: 60.0%
|
||||
|
||||
Xiaomi MiJia Temperature and Humidity Sensor over BLE.
|
||||
Xiaomi Temperature and Humidity Sensor over BLE.
|
||||
|
||||
.. figure:: images/xiaomi_mijia-ui.png
|
||||
.. figure:: images/xiaomi_lywsdcgq-ui.png
|
||||
:align: center
|
||||
:width: 80.0%
|
||||
|
||||
|
|
@ -28,19 +28,19 @@ MiJia devices at once as you want.
|
|||
esp32_ble_tracker:
|
||||
|
||||
sensor:
|
||||
- platform: xiaomi_mijia
|
||||
- platform: xiaomi_lywsdcgq
|
||||
mac_address: 7A:80:8E:19:36:BA
|
||||
temperature:
|
||||
name: "Xiaomi MiJia Temperature"
|
||||
name: "Xiaomi LYWSDCGQ Temperature"
|
||||
humidity:
|
||||
name: "Xiaomi MiJia Humidity"
|
||||
name: "Xiaomi LYWSDCGQ Humidity"
|
||||
battery_level:
|
||||
name: "Xiaomi MiJia Battery Level"
|
||||
name: "Xiaomi LYWSDCGQ Battery Level"
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **mac_address** (**Required**, MAC Address): The MAC address of the Xiaomi MiJia device.
|
||||
- **mac_address** (**Required**, MAC Address): The MAC address of the Xiaomi LYWSDCGQ device.
|
||||
- **temperature** (*Optional*): The information for the temperature sensor.
|
||||
|
||||
- **name** (**Required**, string): The name for the temperature sensor.
|
||||
|
|
@ -63,24 +63,24 @@ Configuration variables:
|
|||
Setting Up Devices
|
||||
------------------
|
||||
|
||||
To set up Xiaomi MiJia devices you first need to find their MAC Address so that ESPHome can
|
||||
identify them. So first, create a simple configuration without any ``xiaomi_mijia`` entries like so:
|
||||
To set up Xiaomi LYWSDCGQ devices you first need to find their MAC Address so that ESPHome can
|
||||
identify them. So first, create a simple configuration without any ``xiaomi_lywsdcgq`` entries like so:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
esp32_ble_tracker:
|
||||
|
||||
After uploading the ESP32 will immediately try to scan for BLE devices such as the Xiaomi MiJia. When
|
||||
After uploading the ESP32 will immediately try to scan for BLE devices such as the Xiaomi LYWSDCGQ. When
|
||||
it detects these sensors, it will automatically parse the BLE message print a message like this one:
|
||||
|
||||
.. code::
|
||||
|
||||
Xiaomi MiJia 7A:80:8E:19:36:BA Got temperature=23.4°C, humidity=65.0%
|
||||
Got Xiaomi LYWSDCGQ 7A:80:8E:19:36:BA Got temperature=23.4°C, humidity=65.0%
|
||||
|
||||
Note that it can sometimes take some time for the first BLE broadcast to be received. You can speed up
|
||||
the process by pressing the grey bluetooth button on the back of the device.
|
||||
|
||||
Then just copy the address (``7A:80:8E:19:36:BA``) into a new ``sensor.xiaomi_mijia`` platform entry like
|
||||
Then just copy the address (``7A:80:8E:19:36:BA``) into a new ``sensor.xiaomi_lywsdcgq`` platform entry like
|
||||
in the configuration example at the top.
|
||||
|
||||
.. note::
|
||||
|
|
@ -92,9 +92,9 @@ See Also
|
|||
--------
|
||||
|
||||
- :doc:`/components/esp32_ble_tracker`
|
||||
- :doc:`/components/sensor/xiaomi_miflora`
|
||||
- :doc:`/components/sensor/xiaomi_hhccjcy01`
|
||||
- :doc:`/components/sensor/index`
|
||||
- :apiref:`xiaomi_mijia/xiaomi_mijia.h`
|
||||
- :apiref:`xiaomi_lywsdcgq/xiaomi_lywsdcgq.h`
|
||||
- `Xiaomi Mijia BLE protocol <https://github.com/mspider65/Xiaomi-Mijia-Bluetooth-Temperature-and-Humidity-Sensor>`__
|
||||
by `@mspider65 <https://github.com/mspider65>`__
|
||||
- `OpenMQTTGateway <https://github.com/1technophile/OpenMQTTGateway>`__ by `@1technophile <https://github.com/1technophile>`__
|
||||
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 6.8 KiB After Width: | Height: | Size: 6.8 KiB |
|
|
@ -140,10 +140,10 @@ Sensor Components
|
|||
Ultrasonic Sensor, components/sensor/ultrasonic, ultrasonic.jpg
|
||||
Uptime Sensor, components/sensor/uptime, timer.svg
|
||||
WiFi Signal Strength, components/sensor/wifi_signal, network-wifi.svg
|
||||
Xiaomi MiFlora, components/sensor/xiaomi_miflora, xiaomi_miflora.jpg
|
||||
Xiaomi MiJia, components/sensor/xiaomi_mijia, xiaomi_mijia.jpg
|
||||
Xiaomi CGG1, components/sensor/xiaomi_cgg1, xiaomi_cgg1.jpg
|
||||
Xiaomi HHCCJCY01, components/sensor/xiaomi_hhccjcy01, xiaomi_hhccjcy01.jpg
|
||||
Xiaomi LYWSD02, components/sensor/xiaomi_lywsd02, xiaomi_lywsd02.jpg
|
||||
Xiaomi ClearGrass, components/sensor/xiaomi_cleargrass, xiaomi_cleargrass.jpg
|
||||
Xiaomi LYWSDCGQ, components/sensor/xiaomi_lywsdcgq, xiaomi_lywsdcgq.jpg
|
||||
ZyAura, components/sensor/zyaura, zgm053.jpg
|
||||
Custom Sensor, components/sensor/custom, language-cpp.svg
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue