fast_pair.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_FAST_PAIR_FAST_PAIR_H_
#define BT_FAST_PAIR_FAST_PAIR_H_
 
#include <zephyr/bluetooth/bluetooth.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_FAST_PAIR_BATTERY_LEVEL_UNKNOWN      0x7f
 
enum bt_fast_pair_adv_mode {
        BT_FAST_PAIR_ADV_MODE_DISC,
 
        BT_FAST_PAIR_ADV_MODE_NOT_DISC,
 
        BT_FAST_PAIR_ADV_MODE_COUNT
};
 
enum bt_fast_pair_not_disc_adv_type {
        BT_FAST_PAIR_NOT_DISC_ADV_TYPE_SHOW_UI_IND,
 
        BT_FAST_PAIR_NOT_DISC_ADV_TYPE_HIDE_UI_IND,
 
        BT_FAST_PAIR_NOT_DISC_ADV_TYPE_COUNT
};
 
enum bt_fast_pair_adv_battery_mode {
        BT_FAST_PAIR_ADV_BATTERY_MODE_NONE,
 
        BT_FAST_PAIR_ADV_BATTERY_MODE_SHOW_UI_IND,
 
        BT_FAST_PAIR_ADV_BATTERY_MODE_HIDE_UI_IND,
 
        BT_FAST_PAIR_ADV_BATTERY_MODE_COUNT
};
 
enum bt_fast_pair_battery_comp {
        BT_FAST_PAIR_BATTERY_COMP_LEFT_BUD = 0,
 
        BT_FAST_PAIR_BATTERY_COMP_RIGHT_BUD = 1,
 
        BT_FAST_PAIR_BATTERY_COMP_BUD_CASE = 2,
 
        BT_FAST_PAIR_BATTERY_COMP_COUNT
};
 
struct bt_fast_pair_disc_adv_info {};
 
struct bt_fast_pair_not_disc_adv_info {
        enum bt_fast_pair_not_disc_adv_type type;
 
        enum bt_fast_pair_adv_battery_mode battery_mode;
};
 
struct bt_fast_pair_adv_config {
        enum bt_fast_pair_adv_mode mode;
 
        union {
                struct bt_fast_pair_disc_adv_info disc;
 
                struct bt_fast_pair_not_disc_adv_info not_disc;
        };
};
 
struct bt_fast_pair_battery {
        bool charging;
 
        uint8_t level;
};
 
struct bt_fast_pair_info_cb {
        void (*account_key_written)(struct bt_conn *conn);
 
        sys_snode_t node;
};
 
int bt_fast_pair_enable(void);
 
int bt_fast_pair_disable(void);
 
bool bt_fast_pair_is_ready(void);
 
size_t bt_fast_pair_adv_data_size(struct bt_fast_pair_adv_config fp_adv_config);
 
int bt_fast_pair_adv_data_fill(struct bt_data *adv_data, uint8_t *buf, size_t buf_size,
                               struct bt_fast_pair_adv_config fp_adv_config);
 
void bt_fast_pair_set_pairing_mode(bool pairing_mode);
 
bool bt_fast_pair_has_account_key(void);
 
int bt_fast_pair_battery_set(enum bt_fast_pair_battery_comp battery_comp,
                             struct bt_fast_pair_battery battery);
 
int bt_fast_pair_info_cb_register(struct bt_fast_pair_info_cb *cb);
 
int bt_fast_pair_factory_reset(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_FAST_PAIR_FAST_PAIR_H_ */