CDC Badge OS
Firmware for the CDC Badge v1.0 hardware security key
Loading...
Searching...
No Matches
IBluetoothController Class Referenceabstract

#include <IBluetoothController.h>

Inheritance diagram for IBluetoothController:
cdc::core::IService cdc::hal::BluetoothControllerStub

Classes

struct  DiscoveredCharacteristic
struct  DiscoveredService

Public Types

using ListenerToken = uint16_t
using PasskeyCallback = std::function<void(uint32_t passkey)>
using AuthCompleteCallback = std::function<void(bool success)>
using NumericComparisonCallback = std::function<void(uint16_t connHandle, uint32_t passkey)>
using EncChangeCallback = std::function<void(uint16_t connHandle, int status)>
using ConnectionCallback = std::function<void(uint16_t connHandle)>
using DisconnectionCallback = std::function<void(uint16_t connHandle, int reason)>
using ServiceDiscoveryCallback
using CharacteristicReadCallback
using NotificationCallback
using WriteCompleteCallback

Public Member Functions

virtual ~IBluetoothController ()=default
virtual bool enable ()=0
virtual void disable ()=0
virtual bool isEnabled () const=0
virtual bool getMacAddress (uint8_t *mac) const=0
virtual void setDeviceName (const char *name)=0
virtual const char * getDeviceName () const=0
virtual bool isConnected () const=0
virtual void disconnect ()=0
virtual int8_t getRssi () const=0
virtual bool getConnectedDeviceName (char *buf, size_t bufLen) const
virtual uint8_t getBondedDeviceCount () const
virtual uint8_t getBondedDevices (BleBondInfo *out, uint8_t maxCount) const
virtual void startAdvertising ()
virtual void stopAdvertising ()
virtual bool isAdvertising () const
virtual bool addAdvertisingUuid (const BleUuid &uuid)
virtual void removeAdvertisingUuid (const BleUuid &uuid)
virtual bool setAdvertisingManufacturerData (uint16_t companyId, const uint8_t *data, uint16_t len)
virtual void clearAdvertisingManufacturerData ()
virtual void setAppearance (uint16_t appearance)
virtual bool startScan (uint32_t durationMs=5000, bool keepAdvertising=false)
virtual void stopScan ()
virtual bool isScanComplete () const
virtual uint8_t getScanResults (BleScanResult *results, uint8_t maxResults)
virtual void setPasskeyCallback (PasskeyCallback cb)
virtual void setAuthCompleteCallback (AuthCompleteCallback cb)
virtual ListenerToken addNumericComparisonCallback (NumericComparisonCallback cb)
virtual void removeNumericComparisonCallback (ListenerToken token)
virtual void setNumericComparisonCallback (NumericComparisonCallback cb)
virtual void respondToNumericComparison (uint16_t connHandle, bool accept)
virtual ListenerToken addEncryptionChangeCallback (EncChangeCallback cb)
virtual void removeEncryptionChangeCallback (ListenerToken token)
virtual bool initiateSecurity (uint16_t connHandle)
virtual bool getPeerIdAddr (uint16_t connHandle, uint8_t addr[6], uint8_t *addrType) const
virtual ListenerToken addConnectionCallback (ConnectionCallback cb)
virtual ListenerToken addDisconnectionCallback (DisconnectionCallback cb)
virtual void removeConnectionCallback (ListenerToken token)
virtual void removeDisconnectionCallback (ListenerToken token)
virtual void clearAllBonds ()
virtual void forgetBond (const uint8_t addr[6], uint8_t addrType)
virtual bool registerGattService (const GattServiceDef &service, bool pluginReserved=false)
virtual bool unregisterGattService (const BleUuid &serviceUuid)
virtual bool sendNotification (uint16_t connHandle, uint16_t attrHandle, const uint8_t *data, uint16_t len)
virtual bool sendIndication (uint16_t connHandle, uint16_t attrHandle, const uint8_t *data, uint16_t len)
virtual uint16_t getMtu () const
virtual bool connect (const uint8_t *addr, uint8_t addrType=0)
virtual void cancelConnect ()
virtual bool discoverServiceByUuid (uint16_t connHandle, const BleUuid &uuid)
virtual bool writeCharacteristic (uint16_t connHandle, uint16_t attrHandle, const uint8_t *data, uint16_t len, bool withResponse=true)
virtual bool readCharacteristic (uint16_t connHandle, uint16_t attrHandle)
virtual bool enableNotifications (uint16_t connHandle, uint16_t cccdHandle)
virtual void disconnectHandle (uint16_t connHandle)
virtual ListenerToken addServiceDiscoveryCallback (ServiceDiscoveryCallback cb)
virtual ListenerToken addCharacteristicReadCallback (CharacteristicReadCallback cb)
virtual ListenerToken addNotificationCallback (NotificationCallback cb)
virtual ListenerToken addWriteCompleteCallback (WriteCompleteCallback cb)
virtual void removeServiceDiscoveryCallback (ListenerToken token)
virtual void removeCharacteristicReadCallback (ListenerToken token)
virtual void removeNotificationCallback (ListenerToken token)
virtual void removeWriteCompleteCallback (ListenerToken token)
virtual void setServiceDiscoveryCallback (ServiceDiscoveryCallback cb)
virtual void setCharacteristicReadCallback (CharacteristicReadCallback cb)
virtual void setNotificationCallback (NotificationCallback cb)
virtual void setWriteCompleteCallback (WriteCompleteCallback cb)
virtual uint16_t getConnectionHandle () const
Public Member Functions inherited from cdc::core::IService
virtual ~IService ()=default
virtual bool init ()=0
virtual bool start ()=0
virtual void stop ()=0
virtual ServiceState getState () const =0
virtual const char * getName () const =0

