https://github.com/piger/sensor-probe

capture sensor data from Xiaomi thermometers (via BLE) and expose it as prometheus metrics
https://github.com/piger/sensor-probe

diy homekit sensors timescaledb xiaomi

Last synced: about 5 hours ago
JSON representation

capture sensor data from Xiaomi thermometers (via BLE) and expose it as prometheus metrics

• Host: GitHub
• URL: https://github.com/piger/sensor-probe
• Owner: piger
• Created: 2021-12-13T02:38:49.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T23:19:08.000Z (11 months ago)
• Last Synced: 2024-06-20T11:53:14.290Z (5 months ago)
• Topics: diy, homekit, sensors, timescaledb, xiaomi
• Language: Go
• Homepage:
• Size: 120 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sensor-probe

Sensor Probe is a small utility that reads advertisement data sent by the

[Xiaomi Thermometer LYWSD03MMC](https://buy.mi.com/uk/item/3204500023) via Bluetooth LE and expose them as Prometheus metrics.

This program currently only supports sensors flashed with the [ATC_MiThermometer](https://github.com/atc1441/ATC_MiThermometer) custom firmware and the "custom" data format; if you're using the [other](https://github.com/pvvx/ATC_MiThermometer) custom firmware you

can probably just use Bluewalker to get your sensor data.

All the heavy lifting is done by [Bluewalker](https://gitlab.com/jtaimisto/bluewalker/) since I couldn't find

an easy way to read BLE events from Go and the BlueZ stack on Linux.

You should be able to find those Xiaomi sensors on [AliExpress](https://s.click.aliexpress.com/e/_AKXfnI).

## Configuration format

The configuration file is a simple TOML file:

```toml

[[sensors]]

    name = "bedroom"

    mac = "a4:c1:38:01:01:01"

    firmware = "custom"

[[sensors]]

    name = "studio"

    mac = "a4:c1:38:02:02:02"

    firmware = "custom"

```

## Usage

First you need to bring down your Bluetooth device by running `hciconfig`:

```

sudo hciconfig hci0 down

```

Then you can start `sensor-probe`.

## Credits

- The [Humidity Control with Home Assistant](https://www.splitbrain.org/blog/2021-08/16-humidity_control_with_home_assistant) blog post

on Splitbrain.org that made me discover those Xiaomi sensors.

- [atc1441](https://github.com/atc1441) for writing the [custom firmware](https://github.com/atc1441/ATC_MiThermometer) for the Xiaomi sensors.

- [Jukka Taimisto](https://gitlab.com/jtaimisto) for writing [Bluewalker](https://gitlab.com/jtaimisto/bluewalker/).