Struct BleAccessory 

pub struct BleAccessory { /* private fields */ }

A connected BLE accessory: holds the GATT link, the secure session, the cached attribute database, and a map from (aid, iid) to GATT characteristic UUID for issuing PDUs.

Implementations

impl BleAccessory

pub fn accessories(&self) -> &[Accessory]

The cached attribute database.

pub async fn broadcast_state(&self) -> BleBroadcastState

The current persistable broadcast material (key + latest GSN). Persist this so a later connect can resume broadcast decryption.

pub fn find( &self, svc: ServiceType, chr: CharacteristicType, ) -> Result<(u64, u64)>

Find the (aid, iid) of a characteristic by service + characteristic type.

Errors

BleError::CharacteristicNotFound if no match exists.

pub async fn read(&mut self, aid: u64, iid: u64) -> Result<CharValue>

Read a characteristic value, decoded to its declared format.

Errors

BleError::CharacteristicNotFound if unknown; otherwise GATT/PDU/crypto.

pub async fn remove_pairing(&mut self, controller_id: &str) -> Result<()>

Remove a pairing by controller pairing id. Pass this controller’s own id to un-pair this controller; pass another controller’s id (this session must hold admin permission) to remove that one.

Runs as an encrypted RemovePairing (State M1, Method 4) write to the accessory’s Pairing-Pairings characteristic; a reconnect-invalidated session is re-verified first.

Removing this controller’s own pairing is a special case: the accessory removes the pairing and tears down the secure session as part of the same operation, so the encrypted M2 response is frequently lost or undecryptable (the link drops, or the reply is no longer sealed under the now-defunct session). Per the HAP self-removal semantics, once the request has been written the removal has taken effect, so a transport/crypto failure reading the response on self-removal is reported as success.

Errors

BleError::PairingRejected if the accessory rejects the request (PDU status or a kTLVType_Error in the M2 reply); otherwise GATT/PDU/crypto errors (except the tolerated self-removal teardown described above).

pub async fn enable_broadcasts(&mut self, iids: &[u64]) -> Result<()>

Enable encrypted broadcast notifications for the given characteristic instance ids (the HAP BLE accessory id is always 1). Each is an encrypted Characteristic-Configuration write (Properties + Broadcast-Interval). Call this while connected, before disconnecting to receive sleepy events — without it the accessory will not emit 0x11 encrypted broadcasts. A characteristic that does not support broadcasts is skipped; per-write failures are tolerated (best-effort).

Errors

Propagates a session re-verify failure.

pub async fn subscribe(&mut self, aid: u64, iid: u64) -> Result<()>

Subscribe to value-change events for a characteristic. HAP-BLE connected events use the GATT notification only as a trigger: when it fires we issue an encrypted Characteristic-Read for the new value and publish it on BleAccessory::events.

Errors

BleError::CharacteristicNotFound if unknown; otherwise GATT errors.

Connected events are best-effort: if the link drops, this GATT subscription ends and is not re-armed (re-arming a sleepy device storms). Durable updates arrive via BleAccessory::events from the broadcast and disconnected-event channels.

pub async fn watch_sleepy_events( &mut self, advert_source: Arc<dyn AdvertSource>, device_id: [u8; 6], poll_iids: Vec<(u64, u64)>, ) -> Result<()>

Watch advertisements and deliver disconnected-event updates. Two paths:

• Regular (0x06) advertisements: when the accessory’s GSN bumps, read each polled characteristic and publish its value on BleAccessory::events. Events are deduplicated by (iid, gsn).
• Encrypted broadcast (0x11) advertisements: decrypt the value directly from the advertisement using the stored hap_crypto::BroadcastKey and publish it — no GATT connection needed.

The advert source is supplied by the caller (the same backend object that provides the GATT connection).

Errors

BleError if the advert source cannot start.

pub fn events(&self) -> impl Stream<Item = CharacteristicEvent>

An async stream of characteristic events. Each call returns a fresh subscriber to the shared event channel.

Trait Implementations

impl Drop for BleAccessory

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.