Static Public Attributes

static constexpr ListenerToken INVALID_LISTENER = 0xFFFF
static constexpr uint8_t MAX_REGISTERED_SERVICES = 7
static constexpr uint8_t MAX_CHARS_PER_SERVICE = 6
static constexpr uint8_t MAX_BONDED_DEVICES = 5
static constexpr uint8_t MAX_SCAN_RESULTS = 64

Detailed Description

Bluetooth Controller Interface Handles BLE stack initialization, power control, scanning and advertising

Definition at line 144 of file IBluetoothController.h.

Member Typedef Documentation

◆ AuthCompleteCallback

using cdc::hal::IBluetoothController::AuthCompleteCallback = std::function<void(bool success)>

Definition at line 343 of file IBluetoothController.h.

◆ CharacteristicReadCallback

using cdc::hal::IBluetoothController::CharacteristicReadCallback
Initial value:
std::function<void(uint16_t connHandle,
uint16_t attrHandle,
const uint8_t* data, uint16_t len)>

Called when characteristic read completes

Definition at line 650 of file IBluetoothController.h.

◆ ConnectionCallback

using cdc::hal::IBluetoothController::ConnectionCallback = std::function<void(uint16_t connHandle)>

Definition at line 434 of file IBluetoothController.h.

◆ DisconnectionCallback

using cdc::hal::IBluetoothController::DisconnectionCallback = std::function<void(uint16_t connHandle, int reason)>

Definition at line 435 of file IBluetoothController.h.

◆ EncChangeCallback

using cdc::hal::IBluetoothController::EncChangeCallback = std::function<void(uint16_t connHandle, int status)>

Called when link encryption is established or fails on a connection. status == 0 means the link is now encrypted.

Definition at line 397 of file IBluetoothController.h.

◆ ListenerToken

using cdc::hal::IBluetoothController::ListenerToken = uint16_t

Opaque listener token returned by add*Callback() methods. Pass to the matching remove*Callback() to unregister.

Definition at line 152 of file IBluetoothController.h.

◆ NotificationCallback

using cdc::hal::IBluetoothController::NotificationCallback
Initial value:
std::function<void(uint16_t connHandle,
uint16_t attrHandle,
const uint8_t* data, uint16_t len)>

Called when notification/indication received from remote device

Definition at line 657 of file IBluetoothController.h.

◆ NumericComparisonCallback

using cdc::hal::IBluetoothController::NumericComparisonCallback = std::function<void(uint16_t connHandle, uint32_t passkey)>

Numeric comparison callback for secure pairing. Called when a connecting device requires confirmation. Display the passkey and let the user accept/reject.

Definition at line 360 of file IBluetoothController.h.

◆ PasskeyCallback

using cdc::hal::IBluetoothController::PasskeyCallback = std::function<void(uint32_t passkey)>

Definition at line 342 of file IBluetoothController.h.

◆ ServiceDiscoveryCallback

