temperature-sensor-scanner 1.0.0__tar.gz

temperature_sensor_scanner-1.0.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,79 @@
+name: Publish to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution
+    if: startsWith(github.ref, 'refs/tags/')  # only build on tag pushes
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f  # v7.0.0
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/temperature-sensor-scanner
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e  # v1.13.0
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/temperature-sensor-scanner
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e  # v1.13.0
+        with:
+          repository-url: https://test.pypi.org/legacy/

temperature_sensor_scanner-1.0.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: temperature-sensor-scanner
+Version: 1.0.0
+Summary: A tool to collect data from temperature sensors and emit it into InfluxDB
+Project-URL: Homepage, https://github.com/gene1wood/temperature-sensor-scanner
+Project-URL: Repository, https://github.com/gene1wood/temperature-sensor-scanner
+Author-email: Gene Wood <gene_wood@cementhorizon.com>
+License: GPL-3.0-or-later
+Requires-Python: >=3.10
+Requires-Dist: atc-mi-interface
+Requires-Dist: bleak
+Requires-Dist: influxdb-client
+Requires-Dist: platformdirs
+Requires-Dist: pyyaml
+Description-Content-Type: text/markdown
+
+# temperature-sensor-scanner
+
+A tool to scan nearby Bluetooth Low Energy thermometers on the Telink chipset, collect the data ane emit it into
+InfluxDB.
+
+## Setup
+
+* Create an influxdb user with a command like `influx user create --org [my-org] --name [my-username] --password [my-password]`
+* Create an influxdb token with a command like `influx auth create --org [my-org] --user [my-username] --write-bucket [my-bucket-id]`
+* Create a `config.yaml` in `~/.config/temperature-sensor-scanner/` based on the `config.example.yaml` file
+* Install this tool with a command like `pip install temperature-sensor-scanner`
+
+## Usage
+
+Run `temperature-sensor-scanner` which will scan for nearby sensors which are emitting temperature data in their Bluetooth
+advertising string, collect that data, and emit it into InfluxDB.
+
+# Notes
+
+* https://github.com/pvvx/ATC_MiThermometer/
+* https://pvvx.github.io/ATC_MiThermometer/TelinkMiFlasher.html
+  * Launch in Chrome instead of Firefox
+* Other tools that look interesting
+  * https://github.com/JsBergbau/MiTemperature2
+
+## Steps to provision a new sensor
+
+* [Flash the firmware](https://github.com/pvvx/ATC_MiThermometer/?tab=readme-ov-file#flashing-or-updating-the-firmware-ota)
+  * Click `Connect`
+  * Select the `LYWSD03MMC` Bluetooth device in the menu
+  * Click `Do Activation`
+  * Choose `Custom Firmware ATC_v56.bin`
+  * Click `Start Flashing`
+  * Wait 42 seconds for it to show update done
+* Identify ID from Bluetooth announced name and print a label to put on the sensor
+* Quit Chrome and start again
+* [Configure sensor](https://github.com/pvvx/ATC_MiThermometer/?tab=readme-ov-file#configuration)
+  * Set display to Farenheight
+  * Click `Set Time`
+  * Set advertising type to `ATC1441`
+  * Set advertising interval to `10000` ( https://github.com/pvvx/ATC_MiThermometer/issues/23#issuecomment-766898945 )
+  * Set Measure interval: to 10
+  * Click `Send Config`

temperature_sensor_scanner-1.0.0/README.md

@@ -0,0 +1,43 @@
+# temperature-sensor-scanner
+
+A tool to scan nearby Bluetooth Low Energy thermometers on the Telink chipset, collect the data ane emit it into
+InfluxDB.
+
+## Setup
+
+* Create an influxdb user with a command like `influx user create --org [my-org] --name [my-username] --password [my-password]`
+* Create an influxdb token with a command like `influx auth create --org [my-org] --user [my-username] --write-bucket [my-bucket-id]`
+* Create a `config.yaml` in `~/.config/temperature-sensor-scanner/` based on the `config.example.yaml` file
+* Install this tool with a command like `pip install temperature-sensor-scanner`
+
+## Usage
+
+Run `temperature-sensor-scanner` which will scan for nearby sensors which are emitting temperature data in their Bluetooth
+advertising string, collect that data, and emit it into InfluxDB.
+
+# Notes
+
+* https://github.com/pvvx/ATC_MiThermometer/
+* https://pvvx.github.io/ATC_MiThermometer/TelinkMiFlasher.html
+  * Launch in Chrome instead of Firefox
+* Other tools that look interesting
+  * https://github.com/JsBergbau/MiTemperature2
+
+## Steps to provision a new sensor
+
+* [Flash the firmware](https://github.com/pvvx/ATC_MiThermometer/?tab=readme-ov-file#flashing-or-updating-the-firmware-ota)
+  * Click `Connect`
+  * Select the `LYWSD03MMC` Bluetooth device in the menu
+  * Click `Do Activation`
+  * Choose `Custom Firmware ATC_v56.bin`
+  * Click `Start Flashing`
+  * Wait 42 seconds for it to show update done
+* Identify ID from Bluetooth announced name and print a label to put on the sensor
+* Quit Chrome and start again
+* [Configure sensor](https://github.com/pvvx/ATC_MiThermometer/?tab=readme-ov-file#configuration)
+  * Set display to Farenheight
+  * Click `Set Time`
+  * Set advertising type to `ATC1441`
+  * Set advertising interval to `10000` ( https://github.com/pvvx/ATC_MiThermometer/issues/23#issuecomment-766898945 )
+  * Set Measure interval: to 10
+  * Click `Send Config`

temperature_sensor_scanner-1.0.0/config.example.yaml

@@ -0,0 +1,20 @@
+sensors:
+  ABCDEF123456:
+    bindkey: 0123456789abcdef0123456789abcdef
+    domain: outdoors
+    location: John's room, window next to closet
+    name: ATC_123456
+    mac: ABCDEF1234567890
+
+  BCDEF1234567:
+    bindkey: 123456789abcdef0123456789abcdef0
+    domain: indoors
+    location: Alice's room, on bookshelf
+    name: ATC_234567
+    mac: BCDEF12345678901
+
+influxdb:
+  bucket: home
+  org: my-org
+  token: abcdefghijklmnopqrstuvwxyz-0123456789-ABCDEFGHIJKLMNOPQRSTUVWXYZ-0123456789-abcdefghij==
+  url: https://influxdb.example.com

temperature_sensor_scanner-1.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "temperature-sensor-scanner"
+version = "1.0.0"
+description = "A tool to collect data from temperature sensors and emit it into InfluxDB"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "GPL-3.0-or-later" }
+authors = [
+    { name = "Gene Wood", email = "gene_wood@cementhorizon.com" }
+]
+dependencies = [
+    "bleak",
+    "atc-mi-interface",
+    "influxdb-client",
+    "platformdirs",
+    "PyYAML"
+]
+
+[project.urls]
+Homepage = "https://github.com/gene1wood/temperature-sensor-scanner"
+Repository = "https://github.com/gene1wood/temperature-sensor-scanner"
+
+# CLI entry point
+[project.scripts]
+temperature-sensor-scanner = "temperature_sensor_scanner:main"
+
+# Tell hatchling where your package lives
+[tool.hatch.build.targets.wheel]
+packages = ["temperature_sensor_scanner"]
+
+[tool.black]
+preview = true
+unstable = true

temperature_sensor_scanner-1.0.0/requirements.txt

@@ -0,0 +1,5 @@
+bleak
+atc-mi-interface
+influxdb-client
+platformdirs
+PyYAML

temperature_sensor_scanner-1.0.0/setup.cfg

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 92

temperature_sensor_scanner-1.0.0/temperature_sensor_scanner/__init__.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+
+import asyncio
+from bleak import BleakScanner  # pip install bleak
+from functools import partial
+from atc_mi_interface import (
+    general_format,
+    atc_mi_advertising_format,
+)  # pip install atc-mi-interface
+
+# atc-mi-interface
+# https://github.com/pvvx/ATC_MiThermometer/tree/master/python-interface#decoding-and-encoding
+import influxdb_client  # pip install influxdb-client
+from influxdb_client.client.write_api import SYNCHRONOUS
+
+import sys
+from pathlib import Path
+
+import yaml  # pip install PyYAML
+from platformdirs import user_config_dir  # pip install platformdirs
+
+APP_NAME = "temperature-sensor-scanner"
+APP_AUTHOR = "Cementhorizon"
+
+
+def get_config_path() -> Path:
+    """
+    Returns the full path to config.yaml in the user config directory.
+    Example:
+      Linux:   ~/.config/APP_NAME/config.yaml
+      macOS:   ~/Library/Application Support/APP_NAME/config.yaml
+      Windows: C:\\Users\\<user>\\AppData\\Local\\APP_AUTHOR\\APP_NAME\\config.yaml
+    """
+    config_dir = Path(user_config_dir(APP_NAME, APP_AUTHOR))
+    return config_dir / "config.yaml"
+
+
+def load_config(path: Path) -> dict:
+    """
+    Loads YAML config.
+    """
+    if not path.exists():
+        print("Missing parsing config file", file=sys.stderr)
+        sys.exit(1)
+
+    try:
+        with path.open("r") as f:
+            return yaml.safe_load(f) or {}
+    except yaml.YAMLError as e:
+        print(f"Error parsing config file: {e}", file=sys.stderr)
+        sys.exit(1)
+
+
+def gather_data(config: dict) -> list:
+    scan_results = asyncio.run(ble_coro(config))
+
+    # name = atc_mi_data.atc1441_format[0].MAC.replace(":", "")[-6:]
+    # print(f"ATC_{name} : {temperature:.1f}")
+
+    points = []
+    macs_seen = set()
+    for scan_result in scan_results:
+        if scan_result["mac"] in macs_seen:
+            continue
+        else:
+            macs_seen.add(scan_result["mac"])
+        sensor = config["sensors"][scan_result["mac"]]
+        points.append(
+            influxdb_client.Point("environment")
+            .tag("location", sensor["location"])
+            .tag("domain", sensor["domain"])
+            .tag("mac", scan_result["mac"])
+            .field("temperature", scan_result["temperature"])
+        )
+    return points
+
+
+def emit_data(config: dict, points: list) -> None:
+    bucket = config["influxdb"]["bucket"]
+    org = config["influxdb"]["org"]
+    token = config["influxdb"]["token"]
+    url = config["influxdb"]["url"]
+
+    client = influxdb_client.InfluxDBClient(url=url, token=token, org=org)
+
+    write_api = client.write_api(write_options=SYNCHRONOUS)
+    write_api.write(bucket=bucket, org=org, record=points)
+
+
+async def ble_coro(config):
+    count = [0]
+    stop_event = asyncio.Event()
+    results = []
+
+    def detection_callback(count, results, device, advertisement_data):
+        format_label, adv_data = atc_mi_advertising_format(advertisement_data)
+        if not adv_data:
+            return
+        mac_address = bytes.fromhex(device.address.replace(":", ""))
+        bindkey = config["sensors"][device.address.replace(":", "")]["bindkey"]
+
+        atc_mi_data = general_format.parse(
+            adv_data,
+            mac_address=mac_address,
+            bindkey=None if bindkey is None else bytes.fromhex(bindkey),
+        )
+        name = atc_mi_data.atc1441_format[0].MAC.replace(":", "")[-6:]
+        if atc_mi_data.atc1441_format[0].temperature_unit == "°C":
+            temperature = (atc_mi_data.atc1441_format[0].temperature * 1.8) + 32
+        else:
+            temperature = atc_mi_data.atc1441_format[0].temperature
+        print(f"ATC_{name} : {temperature:.1f}")
+
+        results.append({
+            "mac": atc_mi_data.atc1441_format[0].MAC.replace(":", ""),
+            "temperature": temperature,
+        })
+
+        count[0] += 1
+        if count[0] == 8:
+            stop_event.set()
+
+    async with BleakScanner(
+        detection_callback=partial(detection_callback, count, results)
+    ) as scanner:
+        await stop_event.wait()
+    return results
+
+
+def main():
+    config_path = get_config_path()
+    config = load_config(config_path)
+    points = gather_data(config)
+    emit_data(config, points)
+
+
+if __name__ == "__main__":
+    main()