ble_api/README.md

Xiaomii BLE Sensor API

Summary

This is an API for monitoring Temperature and Humidity data for Xiaomii LYWSD03MMC BLE sensors. The app will scan for any of these devices by looking for the Bluetooth MAC octet and then filtering by model. Once it has a list of MACs, it will then attempt to read the Temp/Humidity data for each MAC and record it. This data can be interacted with through an API.

Some product info can be found here at my Knowledgebase:

https://kb.matt-cloud.com/books/07-saved-articles/page/xiaomii-temperaturehumidity-sensor

Future Plans

Aside from a REST API, there are a few more features which need to be added to this app.

• REDIS function for Node.js Websocket support
  • In the end this will drive a web dashboard, and I want to be able to view live data on this dashboard
• Friendly Names for Sensors
  • There will be a variable added to the config.py file to pre-configure friendly names for specific MAC addresses.
  • For example, Living Room or Main Bedroom
  • This data will also be integrated into the API to replace the comment field
• Data persistence across app launches
  • I will do this with the Pickle package

API Details

There are several primary API endpoints with varying levels of details.

0.0.0.0:5000/macs is the endpoint for a simple list of MACs. This will return a list of MACs and a count.

{
  "count": 4,
  "macs": [
    "A4:C1:38:00:11:10",
    "A4:C1:38:00:11:11",
    "A4:C1:38:00:11:12",
    "A4:C1:38:00:11:13"
  ]
}

0.0.0.0:5000/summary will return a summary of devices and current data.

{
  "sensors": [
    {
      "comment": "A4:C1:38:00:11:10",
      "data": {
        "humidity": 50,
        "temp": 17.4
      },
      "name": "A4:C1:38:00:11:10"
    },
    {
      "comment": "A4:C1:38:00:11:11",
      "data": {
        "humidity": 50,
        "temp": 18.03
      },
      "name": "A4:C1:38:00:11:11"
    },
    {
      "comment": "A4:C1:38:00:11:12",
      "data": {
        "humidity": 49,
        "temp": 17.99
      },
      "name": "A4:C1:38:00:11:12"
    },
    {
      "comment": "A4:C1:38:00:11:13",
      "data": {
        "humidity": 49,
        "temp": 18.12
      },
      "name": "A4:C1:38:00:11:13"
    }
  ]
}

0.0.0.0:5000/details returns the summary info along with timestamps for first seen and last seen dates for each MAC and each data.

{
  "sensors": [
    {
      "comment": "A4:C1:38:100:11:10",
      "data": {
        "data": [
          {
            "first_seen": 1791856362,
            "last_seen": 1791882172,
            "name": "temp",
            "value": 17.4
          },
          {
            "first_seen": 1791856362,
            "last_seen": 1791882172,
            "name": "humidity",
            "value": 50
          }
        ]
      },
      "first_seen": 1791856072,
      "last_seen": 1791882172,
      "name": "A4:C1:38:100:11:10"
    },
    {
      "comment": "A4:C1:38:00:11:11",
      "data": {
        "data": [
          {
            "first_seen": 1791856362,
            "last_seen": 1791882239,
            "name": "temp",
            "value": 17.97
          },
          {
            "first_seen": 1791856362,
            "last_seen": 1791882239,
            "name": "humidity",
            "value": 50
          }
        ]
      },
      "first_seen": 1791856072,
      "last_seen": 1791882239,
      "name": "A4:C1:38:00:11:11"
    },
    {
      "comment": "A4:C1:38:00:11:12",
      "data": {
        "data": [
          {
            "first_seen": 1791856300,
            "last_seen": 1791882239,
            "name": "temp",
            "value": 17.97
          },
          {
            "first_seen": 1791856300,
            "last_seen": 1791882239,
            "name": "humidity",
            "value": 50
          }
        ]
      },
      "first_seen": 1791856072,
      "last_seen": 1791882239,
      "name": "A4:C1:38:00:11:12"
    },
    {
      "comment": "A4:C1:38:00:11:13",
      "data": {
        "data": [
          {
            "first_seen": 1791856224,
            "last_seen": 1791882239,
            "name": "temp",
            "value": 18.07
          },
          {
            "first_seen": 1791856224,
            "last_seen": 1791882239,
            "name": "humidity",
            "value": 49
          }
        ]
      },
      "first_seen": 1791856072,
      "last_seen": 1791882239,
      "name": "A4:C1:38:00:11:13"
    }
  ]
}

File Structure

The Python code is split across multiple files with different files having code for different areas of need.

ble-scanner/
├─ app.py                 # Flask + Scheduler + API
├─ ble.py                 # BLE helper functions to read temp+humidity data
├─ scanner.py             # Async BLE scan + cache logic
├─ config.py              # Shared constants (prefix, interval, etc.)
├─ requirements.txt       # Python VENV requirements
├─ run.sh                 # Run API from shell
├─ scanner.py             # Handles scanning for Mii sensors, other helper functions
├─ sensors.py             # Object classifier
└─ README.md