Skip to main content

bluetooth_adv/beacon/
altbeacon.rs

1//! AltBeacon (<https://github.com/AltBeacon/spec>): manufacturer data of any
2//! company, beacon code 0xBEAC, a 20-byte beacon id, reference RSSI and one
3//! reserved byte.
4
5use crate::reader::Reader;
6
7#[cfg(feature = "serde")]
8use serde::Serialize;
9
10/// An AltBeacon frame.
11#[derive(Debug, Clone, Copy, PartialEq, Eq)]
12#[cfg_attr(feature = "serde", derive(Serialize))]
13pub struct AltBeacon {
14    /// The advertiser's company identifier.
15    pub company_id: u16,
16    /// Beacon id: by convention a 16-byte organisational unit then 4 bytes.
17    #[cfg_attr(feature = "serde", serde(serialize_with = "crate::ad::ser_hex"))]
18    pub beacon_id: [u8; 20],
19    /// Average RSSI at one metre, dBm.
20    pub reference_rssi: i8,
21    /// Reserved for the manufacturer.
22    pub reserved: u8,
23}
24
25/// Decodes the manufacturer data (after the company identifier).
26pub fn decode(company_id: u16, data: &[u8]) -> Option<AltBeacon> {
27    let mut r = Reader::new(data);
28    if r.u16_be()? != 0xbeac || data.len() != 24 {
29        return None;
30    }
31    Some(AltBeacon {
32        company_id,
33        beacon_id: r.array()?,
34        reference_rssi: r.i8()?,
35        reserved: r.u8()?,
36    })
37}
38
39/// Encodes an AltBeacon as manufacturer data (after the company identifier).
40pub fn encode(b: &AltBeacon) -> Vec<u8> {
41    let mut v = vec![0xbe, 0xac];
42    v.extend_from_slice(&b.beacon_id);
43    v.push(b.reference_rssi as u8);
44    v.push(b.reserved);
45    v
46}
47
48#[cfg(test)]
49mod tests {
50    use super::*;
51
52    #[test]
53    fn round_trip() {
54        let data = hex::decode("beac2f234454cf6d4a0fadf2f4911ba9ffa600010002c500").unwrap();
55        let b = decode(0x0118, &data).unwrap();
56        assert_eq!(b.reference_rssi, -59);
57        assert_eq!(encode(&b), data);
58        assert!(decode(0x0118, &data[..23]).is_none());
59    }
60}