Skip to main content

Module beacon

Module beacon 

Source
Expand description

Beacon and sensor formats found inside advertisements.

FormatCarried inModule
iBeaconApple manufacturer data, type 0x02ibeacon
AltBeaconany company’s manufacturer data, code 0xBEACaltbeacon
Eddystone UID, URL, TLM (plain and encrypted), EIDservice data 0xFEAAeddystone
BTHome v2, plain and encryptedservice data 0xFCD2bthome
KKM KBeacon sensor (v1, v2, encrypted) and system framesservice data 0xFEAA, manufacturer data 0x0A53kkm
Ruuvi RAWv1, RAWv2 (5), 6, E1manufacturer data 0x0499ruuvi, decoded by the ruuvi-sensor-protocol crate

decode tries every format and returns all that match: one advertisement can carry an iBeacon and an Eddystone TLM, say.

Modules§

altbeacon
AltBeacon (https://github.com/AltBeacon/spec): manufacturer data of any company, beacon code 0xBEAC, a 20-byte beacon id, reference RSSI and one reserved byte.
bthome
BTHome v2 (https://bthome.io/format/): service data of UUID 0xFCD2.
eddystone
Eddystone (https://github.com/google/eddystone): service data of UUID 0xFEAA, first byte the frame type.
ibeacon
Apple iBeacon: manufacturer data of company 0x004C, type 0x02, length 0x15.
kkm
KKM KBeacon frames, as KKM’s own MIT-licensed SDK reads them (https://github.com/kkmhogen/android_kbeaconlib2, KBAdvPackage).
ruuvi
Ruuvi sensors (manufacturer data 0x0499), decoded by the [ruuvi_sensor_protocol] crate, used as published; this module only maps its values to readings.

Structs§

Context
What a decoder may need beyond the advertisement itself.
Reading
One measurement from a sensor frame.

Enums§

Beacon
A decoded beacon or sensor frame.

Functions§

decode
Every beacon format found in adv.