bdk_scan.h File Reference

Go to the source code of this file.

Namespaces
namespace	esphome
namespace	esphome::bk72xx_ble

Enumerations
enum class	esphome::bk72xx_ble::BdkActivityState : uint8_t { esphome::bk72xx_ble::IDLE , esphome::bk72xx_ble::CREATED , esphome::bk72xx_ble::STARTED , esphome::bk72xx_ble::OTHER }
	Scan-relevant controller activity states, read live from the SDK. More...
enum class	esphome::bk72xx_ble::BdkOpResult : uint8_t { esphome::bk72xx_ble::OK , esphome::bk72xx_ble::BUSY , esphome::bk72xx_ble::FAILED }
	Outcome of a BDK scan operation request. More...

Functions
bool	esphome::bk72xx_ble::bdk_scan_ready ()
	True when no controller operation is in flight (APP_BLE_READY).
BdkActivityState	esphome::bk72xx_ble::bdk_scan_state (uint8_t activity_idx)
	Live state of the given activity; INVALID_ACTIVITY_IDX reads as IDLE.
uint8_t	esphome::bk72xx_ble::bdk_scan_acquire_activity ()
	Claim an idle activity slot; INVALID_ACTIVITY_IDX when none is free.
BdkOpResult	esphome::bk72xx_ble::bdk_scan_create (uint8_t activity_idx)
	Create the scan activity (asynchronous); started once CREATED is observed.
BdkOpResult	esphome::bk72xx_ble::bdk_scan_start (uint8_t activity_idx, uint16_t interval, uint16_t window, bool active)
	Start a created activity: the packed GAPM start, taking the scan mode the BDK's own start path hardcodes away.
BdkOpResult	esphome::bk72xx_ble::bdk_scan_release (uint8_t activity_idx, bool created, int *err_out)
	Release the activity: delete when never started (a stop would be rejected), stop otherwise.

Variables
constexpr uint8_t	esphome::bk72xx_ble::INVALID_ACTIVITY_IDX = 0xFF
	Activity index value marking "no scan activity", the BDK's own convention (asserted against its symbol in bdk_scan.cpp).