using cdc::hal::IBluetoothController::ServiceDiscoveryCallback
Initial value:
std::function<void(uint16_t connHandle,
const DiscoveredService* service,
bool complete)>

Called when service discovery completes.

Parameters
connHandleConnection handle
serviceDiscovered service (null if discovery failed)
completetrue when discovery is finished

Definition at line 643 of file IBluetoothController.h.

◆ WriteCompleteCallback

using cdc::hal::IBluetoothController::WriteCompleteCallback
Initial value:
std::function<void(uint16_t connHandle,
uint16_t attrHandle,
int status)>

Called when write to remote characteristic completes

Definition at line 664 of file IBluetoothController.h.

Constructor & Destructor Documentation

◆ ~IBluetoothController()

virtual cdc::hal::IBluetoothController::~IBluetoothController ( )
virtualdefault

Member Function Documentation

◆ addAdvertisingUuid()

virtual bool cdc::hal::IBluetoothController::addAdvertisingUuid ( const BleUuid & uuid)
inlinevirtual

Register a service UUID to include in advertising scan response. Enables remote devices to discover services before connecting.

Parameters
uuidService UUID to advertise
Returns
true if registered (max 4 UUIDs)

Definition at line 269 of file IBluetoothController.h.

◆ addCharacteristicReadCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addCharacteristicReadCallback ( CharacteristicReadCallback cb)
inlinevirtual

Definition at line 676 of file IBluetoothController.h.

◆ addConnectionCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addConnectionCallback ( ConnectionCallback cb)
inlinevirtual

Register a callback for device connection events. Multiple callbacks are supported (up to 4).

Returns
Token usable with removeConnectionCallback(), or INVALID_LISTENER on overflow.

Definition at line 442 of file IBluetoothController.h.

◆ addDisconnectionCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addDisconnectionCallback ( DisconnectionCallback cb)
inlinevirtual

Register a callback for device disconnection events. Multiple callbacks are supported (up to 4).

Returns
Token usable with removeDisconnectionCallback(), or INVALID_LISTENER on overflow.

Definition at line 449 of file IBluetoothController.h.

◆ addEncryptionChangeCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addEncryptionChangeCallback ( EncChangeCallback cb)
inlinevirtual

Register a callback for encryption-change events (multi-listener).

Returns
Token usable with removeEncryptionChangeCallback(), or INVALID_LISTENER on overflow.

Definition at line 403 of file IBluetoothController.h.

◆ addNotificationCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addNotificationCallback ( NotificationCallback cb)
inlinevirtual

Definition at line 679 of file IBluetoothController.h.

◆ addNumericComparisonCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addNumericComparisonCallback ( NumericComparisonCallback cb)
inlinevirtual

Register a numeric-comparison pairing callback. Multiple listeners are supported. Only the first listener that calls respondToNumericComparison() will succeed; later responses are no-ops.

Returns
Token usable with removeNumericComparisonCallback(), or INVALID_LISTENER on overflow.

Definition at line 368 of file IBluetoothController.h.

◆ addServiceDiscoveryCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addServiceDiscoveryCallback ( ServiceDiscoveryCallback cb)
inlinevirtual

Multi-listener registration for GATT client events. Each module should call removeXxx() in its deinit to avoid stale callbacks.

Returns
Token for removeXxx(), or INVALID_LISTENER on overflow.

Definition at line 673 of file IBluetoothController.h.

◆ addWriteCompleteCallback()

virtual ListenerToken cdc::hal::IBluetoothController::addWriteCompleteCallback ( WriteCompleteCallback cb)
inlinevirtual

Definition at line 682 of file IBluetoothController.h.

◆ cancelConnect()

virtual void cdc::hal::IBluetoothController::cancelConnect ( )
inlinevirtual

Cancel an in-progress connection attempt started via connect(). No-op if no connection is pending.

Definition at line 558 of file IBluetoothController.h.

◆ clearAdvertisingManufacturerData()

virtual void cdc::hal::IBluetoothController::clearAdvertisingManufacturerData ( )
inlinevirtual

Clear manufacturer data from advertising

Definition at line 294 of file IBluetoothController.h.

◆ clearAllBonds()

virtual void cdc::hal::IBluetoothController::clearAllBonds ( )
inlinevirtual

Erase all bonded peer information from the bond store.

Definition at line 466 of file IBluetoothController.h.

◆ connect()

