Package: bleparser
BLE parser for passive BLE advertisementsThis pypi package is parsing BLE advertisements to readable data for several sensors and can be used for device tracking (by (fixed) MAC address or by UUID). The parser was originally developed as part of theBLE 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 likeaioblescanorblesonto do that part. An example is given in theexamples folder.Installationpip install bleparserSupported sensorsSupported sensor brandsAcconeerAir MentorAmazfitATC (custom firmware for Xiaomi/Qingping sensors)BlueMaestroBrifitBTHomeb-parasiteGoveeHHCCInkbirdiNodeJaaleeJinouKegtronKKMMikrotikMoatOral-BQingpingRelsibRuuvitagSensirionSensorPushSmartDrySwitchbotTeltonikaThermoplusThermoproTiltXiaogui (Scale)Xiaomi (MiBeacon)Xiaomi (MiScale)A full list of all supported sensors can be found on theBLE monitor documentationUsageWhen using default input parameters, you can use bleparser with raw BLE data as follows (more working examples below).ble_parser=BleParser()sensor_msg,tracker_msg=ble_parser.parse_raw_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={})sensor_msg,tracker_msg=ble_parser.parse_raw_data(data)It is also possible to use advertisement data directly.ble_parser=BleParser()sensor_data,tracker_data=self.parse_advertisement(mac,rssi,service_class_uuid16,service_class_uuid128,local_name,service_data_list,man_spec_data_list)service_data_listandman_spec_data_listhave to be in a list, as a BKE advertisement can contain multiple service data/manufacturer specific data packets.report_unknownReport unknown sensors. Can be set toAcconeer,Air Mentor,Amazfit,ATC,b-parasite,BlueMaestro,Brifit,BTHome,Govee,HHCC,Inkbird,iNode,Jaalee,Jinou,Kegtron,KKM,Mikrotik,Moat,Mi Scale,Oral-B,Qingping,Relsib,Ruuvitag,SensorPush,Sensirion,SmartDry,Switchbot,Teltonika,Thermoplus,Thermopro,Tilt,XiaoguiorXiaomito report unknown sensors of a specific brand to the logger. You can set it toOtherto report all unknown advertisements to the logger. Default:FalsediscoveryBoolean. When set toFalse, only sensors in sensor_whitelist will be parsed. Default:Truefilter_duplicatesBoolean. 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:Falsesensor_whitelistList with MAC addresses or UUIDs of devices that are being parsed, ifdiscoveryis set toFalse. Ifdiscoveryis set toTrue, all supported sensors will be parsed. Default:[]tracker_whitelistList with devices (MAC addresses or UUIDs) to track. Default:[]aeskeysDictionary with mac + encryption key pairs, for sensors that require an encryption key to decrypt the payload. Default:{}ResultThe parser result are two two dictionaries, one with sensor data (e.g. temperature readings) and one with tracking data.Parsing sensor dataThe following minimal example shows how to extract the sensor measurements out of a (supported) BLE advertisement:frombleparserimportBleParserdata_string="043e2502010000219335342d5819020106151695fe5020aa01da219335342d580d1004fe004802c4"data=bytes(bytearray.fromhex(data_string))ble_parser=BleParser()sensor_msg,tracker_msg=ble_parser.parse_raw_data(data)print(sensor_msg)The output ofsensor_msgis:{'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 therssi,mac,type,packet,firmwareanddatafields. Additional fields with the measurements, liketemperatureandhumiditywill be available depending on the sensor type.Parsing tracker dataA 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:.frombleparserimportBleParserdata_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_raw_data(data)print(tracker_msg)The result is:{'is connected': True, 'mac': '582D34359321', 'rssi': -60}The output is always showing themac,rssiand if itis connected.