diff --git a/components/sensor/images/inkbird_isbth1_mini-full.jpg b/components/sensor/images/inkbird_isbth1_mini-full.jpg new file mode 100644 index 000000000..e34559a40 Binary files /dev/null and b/components/sensor/images/inkbird_isbth1_mini-full.jpg differ diff --git a/components/sensor/images/inkbird_isbth1_mini-ui.png b/components/sensor/images/inkbird_isbth1_mini-ui.png new file mode 100644 index 000000000..e12eb9496 Binary files /dev/null and b/components/sensor/images/inkbird_isbth1_mini-ui.png differ diff --git a/components/sensor/images/inkbird_isbth1_mini.png b/components/sensor/images/inkbird_isbth1_mini.png new file mode 100644 index 000000000..1e21a6f63 Binary files /dev/null and b/components/sensor/images/inkbird_isbth1_mini.png differ diff --git a/components/sensor/inkbird_ibsth1_mini.rst b/components/sensor/inkbird_ibsth1_mini.rst new file mode 100644 index 000000000..03cc6bfb2 --- /dev/null +++ b/components/sensor/inkbird_ibsth1_mini.rst @@ -0,0 +1,103 @@ +Inkbird IBS-TH1 Mini BLE Sensor +=============================== + +.. seo:: + :description: Instructions for setting up Inkbird IBS-TH1 Mini Bluetooth-based temperature and humidity sensors in ESPHome. + :image: inkbird_isbth1_mini.jpg + :keywords: Inkbird, BLE, Bluetooth, IBS-TH1 + +The ``inkbird_ibsth1_mini`` sensor platform lets you track the output of Inkbird IBS-TH1 Mini Bluetooth +Low Energy devices using the :doc:`/components/esp32_ble_tracker`. This component will track the +temperature, humidity and the battery level of the IBS-TH1 Mini device every time the +sensor sends out a BLE broadcast. Note that contrary to other implementations, ESPHome can track as +many IBS-TH1 Mini devices at once as you want. + +.. figure:: images/inkbird_isbth1_mini-full.jpg + :align: center + :width: 80.0% + + Inkbird IBS-TH1 Mini Temperature and Humidity Sensor over BLE. + +.. figure:: images/inkbird_isbth1_mini-ui.png + :align: center + :width: 80.0% + +.. code-block:: yaml + + # Example configuration entry + esp32_ble_tracker: + + sensor: + - platform: inkbird_ibsth1_mini + mac_address: 38:81:D7:0A:9C:11 + temperature: + name: "Inkbird IBS-TH1 Mini Temperature" + humidity: + name: "Inkbird IBS-TH1 Mini Humidity" + battery_level: + name: "Inkbird IBS-TH1 Mini Battery Level" + +Configuration variables: +------------------------ + +- **mac_address** (**Required**, MAC Address): The MAC address of the Inkbird IBS-TH1 Mini device. +- **temperature** (*Optional*): The information for the temperature sensor. + + - **name** (**Required**, string): The name for the temperature sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **humidity** (*Optional*): The information for the humidity sensor + + - **name** (**Required**, string): The name for the humidity sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + +- **battery_level** (*Optional*): The information for the battery level sensor + + - **name** (**Required**, string): The name for the battery level sensor. + - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. + - All other options from :ref:`Sensor `. + + +Setting Up Devices +------------------ + +To set up Inkbird IBS-TH1 Mini devices you first need to find their MAC Address so that ESPHome can +identify them. So first, create a simple configuration without any ``inkbird_ibsth1_mini`` entries +like so: + +.. code-block:: yaml + + esp32_ble_tracker: + +After uploading the ESP32 will immediately try to scan for BLE devices such as the Inkbird IBS-TH1 Mini. +When it detects these sensors, it will automatically parse the BLE message print a +message like this one: + +.. code:: + + [13:36:43][D][esp32_ble_tracker:544]: Found device 38:81:D7:0A:9C:11 RSSI=-53 + [13:36:43][D][esp32_ble_tracker:565]: Address Type: PUBLIC + [13:36:43][D][esp32_ble_tracker:567]: Name: 'sps' + +Note that it can sometimes take some time for the first BLE broadcast to be received. Please note that address type +should say 'PUBLIC' and the device name should be 'sps', this is how you find the Inkbird IBS-TH1 Mini among all the +other devices. + +Then just copy the address (``38:81:D7:0A:9C:11``) into a new ``sensor.inkbird_ibsth1_mini`` platform +entry like in the configuration example at the top. + +.. note:: + + The ESPHome Inkbird IBS-TH1 Mini integration listens passively to packets the device sends by itself. + ESPHome therefore has no impact on the battery life of the device. + +See Also +-------- + +- :doc:`/components/esp32_ble_tracker` +- :doc:`/components/sensor/index` +- :apiref:`inkbird_ibsth1_mini/inkbird_ibsth1_mini.h` +- `OpenMQTTGateway `__ by `@1technophile `__ +- :ghedit:`Edit` diff --git a/images/inkbird_isbth1_mini.jpg b/images/inkbird_isbth1_mini.jpg new file mode 100644 index 000000000..b7aa22837 Binary files /dev/null and b/images/inkbird_isbth1_mini.jpg differ diff --git a/index.rst b/index.rst index bffba46ef..8a79031b8 100644 --- a/index.rst +++ b/index.rst @@ -126,6 +126,7 @@ Sensor Components INA219, components/sensor/ina219, ina219.jpg INA226, components/sensor/ina226, ina226.jpg INA3221, components/sensor/ina3221, ina3221.jpg + Inkbird IBS-TH1 Mini, components/sensor/inkbird_ibsth1_mini, inkbird_isbth1_mini.jpg Integration, components/sensor/integration, sigma.svg HTU21D, components/sensor/htu21d, htu21d.jpg HM3301, components/sensor/hm3301, hm3301.jpg