nRF5 SDK for Mesh v5.0.0
Data Fields
instaburst_tx_config_t Struct Reference

Instaburst TX configuration. More...

#include <instaburst_tx.h>

Data Fields

uint8_t set_id
 Set ID for this Instaburst instance. More...
 
const uint8_t * p_channels
 Array of radio channels to send on. More...
 
uint8_t channel_count
 Number of channels in the p_channels array. More...
 
radio_mode_t radio_mode
 Radio mode to run auxiliary packets in. More...
 
radio_tx_power_t tx_power
 TX power to transmit auxiliary packets at. More...
 
instaburst_tx_complete_t callback
 Callback to call when the transmission was completed. More...
 
uint32_t interval_ms
 Transmission interval in milliseconds. More...
 

Detailed Description

Instaburst TX configuration.

Passed to the instaburst_tx_instance_init function to configure an Instaburst TX instance.

Definition at line 95 of file instaburst_tx.h.

Field Documentation

◆ set_id

uint8_t instaburst_tx_config_t::set_id

Set ID for this Instaburst instance.

Cannot be higher than INSTABURST_SET_ID_MAX.

Definition at line 98 of file instaburst_tx.h.

◆ p_channels

const uint8_t* instaburst_tx_config_t::p_channels

Array of radio channels to send on.

No channel can be higher than INSTABURST_CHANNEL_INDEX_MAX.

Definition at line 100 of file instaburst_tx.h.

◆ channel_count

uint8_t instaburst_tx_config_t::channel_count

Number of channels in the p_channels array.

Definition at line 102 of file instaburst_tx.h.

◆ radio_mode

radio_mode_t instaburst_tx_config_t::radio_mode

Radio mode to run auxiliary packets in.

Definition at line 104 of file instaburst_tx.h.

◆ tx_power

radio_tx_power_t instaburst_tx_config_t::tx_power

TX power to transmit auxiliary packets at.

Definition at line 106 of file instaburst_tx.h.

◆ callback

instaburst_tx_complete_t instaburst_tx_config_t::callback

Callback to call when the transmission was completed.

Definition at line 108 of file instaburst_tx.h.

◆ interval_ms

uint32_t instaburst_tx_config_t::interval_ms

Transmission interval in milliseconds.

Must be between BEARER_ADV_INT_MIN_MS and BEARER_ADV_INT_MAX_MS.

Note
: As per the Bluetooth Core Specification, a 10ms randomization is added to the time between transmissions.

Definition at line 116 of file instaburst_tx.h.


The documentation for this struct was generated from the following file:

Documentation feedback | Developer Zone | Subscribe | Updated