virtual bool cdc::hal::IBluetoothController::connect ( const uint8_t * addr,
uint8_t addrType = 0 )
inlinevirtual

Connect to a peripheral device

Parameters
addrBLE address (6 bytes)
addrTypeAddress type (0=public, 1=random)
Returns
true if connection initiated

Definition at line 549 of file IBluetoothController.h.

◆ disable()

virtual void cdc::hal::IBluetoothController::disable ( )
pure virtual

Disable Bluetooth (shutdown BLE stack to save power)

◆ disconnect()

virtual void cdc::hal::IBluetoothController::disconnect ( )
pure virtual

Disconnect current connection if any

◆ disconnectHandle()

virtual void cdc::hal::IBluetoothController::disconnectHandle ( uint16_t connHandle)
inlinevirtual

Disconnect a specific connection (central or peripheral)

Parameters
connHandleConnection handle to disconnect

Definition at line 614 of file IBluetoothController.h.

◆ discoverServiceByUuid()

virtual bool cdc::hal::IBluetoothController::discoverServiceByUuid ( uint16_t connHandle,
const BleUuid & uuid )
inlinevirtual

Discover a specific service by UUID on connected device. Results delivered via ServiceDiscoveryCallback with discovered characteristics.

Parameters
connHandleConnection handle
uuidService UUID to discover
Returns
true if discovery started

Definition at line 567 of file IBluetoothController.h.

◆ enable()

virtual bool cdc::hal::IBluetoothController::enable ( )
pure virtual

Enable Bluetooth (initialize BLE stack)

Returns
true if successfully enabled

◆ enableNotifications()

virtual bool cdc::hal::IBluetoothController::enableNotifications ( uint16_t connHandle,
uint16_t cccdHandle )
inlinevirtual

Enable notifications on a remote characteristic

Parameters
connHandleConnection handle
cccdHandleCCCD handle (usually attrHandle + 1)
Returns
true if successful

Definition at line 605 of file IBluetoothController.h.

◆ forgetBond()

virtual void cdc::hal::IBluetoothController::forgetBond ( const uint8_t addr[6],
uint8_t addrType )
inlinevirtual

Forget (unpair) a single bonded peer by identity address. Used for ephemeral pairings that should not persist.

Parameters
addr6-byte identity address
addrTypeAddress type (0=public, 1=random)

Definition at line 474 of file IBluetoothController.h.

◆ getBondedDeviceCount()

virtual uint8_t cdc::hal::IBluetoothController::getBondedDeviceCount ( ) const
inlinevirtual

Get number of bonded (paired) devices

Definition at line 233 of file IBluetoothController.h.

◆ getBondedDevices()

virtual uint8_t cdc::hal::IBluetoothController::getBondedDevices ( BleBondInfo * out,
uint8_t maxCount ) const
inlinevirtual

Enumerate bonded (paired) peers into a caller-provided buffer.

Parameters
outOutput array of BleBondInfo
maxCountCapacity of the output array
Returns
Number of bonds written

Definition at line 241 of file IBluetoothController.h.

◆ getConnectedDeviceName()

virtual bool cdc::hal::IBluetoothController::getConnectedDeviceName ( char * buf,
size_t bufLen ) const
inlinevirtual

Get connected device name

Parameters
bufOutput buffer
bufLenBuffer size
Returns
true if connected and name retrieved

Definition at line 222 of file IBluetoothController.h.

◆ getConnectionHandle()

virtual uint16_t cdc::hal::IBluetoothController::getConnectionHandle ( ) const
inlinevirtual

Get connection handle for current peripheral connection

Returns
Connection handle or 0xFFFF if not connected

Definition at line 704 of file IBluetoothController.h.

◆ getDeviceName()

virtual const char * cdc::hal::IBluetoothController::getDeviceName ( ) const
pure virtual

Get device name

◆ getMacAddress()

virtual bool cdc::hal::IBluetoothController::getMacAddress ( uint8_t * mac) const
pure virtual

Get current Bluetooth MAC address

Parameters
macOutput buffer (6 bytes)
Returns
true if address retrieved successfully

◆ getMtu()

virtual uint16_t cdc::hal::IBluetoothController::getMtu ( ) const
inlinevirtual

Get negotiated MTU for current connection (payload size)

Returns
Usable payload size (MTU - 3 for ATT overhead), or 20 if not connected

Definition at line 539 of file IBluetoothController.h.

