BLEAdvReader

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 35 Open GitHub ↗

A BLE tool library to decode some advertising data in object mode (used on ESP32 and Pycom modules)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## A BLE tool library to decode some advertising data in object mode (used on ESP32 and [Pycom](http://www.pycom.io) modules)

![HC²](https://raw.githubusercontent.com/jczic/BLEAdvReader/master/hc2.png "HC²")

#### Very easy to integrate and very light with one file only :
- `"bleAdvReader.py"`

#### BLEAdvReader features :
- Access to all elements data in BLE advertising packets
- Checking data format errors in lenght and structure
- Getting objects (class) to read some specialized data
- Works on data at different levels
- Reading UUIDs in the good format (16bits, 32bits, 128bits)
- Access to manufacturer data for custom ID of companies
- Decoding and reading **Apple iBeacon** format
- Decoding and reading **Google EddyStone** format :
  - EddyStone UID
  - EddyStone URL *(Beacon URI)*
  - EddyStone TML Unencrypted
  - EddyStone TML Encrypted
  - EddyStone EID
- Estimating device proximity with 3 equations :
  - LogTX (path loss exponent variable)
  - OldBconTX (on old iPhone/Android)
  - NewBconTX (on recent iPhone/Android)

### Example of using *BLEAdvReader* easily :
```python
# Getting "advertisingData" before via the BLE

from bleAdvReader import BLEAdvReader

advReader = BLEAdvReader(advertisingData)

# Gets the service data part in the advertising packet,
svcData = advReader.GetDataByDataType(BLEAdvReader.DATA_TYPE_SVC_DATA)

# List all decoded and structured objects (class),
for advElement in advReader.GetAllElements() :
    print(advElement)
    # Finds an iBeacon with classes instances comparison,
    if isinstance(advElement, BLEAdvReader.AppleIBeacon) :
    	print('This is an iBeacon with UUID %s' % advElement.StrUUID)

# Gets the same iBeacon more directly,
iBeaconElement = advReader.GetElementByClass(BLEAdvReader.AppleIBeacon)
if iBeaconElement :
	print('iBeacon found!')
```

### Using *BLEAdvReader* main class :

### Using *BLEAdvReader.Flags* class :

### Using *BLEAdvReader.AdoptedService16bits* class :

### Using *BLEAdvReader.AdoptedService32bits* class :

### Using *BLEAdvReader.AdoptedService128bits* class :

### Using *BLEAdvReader.ShortName* class :
Directly usable as string

### Using *BLEAdvReader.CompleteName* class :
Directly usable as string

### Using *BLEAdvReader.TXPowerLevel* class :

| Name | Property | Type |
| - | - | - |
| DBM | `txPower.DBM` | int |

### Using *BLEAdvReader.ServiceData* class :

### Using *BLEAdvReader.ManufacturerData* class :

### Using *BLEAdvReader.AppleService* class :

### Using *BLEAdvReader.AppleIBeacon* class :

### Using *BLEAdvReader.EddyStoneUID* class :

### Using *BLEAdvReader.EddyStoneURL* class :

| Name | Property | Type |
| - | - | - |
| TxPower | `beaconEddyStone.TxPower` | int |
| URL | `beaconEddyStone.URL` | string |

### Using *BLEAdvReader.EddyStoneTLMUnencrypted* class :

### Using *BLEAdvReader.EddyStoneTLMEncrypted* class :

### Using *BLEAdvReader.EddyStoneEID* class :

### Using *BLEAdvReader.ProximityHelper* "static" class :

### By JC`zic for [HC²](https://www.hc2.fr) ;')

*Keep it simple, stupid* :+1:

BLEAdvReader

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README