R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more information

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

ble_gap_opt_ch_map_t Struct Reference

ble_gap_opt_ch_map_t Struct Reference

Channel Map option. More...

#include <ble_gap.h>

Data Fields

uint16_t conn_handle
 Connection Handle (only applicable for get)
uint8_t ch_map [5]
 Channel Map (37-bit).

Detailed Description

Channel Map option.

Used with sd_ble_opt_get to get the current channel map or sd_ble_opt_set to set a new channel map. When setting the channel map, it applies to all current and future connections. When getting the current channel map, it applies to a single connection and the connection handle must be supplied.

Setting the channel map may take some time, depending on connection parameters. The time taken may be different for each connection and the get operation will return the previous channel map until the new one has taken effect.
After setting the channel map, by spec it can not be set again until at least 1 s has passed. See Bluetooth Specification Version 4.1 Volume 2, Part E, Section 7.3.46.
Return values:
NRF_SUCCESSGet or set successful.
NRF_ERROR_BUSYChannel map was set again before enough time had passed.
NRF_ERROR_INVALID_STATEInvalid state to perform operation.
BLE_ERROR_INVALID_CONN_HANDLEInvalid connection handle supplied for get.
NRF_ERROR_NOT_SUPPORTEDReturned by sd_ble_opt_set in peripheral-only SoftDevices.

Definition at line 768 of file ble_gap.h.

Field Documentation

uint8_t ch_map[5]

Channel Map (37-bit).

Definition at line 771 of file ble_gap.h.

uint16_t conn_handle

Connection Handle (only applicable for get)

Definition at line 770 of file ble_gap.h.