◆ getPeerIdAddr()

virtual bool cdc::hal::IBluetoothController::getPeerIdAddr ( uint16_t connHandle,
uint8_t addr[6],
uint8_t * addrType ) const
inlinevirtual

Resolve the identity address of a connected peer.

Parameters
connHandleConnection handle
addrOutput 6-byte address
addrTypeOutput address type (0=public, 1=random)
Returns
true if the peer address was resolved

Definition at line 428 of file IBluetoothController.h.

◆ getRssi()

virtual int8_t cdc::hal::IBluetoothController::getRssi ( ) const
pure virtual

Get RSSI of connected device

Returns
RSSI in dBm, or 0 if not connected

◆ getScanResults()

virtual uint8_t cdc::hal::IBluetoothController::getScanResults ( BleScanResult * results,
uint8_t maxResults )
inlinevirtual

Get scan results

Parameters
resultsOutput array
maxResultsMaximum results to return
Returns
Number of results

Definition at line 338 of file IBluetoothController.h.

◆ initiateSecurity()

virtual bool cdc::hal::IBluetoothController::initiateSecurity ( uint16_t connHandle)
inlinevirtual

Initiate link encryption / pairing as central on an existing connection. Triggers the configured pairing flow (e.g. numeric comparison). Used to upgrade a connection to an encrypted link on demand.

Parameters
connHandleConnection handle
Returns
true if the security procedure was started

Definition at line 419 of file IBluetoothController.h.

◆ isAdvertising()

virtual bool cdc::hal::IBluetoothController::isAdvertising ( ) const
inlinevirtual

Check if currently advertising

Definition at line 261 of file IBluetoothController.h.

◆ isConnected()

virtual bool cdc::hal::IBluetoothController::isConnected ( ) const
pure virtual

Check if a device is currently connected

◆ isEnabled()

virtual bool cdc::hal::IBluetoothController::isEnabled ( ) const
pure virtual

Check if Bluetooth is currently enabled

◆ isScanComplete()

virtual bool cdc::hal::IBluetoothController::isScanComplete ( ) const
inlinevirtual

Check if scan is complete

Definition at line 330 of file IBluetoothController.h.

◆ readCharacteristic()

virtual bool cdc::hal::IBluetoothController::readCharacteristic ( uint16_t connHandle,
uint16_t attrHandle )
inlinevirtual

Read a characteristic from remote device

Parameters
connHandleConnection handle
attrHandleAttribute handle
Returns
true if read initiated

Definition at line 594 of file IBluetoothController.h.

◆ registerGattService()

virtual bool cdc::hal::IBluetoothController::registerGattService ( const GattServiceDef & service,
bool pluginReserved = false )
inlinevirtual

Register a GATT service with characteristics. Service definitions are translated to stack-native format internally. Must be called after enable() and before advertising.

Parameters
serviceService definition (struct must remain valid until unregistered)
pluginReservedtrue to allocate from the slot reserved for plugins; false (system modules) to allocate from the system pool
Returns
true if successfully registered

Definition at line 489 of file IBluetoothController.h.

◆ removeAdvertisingUuid()

virtual void cdc::hal::IBluetoothController::removeAdvertisingUuid ( const BleUuid & uuid)
inlinevirtual

Remove a service UUID from advertising scan response.

Parameters
uuidService UUID to remove

Definition at line 275 of file IBluetoothController.h.

◆ removeCharacteristicReadCallback()

virtual void cdc::hal::IBluetoothController::removeCharacteristicReadCallback ( ListenerToken token)
inlinevirtual

Definition at line 687 of file IBluetoothController.h.

◆ removeConnectionCallback()

virtual void cdc::hal::IBluetoothController::removeConnectionCallback ( ListenerToken token)
inlinevirtual

Unregister a previously added connection callback.

Definition at line 454 of file IBluetoothController.h.

◆ removeDisconnectionCallback()

virtual void cdc::hal::IBluetoothController::removeDisconnectionCallback ( ListenerToken token)
inlinevirtual

Unregister a previously added disconnection callback.

Definition at line 459 of file IBluetoothController.h.

◆ removeEncryptionChangeCallback()

virtual void cdc::hal::IBluetoothController::removeEncryptionChangeCallback ( ListenerToken token)
inlinevirtual

Unregister a previously added encryption-change callback.

Definition at line 410 of file IBluetoothController.h.

