Infuse-IoT SDK API 0.0.1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
epacket_bt_adv APIs

epacket_bt_adv API More...

Macros

#define epacket_bt_adv_frame   epacket_v0_versioned_frame_format

Enumerations

enum  epacket_flags_bt_adv { EPACKET_FLAGS_BT_ADV_INDOORS = BIT(0) }
 Bluetooth advertising specific packet flags. More...

Functions

void epacket_bt_adv_scan_suspend (void)
 Request Bluetooth scanning to be suspended.
void epacket_bt_adv_scan_resume (void)
 Release a request for Bluetooth scanning to be suspended.
void epacket_bt_adv_set_fallback_scan_callback (bt_le_scan_cb_t scan_cb)
 Register a callback to be run on non-Infuse Bluetooth packets.
void epacket_bt_adv_set_interface_flags (enum epacket_flags_bt_adv flags)
 Set constant interface flags for Bluetooth advertising packets.

Detailed Description

epacket_bt_adv API

Macro Definition Documentation

◆ epacket_bt_adv_frame

Enumeration Type Documentation

◆ epacket_flags_bt_adv

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_bt_adv.h>

Bluetooth advertising specific packet flags.

Enumerator
EPACKET_FLAGS_BT_ADV_INDOORS 

Transmitting device is explicitly indoors.

Function Documentation

◆ epacket_bt_adv_scan_resume()

void epacket_bt_adv_scan_resume ( void )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_bt_adv.h>

Release a request for Bluetooth scanning to be suspended.

Release the constraint of Bluetooth scanning created by epacket_bt_adv_scan_suspend.

◆ epacket_bt_adv_scan_suspend()

void epacket_bt_adv_scan_suspend ( void )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_bt_adv.h>

Request Bluetooth scanning to be suspended.

After calling, any active Bluetooth scanning is suspended and any future scanning is disabled until epacket_bt_adv_scan_resume is called.

A call to epacket_receive received between these two function calls will be actioned once epacket_bt_adv_scan_resume is called for the remaining duration.

The duration of any suspension should be tightly bounded to much less than CONFIG_EPACKET_INTERFACE_BT_ADV_SCAN_WATCHDOG_SEC (default 10 minutes).

This can be useful when performing actions where performance is typically degraded by Bluetooth activity, for example writing to internal flash.

◆ epacket_bt_adv_set_fallback_scan_callback()

void epacket_bt_adv_set_fallback_scan_callback ( bt_le_scan_cb_t scan_cb)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_bt_adv.h>

Register a callback to be run on non-Infuse Bluetooth packets.

Only available if CONFIG_EPACKET_INTERFACE_BT_ADV_FALLBACK_SCAN_CALLBACK is enabled

Note
Callback runs from the Bluetooth stack context, blocking function calls should be avoided or deferred to an alternate context.
Parameters
scan_cbCallback to run on non-Infuse Bluetooth packets

◆ epacket_bt_adv_set_interface_flags()

void epacket_bt_adv_set_interface_flags ( enum epacket_flags_bt_adv flags)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/epacket/interface/epacket_bt_adv.h>

Set constant interface flags for Bluetooth advertising packets.

Parameters
flagsFlags to set