nimble_scanner.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019-2021 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef NIMBLE_SCANNER_H
#define NIMBLE_SCANNER_H
 
#include <errno.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "host/ble_hs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NIMBLE_SCANNER_EXT_ADV          0x80
 
enum {
    NIMBLE_SCANNER_PASSIVE      = 0x01,     
    NIMBLE_SCANNER_LIMITED      = 0x02,     
    NIMBLE_SCANNER_FILTER_DUPS  = 0x04,     
    NIMBLE_SCANNER_PHY_1M       = 0x10,     
#if IS_USED(MODULE_NIMBLE_PHY_CODED)
    NIMBLE_SCANNER_PHY_CODED    = 0x20,     
#endif
};
 
enum {
    NIMBLE_SCANNER_COMPLETE     = BLE_HCI_ADV_DATA_STATUS_COMPLETE,
    NIMBLE_SCANNER_INCOMPLETE   = BLE_HCI_ADV_DATA_STATUS_INCOMPLETE,
    NIMBLE_SCANNER_TRUNCATED    = BLE_HCI_ADV_DATA_STATUS_TRUNCATED,
};
 
typedef struct {
    uint16_t itvl_ms;       
    uint16_t win_ms;        
    uint8_t flags;          
} nimble_scanner_cfg_t;
 
typedef struct {
    uint8_t status;
    uint8_t phy_pri;        
    uint8_t phy_sec;        
    int8_t rssi;            
} nimble_scanner_info_t;
 
typedef void(*nimble_scanner_cb)(uint8_t type, const ble_addr_t *addr,
                                 const nimble_scanner_info_t *info,
                                 const uint8_t *ad, size_t ad_len);
 
int nimble_scanner_init(const nimble_scanner_cfg_t *params,
                        nimble_scanner_cb disc_cb);
 
int nimble_scanner_start(void);
 
void nimble_scanner_stop(void);
 
static inline bool nimble_scanner_is_active(void)
{
    return ble_gap_disc_active();
}
 
void nimble_scanner_set_scan_duration(int32_t duration_ms);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NIMBLE_SCANNER_H */