Fast Pair Find Hub Network API

Fast Pair Find Hub Network (FHN) extension API. More...

Data Structures
struct	bt_fast_pair_fhn_ring_req_param
struct	bt_fast_pair_fhn_ring_cb
struct	bt_fast_pair_fhn_ring_state_param
struct	bt_fast_pair_fhn_motion_detector_cb
	Motion detector callback structure. More...
struct	bt_fast_pair_fhn_adv_param
struct	bt_fast_pair_fhn_info_cb
struct	bt_fast_pair_fhn_read_mode_cb

Macros
#define	BT_FAST_PAIR_FHN_RING_COMP_BM_NONE   (0x00)
#define	BT_FAST_PAIR_FHN_RING_COMP_BM_ALL   (0xFF)
#define	BT_FAST_PAIR_FHN_RING_MSEC_PER_DSEC   (100U)
#define	BT_FAST_PAIR_FHN_RING_TIMEOUT_DS_TO_MS(_timeout_ds)
	Convert the ringing timeout value from deciseconds to milliseconds.
#define	BT_FAST_PAIR_FHN_RING_TIMEOUT_MS_TO_DS(_timeout_ms)
	Convert the ringing timeout value from milliseconds to deciseconds.
#define	BT_FAST_PAIR_FHN_BATTERY_LEVEL_NONE   (0xFF)
#define	BT_FAST_PAIR_FHN_ADV_PARAM_INIT(_int_min, _int_max)
#define	BT_FAST_PAIR_FHN_ADV_PARAM_DEFAULT

Enumerations
enum	bt_fast_pair_fhn_ring_src { BT_FAST_PAIR_FHN_RING_SRC_FHN_BT_GATT , BT_FAST_PAIR_FHN_RING_SRC_DULT_BT_GATT , BT_FAST_PAIR_FHN_RING_SRC_DULT_MOTION_DETECTOR }
	Ringing activity source types. More...
enum	bt_fast_pair_fhn_ring_comp { BT_FAST_PAIR_FHN_RING_COMP_RIGHT = BIT(0) , BT_FAST_PAIR_FHN_RING_COMP_LEFT = BIT(1) , BT_FAST_PAIR_FHN_RING_COMP_CASE = BIT(2) }
enum	bt_fast_pair_fhn_ring_volume { BT_FAST_PAIR_FHN_RING_VOLUME_DEFAULT = 0x00 , BT_FAST_PAIR_FHN_RING_VOLUME_LOW = 0x01 , BT_FAST_PAIR_FHN_RING_VOLUME_MEDIUM = 0x02 , BT_FAST_PAIR_FHN_RING_VOLUME_HIGH = 0x03 }
enum	bt_fast_pair_fhn_ring_trigger {   BT_FAST_PAIR_FHN_RING_TRIGGER_STARTED = 0x00 , BT_FAST_PAIR_FHN_RING_TRIGGER_FAILED = 0x01 , BT_FAST_PAIR_FHN_RING_TRIGGER_TIMEOUT_STOPPED = 0x02 , BT_FAST_PAIR_FHN_RING_TRIGGER_UI_STOPPED = 0x03 ,   BT_FAST_PAIR_FHN_RING_TRIGGER_GATT_STOPPED = 0x04 }
enum	bt_fast_pair_fhn_read_mode { BT_FAST_PAIR_FHN_READ_MODE_FHN_RECOVERY , BT_FAST_PAIR_FHN_READ_MODE_DULT_ID }

Functions
int	bt_fast_pair_fhn_ring_cb_register (const struct bt_fast_pair_fhn_ring_cb *cb)
	Register the ringing callbacks in the FHN module.
int	bt_fast_pair_fhn_ring_state_update (enum bt_fast_pair_fhn_ring_src src, const struct bt_fast_pair_fhn_ring_state_param *param)
	Update the ringing state in the FHN module.
int	bt_fast_pair_fhn_motion_detector_cb_register (const struct bt_fast_pair_fhn_motion_detector_cb *cb)
	Register motion detector callbacks.
int	bt_fast_pair_fhn_battery_level_set (uint8_t percentage_level)
	Set the current battery level.
int	bt_fast_pair_fhn_adv_param_set (const struct bt_fast_pair_fhn_adv_param *adv_param)
	Set the FHN advertising parameters.
int	bt_fast_pair_fhn_id_set (uint8_t id)
	Set the Bluetooth identity for the FHN extension.
bool	bt_fast_pair_fhn_is_provisioned (void)
	Check the FHN provisioning state.
int	bt_fast_pair_fhn_info_cb_register (struct bt_fast_pair_fhn_info_cb *cb)
	Register the information callbacks in the FHN module.
int	bt_fast_pair_fhn_read_mode_cb_register (const struct bt_fast_pair_fhn_read_mode_cb *cb)
	Register the read mode callbacks in the FHN module.
int	bt_fast_pair_fhn_read_mode_enter (enum bt_fast_pair_fhn_read_mode mode)
	Enter read mode.

Detailed Description

Fast Pair Find Hub Network (FHN) extension API.

It is required to use the Fast Pair FHN API in the cooperative thread context. API function exceptions that do not follow this rule mention alternative requirements explicitly in their API documentation. Following the cooperative thread context requirement guarantees proper synchronization between the user operations and the module operations.