BLE parser for passive BLE advertisements
This pypi package is parsing BLE advertisements to readable data for several sensors and can be used for device tracking, as long as the MAC address is static. The parser was originally developed as part of the BLE monitor custom component for Home Assistant, but can now be used for other implementations. The package does NOT take care of the data collecting of the BLE advertisements, you can use other packages like aioblescan or bleson to do that part.
Installation
pip install bleparser
Supported sensors
Supported sensor brands
- ATC (custom firmware for Xiaomi/Qingping sensors)
- Brifit
- Govee
- iNode sensors
- Kegtron
- Qingping
- Ruuvitag
- Teltonika
- Thermoplus
- Xiaomi MiBeacon
- Xiaomi Scale
A full list of all supported sensors can be found on the BLE monitor documentation
Usage
The parser result are two two dictionaries, one with sensor data (e.g. temperature readings) and one with tracking data.
Parsing sensor data
The following minimal example shows how to extract the sensor measurements out of a (supported) BLE advertisement:
from bleparser import BleParser
data_string = "043e2502010000219335342d5819020106151695fe5020aa01da219335342d580d1004fe004802c4"
data = bytes(bytearray.fromhex(data_string))
ble_parser = BleParser()
sensor_msg, tracker_msg = ble_parser.parse_data(data)
print(sensor_msg)
The output of sensor_msg is:
{'rssi': -60, 'mac': '582D34359321', 'type': 'LYWSDCGQ', 'packet': 218, 'firmware': 'Xiaomi (MiBeacon V2)', 'data': True, 'temperature': 25.4, 'humidity': 58.4}
If the advertisements can be parsed, it will always show the rssi, mac, type, packet, firmware and data fields. Additional fields with the measurements, like temperature and humidity will be available depending on the sensor type.
Parsing tracker data
A minimal example for tracking BLE devices is shown below. To prevent tracking of all devices that pass by, you will have to specify a whitelist with devices that you want to track. This needs to be a list with MAC addresses in lower case, without :.
from bleparser import BleParser
data_string = "043e2502010000219335342d5819020106151695fe5020aa01da219335342d580d1004fe004802c4"
data = bytes(bytearray.fromhex(data_string))
tracker_whitelist = []
track_mac = "58:2D:34:35:93:21"
track_mac = bytes.fromhex(track_mac.replace(":", ""))
tracker_whitelist.append(track_mac.lower())
ble_parser = BleParser(tracker_whitelist=tracker_whitelist)
sensor_msg, tracker_msg = ble_parser.parse_data(data)
print(tracker_msg)
The result is:
{'is connected': True, 'mac': '582D34359321', 'rssi': -60}
The output is always showing the mac, rssi and if it is connected.
1 maintainer
Release files for bleparser 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bleparser-0.2.0.tar.gz | 17.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bleparser-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:42.2 kB
Release files / bleparser-0.2.0.tar.gz
| Download URL | bleparser-0.2.0.tar.gz |
|---|---|
| Size | 17.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7c931b37b5bfc9d3ebcc69a1f28cf2f6b16907dd33390c0f5ad15629cfecd3c8
|
|
BLAKE2b-256 checksum How to use checksums |
b973d9ce713c7c5a490a962b6bb157e87f5b447717a0040963ab16544bb0319a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6
|
Release files / bleparser-0.2.0-py3-none-any.whl
| Download URL | bleparser-0.2.0-py3-none-any.whl |
|---|---|
| Size | 24.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
49e3f471fc6ce48e177dd7fffefb837d189695cdbb603b05af5c7ff3713de8fb
|
|
BLAKE2b-256 checksum How to use checksums |
b72eceb0d7520fd924deff53df4b1321337be8a6b3309d6b208d7cdd9d9850d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6
|
