ruuvi_interface_communication_ble_advertising.h

Go to the documentation of this file.

#ifndef RUUVI_INTERFACE_COMMUNICATION_BLE_ADVERTISING_H
#define RUUVI_INTERFACE_COMMUNICATION_BLE_ADVERTISING_H
 
#include "ruuvi_driver_enabled_modules.h"
#include "ruuvi_driver_error.h"
#include "ruuvi_interface_communication.h"
#include "ruuvi_interface_communication_radio.h"
#include <stdint.h>
 
#if RI_ADV_ENABLED
#   define RUUVI_NRF5_SDK15_ADV_ENABLED RUUVI_NRF5_SDK15_ENABLED
#   define RUUVI_NRF5_SDK15_ADV_EXTENDED_ENABLED RI_ADV_EXTENDED_ENABLED
#endif
 
#define RUUVI_COMM_BLE_ADV_MAX_LENGTH  (RI_COMM_BLE_PAYLOAD_MAX_LENGTH)
#define RUUVI_COMM_BLE_ADV_SCAN_LENGTH (RUUVI_COMM_BLE_ADV_MAX_LENGTH)
#define RUUVI_COMM_BLE_ADV_SCAN_BUFFER (RUUVI_COMM_BLE_ADV_MAX_LENGTH)
 
/* @brief number of bytes in a MAC address */
#define BLE_MAC_ADDRESS_LENGTH 6
 
typedef enum
{
    NONCONNECTABLE_NONSCANNABLE, 
    CONNECTABLE_NONSCANNABLE,    
    CONNECTABLE_SCANNABLE,       
    NONCONNECTABLE_SCANNABLE     
} ri_adv_type_t;                 
 
typedef struct
{
    uint8_t addr[BLE_MAC_ADDRESS_LENGTH];  //<! MAC address, MSB first
    int8_t rssi;      
    uint8_t data[RUUVI_COMM_BLE_ADV_SCAN_LENGTH]; 
    size_t data_len;  
    bool is_coded_phy; 
    uint8_t primary_phy; 
    uint8_t secondary_phy; 
    uint8_t ch_index; 
    int8_t tx_power; 
} ri_adv_scan_t;      
 
rd_status_t ri_adv_init (ri_comm_channel_t * const channel);
 
void ri_adv_rx_ble_phy_enabled_set (const bool is_le_1m_phy_enabled,
                                    const bool is_le_2m_phy_enabled,
                                    const bool is_le_coded_phy_enabled);
 
void ri_adv_rx_set_max_advertisement_data_length (const uint8_t max_adv_length);
 
/*
 * @brief Uninitializes advertising module and scanning module.
 *
 * @param[out] channel comm api to send and receive data via advertisements.
 * @retval RD_SUCCESS on success or if radio was not initialized.
 * @retval RD_ERROR_INVALID_STATE if radio hardware was initialized by another radio module.
 */
rd_status_t ri_adv_uninit (ri_comm_channel_t * const channel);
 
/*
 * @brief Setter for broadcast advertisement interval.
 *
 * Will take effect on next send. Has no effect on messages already queued.
 *
 * @param[in] ms Milliseconds, random delay of 0 - 10 ms will be added to the interval on
 *               every TX to avoid collisions. min 100 ms, max 10 000 ms.
 * @retval RD_SUCCESS on success,
 * @retval RD_ERROR_INVALID_PARAM if the parameter is outside allowed range.
 */
rd_status_t ri_adv_tx_interval_set (const uint32_t ms);
 
rd_status_t ri_adv_tx_interval_get (uint32_t * ms);
 
rd_status_t ri_adv_manufacturer_id_set (const uint16_t id);
 
rd_status_t ri_adv_channels_set (const ri_radio_channels_t channels);
 
 
rd_status_t ri_adv_tx_power_set (int8_t * dbm);
 
rd_status_t ri_adv_tx_power_get (int8_t * dbm);
 
rd_status_t ri_adv_scan_response_setup (const char * const name,
                                        const bool advertise_nus);
 
rd_status_t ri_adv_type_set (ri_adv_type_t type);
 
rd_status_t ri_adv_stop (void);
 
rd_status_t ri_adv_scan_start (const uint32_t window_interval_ms,
                               const uint32_t window_size_ms);
 
rd_status_t ri_adv_scan_stop (void);
 
rd_status_t ri_adv_channels_enable (const ri_radio_channels_t channel);
 
uint16_t ri_adv_parse_manuid (uint8_t * const data,
                              const size_t data_length);
 
void ri_adv_enable_uuid (const bool enable_uuid);
 
void ri_adv_set_service_uuid (const uint16_t uuid);
 
#endif