◆ removeNotificationCallback()

virtual void cdc::hal::IBluetoothController::removeNotificationCallback ( ListenerToken token)
inlinevirtual

Definition at line 688 of file IBluetoothController.h.

◆ removeNumericComparisonCallback()

virtual void cdc::hal::IBluetoothController::removeNumericComparisonCallback ( ListenerToken token)
inlinevirtual

Unregister a numeric-comparison callback previously added via add*().

Definition at line 376 of file IBluetoothController.h.

◆ removeServiceDiscoveryCallback()

virtual void cdc::hal::IBluetoothController::removeServiceDiscoveryCallback ( ListenerToken token)
inlinevirtual

Definition at line 686 of file IBluetoothController.h.

◆ removeWriteCompleteCallback()

virtual void cdc::hal::IBluetoothController::removeWriteCompleteCallback ( ListenerToken token)
inlinevirtual

Definition at line 689 of file IBluetoothController.h.

◆ respondToNumericComparison()

virtual void cdc::hal::IBluetoothController::respondToNumericComparison ( uint16_t connHandle,
bool accept )
inlinevirtual

Respond to a numeric comparison pairing request

Parameters
connHandleConnection handle from the callback
accepttrue to accept, false to reject

Definition at line 389 of file IBluetoothController.h.

◆ sendIndication()

virtual bool cdc::hal::IBluetoothController::sendIndication ( uint16_t connHandle,
uint16_t attrHandle,
const uint8_t * data,
uint16_t len )
inlinevirtual

Send indication on a characteristic (with acknowledgment)

Parameters
connHandleConnection handle
attrHandleAttribute handle
dataData to send
lenData length
Returns
true if indication sent

Definition at line 529 of file IBluetoothController.h.

◆ sendNotification()

virtual bool cdc::hal::IBluetoothController::sendNotification ( uint16_t connHandle,
uint16_t attrHandle,
const uint8_t * data,
uint16_t len )
inlinevirtual

Send notification on a characteristic

Parameters
connHandleConnection handle (0xFFFF for all connections)
attrHandleAttribute handle of the characteristic
dataData to send
lenData length
Returns
true if notification sent

Definition at line 515 of file IBluetoothController.h.

◆ setAdvertisingManufacturerData()

virtual bool cdc::hal::IBluetoothController::setAdvertisingManufacturerData ( uint16_t companyId,
const uint8_t * data,
uint16_t len )
inlinevirtual

Set manufacturer-specific data in advertising scan response. Used for module-specific broadcast data (e.g., vCard minicard).

Parameters
companyIdBluetooth company ID (0xFFFF for testing)
dataPayload data
lenPayload length (max ~27 bytes)
Returns
true if set successfully

Definition at line 285 of file IBluetoothController.h.

◆ setAppearance()

virtual void cdc::hal::IBluetoothController::setAppearance ( uint16_t appearance)
inlinevirtual

Set the GAP Appearance value advertised in the primary PDU. Lets HOGP hosts categorize the device (e.g. 0x03C1 = HID Keyboard).

Parameters
appearanceAppearance value, or 0 to advertise none

Definition at line 301 of file IBluetoothController.h.

◆ setAuthCompleteCallback()

virtual void cdc::hal::IBluetoothController::setAuthCompleteCallback ( AuthCompleteCallback cb)
inlinevirtual

Set callback for authentication completion

Definition at line 353 of file IBluetoothController.h.

◆ setCharacteristicReadCallback()

virtual void cdc::hal::IBluetoothController::setCharacteristicReadCallback ( CharacteristicReadCallback cb)
inlinevirtual

Definition at line 696 of file IBluetoothController.h.

◆ setDeviceName()

virtual void cdc::hal::IBluetoothController::setDeviceName ( const char * name)
pure virtual

Set device name for BLE advertising

Parameters
nameDevice name (null-terminated)

◆ setNotificationCallback()

virtual void cdc::hal::IBluetoothController::setNotificationCallback ( NotificationCallback cb)
inlinevirtual

Definition at line 697 of file IBluetoothController.h.

◆ setNumericComparisonCallback()

virtual void cdc::hal::IBluetoothController::setNumericComparisonCallback ( NumericComparisonCallback cb)
inlinevirtual

Legacy single-listener setter retained for source compatibility. Equivalent to calling addNumericComparisonCallback() on a freshly cleared list.

