Skip to main content

bluetooth_adv/beacon/
ibeacon.rs

1//! Apple iBeacon: manufacturer data of company 0x004C, type 0x02, length 0x15.
2
3use crate::reader::Reader;
4use crate::uuid::Uuid;
5
6#[cfg(feature = "serde")]
7use serde::Serialize;
8
9/// Apple's company identifier.
10pub const COMPANY_ID: u16 = 0x004c;
11
12/// An iBeacon frame.
13#[derive(Debug, Clone, Copy, PartialEq, Eq)]
14#[cfg_attr(feature = "serde", derive(Serialize))]
15pub struct IBeacon {
16    /// Proximity UUID.
17    pub uuid: Uuid,
18    /// Major.
19    pub major: u16,
20    /// Minor.
21    pub minor: u16,
22    /// Measured power: RSSI at one metre, dBm.
23    pub measured_power: i8,
24}
25
26/// Decodes the manufacturer data (after the company identifier).
27pub fn decode(company_id: u16, data: &[u8]) -> Option<IBeacon> {
28    if company_id != COMPANY_ID {
29        return None;
30    }
31    let mut r = Reader::new(data);
32    if r.u8()? != 0x02 || r.u8()? != 0x15 {
33        return None;
34    }
35    let uuid = Uuid::Uuid128(r.array()?);
36    let b = IBeacon {
37        uuid,
38        major: r.u16_be()?,
39        minor: r.u16_be()?,
40        measured_power: r.i8()?,
41    };
42    Some(b)
43}
44
45/// Encodes an iBeacon as manufacturer data (after the company identifier),
46/// for advertising one.
47pub fn encode(b: &IBeacon) -> Vec<u8> {
48    let mut v = vec![0x02, 0x15];
49    v.extend_from_slice(&b.uuid.to_u128_bytes());
50    v.extend_from_slice(&b.major.to_be_bytes());
51    v.extend_from_slice(&b.minor.to_be_bytes());
52    v.push(b.measured_power as u8);
53    v
54}
55
56#[cfg(test)]
57mod tests {
58    use super::*;
59
60    #[test]
61    fn round_trip() {
62        let data = hex::decode("0215e2c56db5dffb48d2b060d0f5a71096e000010002c5").unwrap();
63        let b = decode(COMPANY_ID, &data).unwrap();
64        assert_eq!(b.uuid.to_string(), "e2c56db5-dffb-48d2-b060-d0f5a71096e0");
65        assert_eq!((b.major, b.minor, b.measured_power), (1, 2, -59));
66        assert_eq!(encode(&b), data);
67        assert!(decode(COMPANY_ID, &data[..10]).is_none());
68        assert!(decode(0x0059, &data).is_none());
69    }
70}