|
SmartSnippets DA1459x SDK
|
BLE configuration options. More...
Modules | |
| BLE_EVENT_NOTIFICATIONS | |
| Doxygen documentation is not yet available for this module. Please check the source code file(s) | |
Files | |
| file | ble_config.h |
| BLE configuration options. | |
Macros | |
| #define | dg_configBLE_CONNECTIONS_MAX (2) |
| Define the maximum number of connections. More... | |
| #define | dg_configBLE_OBSERVER (1) |
| Enable the Observer role in the BLE framework. More... | |
| #define | dg_configBLE_BROADCASTER (1) |
| Enable the Broadcaster role in the BLE framework. More... | |
| #define | dg_configBLE_CENTRAL (1) |
| Enable the Central role in the BLE framework. More... | |
| #define | dg_configBLE_PERIPHERAL (1) |
| Enable the Peripheral role in the BLE framework. More... | |
| #define | dg_configBLE_GATT_CLIENT (1) |
| Enable the GATT Client role in the BLE framework. More... | |
| #define | dg_configBLE_GATT_SERVER (1) |
| Enable the GATT Server role in the BLE framework. More... | |
| #define | dg_configBLE_L2CAP_COC (1) |
| Enable L2CAP CoC (Connection Oriented Channels) in the BLE framework. More... | |
| #define | dg_configBLE_EVENT_COUNTER_ENABLE (0) |
| Enable Event Counters in BLE ISR. More... | |
| #define | dg_configBLE_ADV_STOP_DELAY_ENABLE (0) |
| Enable ADV_UNDERRUN workaround. More... | |
| #define | dg_configBLE_SKIP_LATENCY_API (0) |
| Enable the ble_gap_skip_latency() API. More... | |
| #define | dg_configBLE_PRIVACY_1_2 (0) |
| Enable LE Privacy v1.2 functionality. More... | |
| #define | dg_configBLE_DATA_LENGTH_RX_MAX (251) |
| Maximum Receive Data Channel PDU Payload Length. More... | |
| #define | dg_configBLE_DATA_LENGTH_TX_MAX (251) |
| Maximum Transmit Data Channel PDU Payload Length. More... | |
| #define | BLE_DATA_LENGTH_TO_TIME(OCTETS) ( ( (OCTETS) + 11 + 3 ) * 8 ) |
| Convert Receive/Transmit Data Length to Time. | |
| #define | dg_configBLE_CONN_EVENT_LENGTH_MIN |
| Minimum Connection Event Length. More... | |
| #define | dg_configBLE_CONN_EVENT_LENGTH_MAX (0xFFFF) |
| Maximum Connection Event Length. More... | |
| #define | dg_configBLE_DUPLICATE_FILTER_MAX (10) |
| Duplicate Filtering List Maximum size. More... | |
| #define | dg_configBLE_PAIR_INIT_KEY_DIST (GAP_KDIST_ENCKEY | GAP_KDIST_IDKEY | GAP_KDIST_SIGNKEY) |
| Security keys to be distributed by the pairing initiator. More... | |
| #define | dg_configBLE_PAIR_RESP_KEY_DIST (GAP_KDIST_ENCKEY | GAP_KDIST_IDKEY | GAP_KDIST_SIGNKEY) |
| Security keys to be distributed by the pairing responder. More... | |
| #define | dg_configBLE_SECURE_CONNECTIONS (1) |
| Enable Secure Connections. More... | |
| #define | dg_configBLE_INITIAL_TX_POWER (GAP_TX_POWER_0_dBm) |
| Pairing successes threshold for renewing the public key (DEPRECATED) More... | |
| #define | dg_configDEFAULT_RADIO_OP_MODE (LOW_POWER_ALL_PHYS) |
| Set Radio Power mode. More... | |
| #define | dg_configRF_CALIB_TEMP_DIFF (8) |
| Set temperature difference trigger for RF calibration (in Celsius degrees) More... | |
| #define | dg_configRF_CALIB_TEMP_POLL_INTV (1000) |
| Set temperature poll interval (in milliseconds) More... | |
| #define | defaultBLE_DEVICE_NAME "Dialog BLE" |
| Default device name (GAP service attribute only) More... | |
| #define | defaultBLE_APPEARANCE (0) |
| Default appearance (GAP service attribute only) More... | |
| #define | defaultBLE_MAX_CONNECTIONS (CFG_CON) |
| Default maximum number of simultaneous connections. More... | |
| #define | defaultBLE_MAX_BONDED (8) |
| Default maximum number of bonded devices. More... | |
| #define | defaultBLE_GAP_ROLE GAP_NO_ROLE |
| Default GAP role. More... | |
| #define | defaultBLE_ADDRESS_RENEW_DURATION (900) |
| Default random address renew duration. More... | |
| #define | defaultBLE_STATIC_ADDRESS { 0x06, 0x00, 0xF4, 0x35, 0x23, 0x48 } |
| Default static BD address. More... | |
| #define | defaultBLE_ADDRESS_TYPE PUBLIC_ADDRESS |
| Default BD address type. More... | |
| #define | defaultBLE_IRK |
| Default Identity Resolution Key. More... | |
| #define | defaultBLE_ATT_DB_CONFIGURATION (0x10) |
| Default attribute database configuration. More... | |
| #define | defaultBLE_MAX_MTU_SIZE (512) |
| Maximum MTU size. More... | |
| #define | defaultBLE_MIN_MTU_SIZE (65) |
| Minimum MTU size. More... | |
| #define | defaultBLE_MTU_SIZE (defaultBLE_MIN_MTU_SIZE) |
| Default MTU size. More... | |
| #define | defaultBLE_CHANNEL_MAP {0xFF, 0xFF, 0xFF, 0xFF, 0x1F} |
| Default channel map (for central role only) More... | |
| #define | defaultBLE_ADVERTISE_MODE GAP_DISC_MODE_GEN_DISCOVERABLE |
| Default advertising mode. More... | |
| #define | defaultBLE_ADVERTISE_CHANNEL_MAP (GAP_ADV_CHANNEL_37 | GAP_ADV_CHANNEL_38 | GAP_ADV_CHANNEL_39) |
| Default channels used for advertising. More... | |
| #define | defaultBLE_ADVERTISE_INTERVAL_MIN (BLE_ADV_INTERVAL_FROM_MS(687.5)) |
| Default minimum interval used for advertising. More... | |
| #define | defaultBLE_ADVERTISE_INTERVAL_MAX (BLE_ADV_INTERVAL_FROM_MS(687.5)) |
| Default maximum interval used for advertising. More... | |
| #define | defaultBLE_ADVERTISE_FILTER_POLICY ADV_ALLOW_SCAN_ANY_CONN_ANY |
| Default filtering policy used for advertising. More... | |
| #define | defaultBLE_ADVERTISE_DATA_LENGTH (28) |
| Default advertising data length. More... | |
| #define | defaultBLE_ADVERTISE_DATA |
| Default advertising Data. More... | |
| #define | defaultBLE_SCAN_RESPONSE_DATA_LENGTH (31) |
| Default scan response data length. More... | |
| #define | defaultBLE_SCAN_RESPONSE_DATA { } |
| Default scan response Data. More... | |
| #define | defaultBLE_SCAN_INTERVAL (BLE_SCAN_INTERVAL_FROM_MS(100)) |
| Default scan interval. More... | |
| #define | defaultBLE_SCAN_WINDOW (BLE_SCAN_WINDOW_FROM_MS(50)) |
| Default scan window. More... | |
| #define | defaultBLE_PPCP_INTERVAL_MIN (BLE_CONN_INTERVAL_FROM_MS(10)) |
| Default peripheral preferred minimum connection interval. More... | |
| #define | defaultBLE_PPCP_INTERVAL_MAX (BLE_CONN_INTERVAL_FROM_MS(20)) |
| Default peripheral preferred maximum connection interval. More... | |
| #define | defaultBLE_PPCP_SLAVE_LATENCY (0) |
| Default peripheral preferred slave latency. More... | |
| #define | defaultBLE_PPCP_SUP_TIMEOUT (BLE_SUPERVISION_TMO_FROM_MS(1000)) |
| Default peripheral preferred supervision timeout. More... | |
| #define | defaultBLE_GAP_IO_CAP GAP_IO_CAP_NO_INPUT_OUTPUT |
| Default Input/Output capabilities. More... | |
| #define | defaultBLE_DIS_MANUFACTURER "Renesas Electronics Corporation" |
| Device Information Service default data. More... | |
| #define | USE_BLE_SLEEP 1 |
| Use passthrough mode. More... | |
| #define | dg_configBLE_2MBIT_PHY (1) |
| Enable 2MBIT PHY. More... | |
| #define | dg_configBLE_UUID_SUOTA_SERVICE (0xFEF5) |
| Set the UUID of the SUOTA service. More... | |
BLE configuration options.
The following tags are used to describe the type of each configuration option.
| #define defaultBLE_ADDRESS_RENEW_DURATION (900) |
Default random address renew duration.
Default duration for random address generation when a random resolvable or a random non-resolvable address has been set using ble_gap_address_set().
| #define defaultBLE_ADDRESS_TYPE PUBLIC_ADDRESS |
Default BD address type.
Default BD address type used if one is not set using ble_gap_address_set().
| #define defaultBLE_ADVERTISE_CHANNEL_MAP (GAP_ADV_CHANNEL_37 | GAP_ADV_CHANNEL_38 | GAP_ADV_CHANNEL_39) |
Default channels used for advertising.
Default channel used for advertising if they are not set using ble_gap_adv_chnl_map_set().
| #define defaultBLE_ADVERTISE_DATA |
Default advertising Data.
Default advertising data are set to advertise the device name. If the application should have specific advertising data, these should be set using the ble_gap_adv_data_set().
| #define defaultBLE_ADVERTISE_DATA_LENGTH (28) |
Default advertising data length.
Default length of advertising data. This is set to the maximum value allowed by the stack, which is 28 bytes.
| #define defaultBLE_ADVERTISE_FILTER_POLICY ADV_ALLOW_SCAN_ANY_CONN_ANY |
Default filtering policy used for advertising.
Default filtering policy used for advertising if one is not set using ble_gap_adv_filt_policy_set().
| #define defaultBLE_ADVERTISE_INTERVAL_MAX (BLE_ADV_INTERVAL_FROM_MS(687.5)) |
Default maximum interval used for advertising.
Default maximum interval used for advertising in steps of 0.625ms if one is not set using ble_gap_adv_intv_set().
| #define defaultBLE_ADVERTISE_INTERVAL_MIN (BLE_ADV_INTERVAL_FROM_MS(687.5)) |
Default minimum interval used for advertising.
Default minimum interval used for advertising in steps of 0.625ms if one is not set using ble_gap_adv_intv_set().
| #define defaultBLE_ADVERTISE_MODE GAP_DISC_MODE_GEN_DISCOVERABLE |
Default advertising mode.
Default mode used for advertising if one is not set using ble_gap_adv_mode_set().
| #define defaultBLE_APPEARANCE (0) |
Default appearance (GAP service attribute only)
Appearance used for GAP service attribute.
| #define defaultBLE_ATT_DB_CONFIGURATION (0x10) |
Default attribute database configuration.
* Default attribute database configuration: * 7 6 5 4 3 2 1 0 * +-----+-----+----+-----+-----+----+----+----+ * | DBG | RFU | SC | PCP | APP_PERM |NAME_PERM| * +-----+-----+----+-----+-----+----+----+----+ * - Bit [0-1]: Device Name write permission requirements for peer device (see gapm_write_att_perm) * - Bit [2-3]: Device Appearance write permission requirements for peer device (see gapm_write_att_perm) * - Bit [4] : Slave Preferred Connection Parameters present * - Bit [5] : Service change feature present in GATT attribute database. * - Bit [6] : Reserved * - Bit [7] : Enable Debug Mode *
| #define defaultBLE_CHANNEL_MAP {0xFF, 0xFF, 0xFF, 0xFF, 0x1F} |
Default channel map (for central role only)
Default channel map used when device is configured with the central role if one is not set using ble_gap_channel_map_set().
| #define defaultBLE_DEVICE_NAME "Dialog BLE" |
Default device name (GAP service attribute only)
Device Name used for GAP service attribute.
| #define defaultBLE_DIS_MANUFACTURER "Renesas Electronics Corporation" |
Device Information Service default data.
| #define defaultBLE_GAP_IO_CAP GAP_IO_CAP_NO_INPUT_OUTPUT |
Default Input/Output capabilities.
Default input/output capabilities set for pairing procedures if they are not set using the ble_gap_set_io_cap().
| #define defaultBLE_GAP_ROLE GAP_NO_ROLE |
Default GAP role.
Default GAP role set at start-up, if not set otherwise using ble_gap_role_set(), ble_peripheral_start() or ble_central_start()).
| #define defaultBLE_IRK |
Default Identity Resolution Key.
Default Identity Resolution Key to be used upon IRK exchange.
| #define defaultBLE_MAX_BONDED (8) |
Default maximum number of bonded devices.
Maximum number of bonded devices for which bonding data can be maintained in persistent storage.
| #define defaultBLE_MAX_CONNECTIONS (CFG_CON) |
Default maximum number of simultaneous connections.
Maximum number of connections that can maintained simultaneously.
| #define defaultBLE_MAX_MTU_SIZE (512) |
Maximum MTU size.
Maximum supported MTU size.
| #define defaultBLE_MIN_MTU_SIZE (65) |
Minimum MTU size.
Minimum supported MTU size as defined by Bluetooth SIG:
| #define defaultBLE_MTU_SIZE (defaultBLE_MIN_MTU_SIZE) |
Default MTU size.
Default MTU size used on MTU exchange negotiations if one is not set using ble_gap_mtu_size_set().
| #define defaultBLE_PPCP_INTERVAL_MAX (BLE_CONN_INTERVAL_FROM_MS(20)) |
Default peripheral preferred maximum connection interval.
Default maximum connection interval set in the peripheral preferred connection parameters attribute in steps of 1.25ms if one is not set using ble_gap_per_pref_conn_params_set().
| #define defaultBLE_PPCP_INTERVAL_MIN (BLE_CONN_INTERVAL_FROM_MS(10)) |
Default peripheral preferred minimum connection interval.
Default minimum connection interval set in the peripheral preferred connection parameters attribute in steps of 1.25ms if one is not set using ble_gap_per_pref_conn_params_set().
| #define defaultBLE_PPCP_SLAVE_LATENCY (0) |
Default peripheral preferred slave latency.
Default slave latency set in the peripheral preferred connection parameters attribute in number of events if one is not set using ble_gap_per_pref_conn_params_set().
| #define defaultBLE_PPCP_SUP_TIMEOUT (BLE_SUPERVISION_TMO_FROM_MS(1000)) |
Default peripheral preferred supervision timeout.
Default supervision timeout set in the peripheral preferred connection parameters attribute in steps of 10ms if one is not set using ble_gap_per_pref_conn_params_set().
| #define defaultBLE_SCAN_INTERVAL (BLE_SCAN_INTERVAL_FROM_MS(100)) |
Default scan interval.
Default interval used for scanning in steps of 0.625ms if one is not set using ble_gap_scan_params_set().
| #define defaultBLE_SCAN_RESPONSE_DATA { } |
Default scan response Data.
Default scan response data are set to zero. If the application should have specific scan response data, these should be set using the ble_gap_adv_data_set().
| #define defaultBLE_SCAN_RESPONSE_DATA_LENGTH (31) |
Default scan response data length.
Default length of scan response data. This is set to the maximum value allowed by the stack, which is 31 bytes.
| #define defaultBLE_SCAN_WINDOW (BLE_SCAN_WINDOW_FROM_MS(50)) |
Default scan window.
Default window used for scanning in steps of 0.625ms if one is not set using ble_gap_scan_params_set().
| #define defaultBLE_STATIC_ADDRESS { 0x06, 0x00, 0xF4, 0x35, 0x23, 0x48 } |
Default static BD address.
Default static BD address set if one is not retrieved from the non-volatile storage.
| #define dg_configBLE_2MBIT_PHY (1) |
Enable 2MBIT PHY.
This is defined by default to 1 to enable LE 2MBIT PHY.
| #define dg_configBLE_ADV_STOP_DELAY_ENABLE (0) |
Enable ADV_UNDERRUN workaround.
If the application has not defined dg_configBLE_ADV_STOP_DELAY_ENABLE in its custom_config file, this is defined to the default value of 0 to disable the ADV_UNDERRUN workaround in the BLE adapter.
| #define dg_configBLE_BROADCASTER (1) |
Enable the Broadcaster role in the BLE framework.
By default, all roles are supported by the BLE framework. However, if the application does not use the Broadcaster role, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_CENTRAL (1) |
Enable the Central role in the BLE framework.
By default, all roles are supported by the BLE framework. However, if the application does not use the Central role, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_CONN_EVENT_LENGTH_MAX (0xFFFF) |
Maximum Connection Event Length.
Maximum length for connection events in steps of 0.625ms. This is set to a "don't care" value since the BLE stack uses only dg_configBLE_CONN_EVENT_LENGTH_MIN to determine the connection event length to use for a given connection.
| #define dg_configBLE_CONN_EVENT_LENGTH_MIN |
Minimum Connection Event Length.
Minimum length for Connection Event in steps of 0.625ms. This is calculated based on the maximum LE Data Lengths defined for reception and transmission (dg_configBLE_DATA_LENGTH_RX_MAX and dg_configBLE_DATA_LENGTH_TX_MAX respectively) plus 150us for the IFS.
| #define dg_configBLE_CONNECTIONS_MAX (2) |
Define the maximum number of connections.
Define what will be the maximum number of connections. The minimum supported number by the BLE stack is 1 connection and the maximum is 8 connections. The default value for the DA1459X device family is 2 connections and for the rest is 8 connections.
| #define dg_configBLE_DATA_LENGTH_RX_MAX (251) |
Maximum Receive Data Channel PDU Payload Length.
If the application has not defined dg_configBLE_DATA_LENGTH_RX_MAX in its custom_config file, this is defined to the maximum value allowed by Bluetooth Core v_4.2, which is 251 octets.
| #define dg_configBLE_DATA_LENGTH_TX_MAX (251) |
Maximum Transmit Data Channel PDU Payload Length.
If the application has not defined dg_configBLE_DATA_LENGTH_TX_MAX in its custom_config file, this is defined to the maximum value allowed by Bluetooth Core v_4.2, which is 251 octets.
| #define dg_configBLE_DUPLICATE_FILTER_MAX (10) |
Duplicate Filtering List Maximum size.
This defines the size of the list used for duplicate filtering. When the duplicate filtering list is full, additional advertising reports or scan responses will be dropped.
| #define dg_configBLE_EVENT_COUNTER_ENABLE (0) |
Enable Event Counters in BLE ISR.
If the application has not defined dg_configBLE_EVENT_COUNTER_ENABLE in its custom_config file, this is defined to the default value of 0 to disable the Event Counters in BLE stack ISR.
| #define dg_configBLE_GATT_CLIENT (1) |
Enable the GATT Client role in the BLE framework.
By default, all GATT roles are supported by the BLE framework. However, if the application does not use the GATT Client role, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_GATT_SERVER (1) |
Enable the GATT Server role in the BLE framework.
By default, all GATT roles are supported by the BLE framework. However, if the application does not use the GATT Server role, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_INITIAL_TX_POWER (GAP_TX_POWER_0_dBm) |
Pairing successes threshold for renewing the public key (DEPRECATED)
This option is deprecated. The P-256 Public/Private Key Pair is automatically renewed by the stack prior to every pairing procedure.
Pairing failures threshold for renewing the public key (DEPRECATED)
This option is deprecated. The P-256 Public/Private Key Pair is automatically renewed by the stack prior to every pairing procedure.
Set initial BLE TX power for any operation
If the application has not defined dg_configBLE_INITIAL_TX_POWER in its custom configuration file, this is defined by default to 0 dBm.
| #define dg_configBLE_L2CAP_COC (1) |
Enable L2CAP CoC (Connection Oriented Channels) in the BLE framework.
If the application does not use L2CAP CoC, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_OBSERVER (1) |
Enable the Observer role in the BLE framework.
By default, all roles are supported by the BLE framework. However, if the application does not use the Observer role, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_PAIR_INIT_KEY_DIST (GAP_KDIST_ENCKEY | GAP_KDIST_IDKEY | GAP_KDIST_SIGNKEY) |
Security keys to be distributed by the pairing initiator.
This defines which security keys will be requested to be distributed by the pairing initiator during a pairing feature exchange procedure.
Available keys for distribution:
| #define dg_configBLE_PAIR_RESP_KEY_DIST (GAP_KDIST_ENCKEY | GAP_KDIST_IDKEY | GAP_KDIST_SIGNKEY) |
Security keys to be distributed by the pairing responder.
This defines which security keys will be requested to be distributed by the pairing responder during a pairing feature exchange procedure.
Available keys for distribution:
| #define dg_configBLE_PERIPHERAL (1) |
Enable the Peripheral role in the BLE framework.
By default, all roles are supported by the BLE framework. However, if the application does not use the Peripheral role, it can define this macro to 0 in its custom config file to reduce code size.
| #define dg_configBLE_PRIVACY_1_2 (0) |
Enable LE Privacy v1.2 functionality.
To use this feature, ble_gap_address_set() should be called using the PRIVATE_CNTL address type. The configuration of the Resolving Address List (RAL) is handled by the BLE Manager and will be used by the Link Layer when advertising, scanning or connection procedures take place. RAL will be automatically updated when new bonds are created or existing bonds are removed.
| #define dg_configBLE_SECURE_CONNECTIONS (1) |
Enable Secure Connections.
If the application has not defined dg_configBLE_SECURE_CONNECTIONS in its custom configuration file, this is defined by default to 1 to enable LE Secure Connections.
| #define dg_configBLE_SKIP_LATENCY_API (0) |
Enable the ble_gap_skip_latency() API.
| #define dg_configBLE_UUID_SUOTA_SERVICE (0xFEF5) |
Set the UUID of the SUOTA service.
| #define dg_configDEFAULT_RADIO_OP_MODE (LOW_POWER_ALL_PHYS) |
Set Radio Power mode.
| #define dg_configRF_CALIB_TEMP_DIFF (8) |
Set temperature difference trigger for RF calibration (in Celsius degrees)
Define the temperature difference in Celsius degrees after which the RF calibration will be triggered.
| #define dg_configRF_CALIB_TEMP_POLL_INTV (1000) |
Set temperature poll interval (in milliseconds)
Define the temperature measurement poll interval (in milliseconds) used for RF calibration.
| #define USE_BLE_SLEEP 1 |
Use passthrough mode.
If application has enabled the external host configuration, BLE stack is configured for pass-through mode.
Use BLE sleep mode
Macro USE_BLE_SLEEP controls whether BLE will be set to sleep when it is not needed to be active.
1.8.16