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
When using default input parameters, you can use bleparser as follows (more working examples below).
ble_parser = BleParser()
sensor_msg, tracker_msg = ble_parser.parse_data(data)
You can set optional parameters, the example below shows all possible input parameters with default values.
ble_parser = BleParser(
report_unknown=False,
discovery=True,
filter_duplicates=False,
sensor_whitelist=[],
tracker_whitelist=[],
aeskeys={}
)
report_unknown Report unknown sensors. Can be set to Xiaomi, Qingping, ATC, Mi Scale, Kegtron, Thermoplus, Brifit, Govee or Ruuvitag to report unknown sensors of a specific brand to the logger. You can set it to Other to report all unknown advertisements to the logger. Default: False
discovery Boolean. When set to False, only sensors in sensor_whitelist will be parsed. Default: True
filter_duplicates Boolean. Most sensors send multipe advertisements with the exact same data, to increase reception quality. When set to True, it will filter duplicate advertisements based on a packet_id that is send by the sensor. Only one advertisement will be parsed if it has the same packet_id. Note that not all sensors have packet_ids. Default: False
sensor_whitelist List with MAC addresses of devices that are being parsed, if discovery is set to False. If discovery is set to True, all supported sensors will be parsed. Default: []
tracker_whitelist List with devices to track. Default: []
aeskeys Dictionary with mac + encryption key pairs, for sensors that require an encryption key to decrypt the payload. Default: {}
Result
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.
25 Nov 01, 2022
11 Sep 10, 2021
1 Jul 05, 2022
29 Aug 29, 2022
62 Dec 28, 2022
1 Jan 11, 2022
67 Nov 16, 2022
329 Dec 31, 2022
1 Oct 30, 2021
3 Apr 05, 2022
0 Jan 05, 2023
1 Oct 13, 2021
3 May 31, 2021
9 Jul 19, 2022
16 Nov 22, 2022
2 Nov 26, 2021
3 Mar 24, 2022
3 Jan 21, 2022
3 Oct 08, 2021
21 Nov 28, 2022