Definition at line 382 of file IBluetoothController.h.

◆ setPasskeyCallback()

virtual void cdc::hal::IBluetoothController::setPasskeyCallback ( PasskeyCallback cb)
inlinevirtual

Set callback for passkey display during pairing

Definition at line 348 of file IBluetoothController.h.

◆ setServiceDiscoveryCallback()

virtual void cdc::hal::IBluetoothController::setServiceDiscoveryCallback ( ServiceDiscoveryCallback cb)
inlinevirtual

Legacy single-listener setters retained for source compatibility. Equivalent to clearing all listeners and then add*Callback(cb).

Definition at line 695 of file IBluetoothController.h.

◆ setWriteCompleteCallback()

virtual void cdc::hal::IBluetoothController::setWriteCompleteCallback ( WriteCompleteCallback cb)
inlinevirtual

Definition at line 698 of file IBluetoothController.h.

◆ startAdvertising()

virtual void cdc::hal::IBluetoothController::startAdvertising ( )
inlinevirtual

Start BLE advertising

Definition at line 251 of file IBluetoothController.h.

◆ startScan()

virtual bool cdc::hal::IBluetoothController::startScan ( uint32_t durationMs = 5000,
bool keepAdvertising = false )
inlinevirtual

Start BLE scan

Parameters
durationMsScan duration in milliseconds; 0 scans continuously until stopScan().
keepAdvertisingIf true, advertising keeps running during the scan (Peripheral + Observer multi-role) instead of being stopped.
Returns
true if scan started

Definition at line 318 of file IBluetoothController.h.

◆ stopAdvertising()

virtual void cdc::hal::IBluetoothController::stopAdvertising ( )
inlinevirtual

Stop BLE advertising

Definition at line 256 of file IBluetoothController.h.

◆ stopScan()

virtual void cdc::hal::IBluetoothController::stopScan ( )
inlinevirtual

Stop ongoing scan

Definition at line 325 of file IBluetoothController.h.

◆ unregisterGattService()

virtual bool cdc::hal::IBluetoothController::unregisterGattService ( const BleUuid & serviceUuid)
inlinevirtual

Unregister a previously registered GATT service by its service UUID and rebuild the GATT database. Intended for dynamically (un)loaded owners such as plugins.

Parameters
serviceUuidUUID of the service to remove
Returns
true if a matching service was found and removed

Definition at line 502 of file IBluetoothController.h.

◆ writeCharacteristic()

virtual bool cdc::hal::IBluetoothController::writeCharacteristic ( uint16_t connHandle,
uint16_t attrHandle,
const uint8_t * data,
uint16_t len,
bool withResponse = true )
inlinevirtual

Write to a characteristic on remote device

Parameters
connHandleConnection handle
attrHandleAttribute handle
dataData to write
lenData length
withResponsetrue for write with response
Returns
true if write initiated

Definition at line 581 of file IBluetoothController.h.

Member Data Documentation

◆ INVALID_LISTENER

ListenerToken cdc::hal::IBluetoothController::INVALID_LISTENER = 0xFFFF
staticconstexpr

Definition at line 153 of file IBluetoothController.h.

Referenced by cdc::mod_2fa::ble_chalresp_deinit().

◆ MAX_BONDED_DEVICES

uint8_t cdc::hal::IBluetoothController::MAX_BONDED_DEVICES = 5
staticconstexpr

Maximum number of bonded peers retained/returned. Single source of truth for both the controller's bond store and any caller-side buffers.

Definition at line 228 of file IBluetoothController.h.

◆ MAX_CHARS_PER_SERVICE

uint8_t cdc::hal::IBluetoothController::MAX_CHARS_PER_SERVICE = 6
staticconstexpr

Definition at line 158 of file IBluetoothController.h.

◆ MAX_REGISTERED_SERVICES

uint8_t cdc::hal::IBluetoothController::MAX_REGISTERED_SERVICES = 7
staticconstexpr

Definition at line 157 of file IBluetoothController.h.

◆ MAX_SCAN_RESULTS

uint8_t cdc::hal::IBluetoothController::MAX_SCAN_RESULTS = 64
staticconstexpr

Maximum number of scan results retained/returned. Single source of truth for both the controller's result buffer and any caller-side buffers.

Definition at line 309 of file IBluetoothController.h.

The documentation for this class was generated from the following file: