System#

System.

  sl_bt_system_linklayer_config_key_clr_flags = 0x5, sl_bt_system_linklayer_config_key_set_afh_interval = 0x7, sl_bt_system_linklayer_config_key_set_priority_table = 0x9, sl_bt_system_linklayer_config_key_set_rx_packet_filtering = 0xa,

  sl_bt_system_linklayer_config_key_set_simultaneous_scanning = 0xb, sl_bt_system_linklayer_config_key_set_channelmap_flags = 0xc, sl_bt_system_linklayer_config_key_power_control_golden_range = 0x10, sl_bt_system_linklayer_config_key_active_scanner_backoff_upper_limit = 0x11,

  sl_bt_system_linklayer_config_key_afh_rssi_threshold = 0x12, sl_bt_system_linklayer_config_key_afh_channel_cooldown = 0x13, sl_bt_system_linklayer_config_key_set_report_all_scan_rsps = 0x14

} | | | These Keys are used to configure Link Layer Operation. | | |

Detailed Description#

System.

Commands and events in this class can be used to access and query the local device.

Enumeration Type Documentation#

◆sl_bt_system_boot_mode_t#

Specifies the mode that the system will boot into.

◆sl_bt_system_linklayer_config_key_t#

These Keys are used to configure Link Layer Operation.

• 0x00000002 - Disable Feature Exchange in central role of the connection | | sl_bt_system_linklayer_config_key_clr_flags  | (0x5) The value is flags to clear. Flags are the same as in SET_FLAGS command. | | sl_bt_system_linklayer_config_key_set_afh_interval  | (0x7) Set the afh_scan_interval. Value is in units of 10 ms. Setting the interval to 0 will result in using the default value of 1 second. | | sl_bt_system_linklayer_config_key_set_priority_table  | (0x9) The value contains a priority table to be copied over the existing table. If the value is smaller than the full table, only those values are updated. See sl_bt_bluetooth_ll_priorities struct for the definition of a priority table. | | sl_bt_system_linklayer_config_key_set_rx_packet_filtering  | (0xa) Configure and enable or disable RX packet filtering feature. Value: >= 5 bytes.* Byte 1 - The filter count

• Byte 2 - The filter offset

• Byte 3 - The length of the filter list

• Byte 4 - The bitmask flags

• Rest of the data - The filter list | | sl_bt_system_linklayer_config_key_set_simultaneous_scanning  | (0xb) Enable or disable simultaneous scanning on the 1M and Coded PHYs. Value: 1 byte.* 0 - Disable simultaneous scanning.

• 1 - Enable simultaneous scanning. | | sl_bt_system_linklayer_config_key_set_channelmap_flags  | (0xc) Configure channelmap adaptivity flags. Value: 4 bytes. | | sl_bt_system_linklayer_config_key_power_control_golden_range  | (0x10) Power control golden range configuration. The first byte of the value is the lower boundary and the second byte is the upper boundary. Values are in dBm. Set golden range parameters. Value: 8 bytes.* Byte 1 - Minimal RSSI on 1M PHY

• Byte 2 - Maximal RSSI on 1M PHY

• Byte 3 - Minimal RSSI on 2M PHY

• Byte 4 - Maximal RSSI on 2M PHY

• Byte 5 - Minimal RSSI on Coded PHY S=8

• Byte 6 - Maximal RSSI on Coded PHY S=8

• Byte 7 - Minimal RSSI on Coded PHY S=2

• Byte 8 - Maximal RSSI on Coded PHY S=2 | | sl_bt_system_linklayer_config_key_active_scanner_backoff_upper_limit  | (0x11) Value: uint16_t Adjust upper limit for backoff counter. If 0 restores default value of 256 Value must be between 16 - 256 | | sl_bt_system_linklayer_config_key_afh_rssi_threshold  | (0x12) Value: int8_t Configures RSSI limit for AFH channel blocking | | sl_bt_system_linklayer_config_key_afh_channel_cooldown  | (0x13) Value: int16_t Configures how long channel is blocked after activity is detected Default: 8000 | | sl_bt_system_linklayer_config_key_set_report_all_scan_rsps  | (0x14) Value: uint8_t 0 - default, only reports scan responses that is received after sending scan_req nonzero - Will report all scan responses that are received on primary advertising channels |

Function Documentation#

◆sl_bt_system_hello()#

Verify whether the communication between the host and the device is functional.

NOTE: This command is available even if the Bluetooth stack has not been started. See sl_bt_system_start_bluetooth for description of how the Bluetooth stack is started.

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_start_bluetooth()#

If the Bluetooth on-demand start component is not included in the application build, the Bluetooth stack is automatically started at UC initialization time. In this configuration, the on-demand start command is not available and the command returns the error SL_STATUS_NOT_AVAILABLE.

When the Bluetooth on-demand start component is included in the application build, this command is used by the application to request starting the Bluetooth stack when the application needs it. If the command returns a success result, the stack starts to asynchronously allocate the resources and configure the Bluetooth stack based on the configuration passed at UC initialization time.

Successful start of the stack is indicated by the sl_bt_evt_system_boot event. The configured classes and Bluetooth stack features are available after the application has received the sl_bt_evt_system_boot event. If starting the Bluetooth stack fails, the error is indicated to the application with the sl_bt_evt_system_error event.

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_stop_bluetooth()#

If the Bluetooth on-demand start component is not included in the application build, the Bluetooth stack is automatically started at UC initialization time and never stopped. In this configuration, the stop command is not available and the command returns the error SL_STATUS_NOT_AVAILABLE.

When the Bluetooth on-demand start component is included in the application build, this command is used by the application to stop the Bluetooth stack when the application no longer needs it. This command gracefully restores Bluetooth to an idle state by disconnecting any active connections and stopping any on-going advertising and scanning. Any resources that were allocated when the stack was started are freed when the stack is stopped. After this command, the BGAPI classes other than System become unavailable. The application can use the command sl_bt_system_start_bluetooth to continue using Bluetooth later.

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_get_version()#

Get the firmware version information.

NOTE: This command is available even if the Bluetooth stack has not been started. See sl_bt_system_start_bluetooth for description of how the Bluetooth stack is started.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_reset()#

Reset the system. This command does not have a response.

On EFR series 1 devices, this command boots into the given mode and triggers one of the boot events (normal reset or boot to DFU mode) depending on the given boot mode.

On EFR series 2 devices, the dfu parameter is ignored and this command always boots the user application. To boot into a DFU mode on series 2, use the Bootloader API bootloader_rebootAndInstall.

NOTE: This command is available even if the Bluetooth stack has not been started. See sl_bt_system_start_bluetooth for description of how the Bluetooth stack is started.

Parameters

• sl_bt_system_boot_mode_uart_dfu (0x1): Boot to UART DFU mode

• sl_bt_system_boot_mode_ota_dfu (0x2): Boot to OTA DFU mode

This parameter is ignored on EFR series 2 devices. |

Events

• sl_bt_evt_system_boot - Sent after the device has booted in normal mode.

• sl_bt_evt_dfu_boot - Sent after the device has booted in UART DFU mode.

◆sl_bt_system_halt()#

Force radio to idle state and allow device to sleep. Advertising, scanning, connections, and software timers are halted by this command. Halted operations resume after calling this command with parameter 0. Connections stay alive if the system is resumed before connection supervision timeout.

Use this command only for a short time period (maximum few seconds). Although it halts Bluetooth activity, all tasks and operations still exist inside the stack with their own concepts of time. Halting the system for a long time period may have negative consequences on stack's internal states.

NOTE: The software timer is also halted. Hardware interrupts are the only way to wake up from energy mode 2 when the system is halted.

Parameters

• 0: resume |

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_linklayer_configure()#

Send configuration data to the link layer. This command fine tunes low-level Bluetooth operations.

Parameters

• sl_bt_system_linklayer_config_key_priority_range (0x2): Sets the RAIL priority_mapping offset field of the link layer priority configuration structure to the first byte of the value field.

• sl_bt_system_linklayer_config_key_scan_channels (0x3): Sets channels to scan on. The first byte of the value is the channel map. 0x1 = Channel 37, 0x2 = Channel 38, 0x4 = Channel 39

• sl_bt_system_linklayer_config_key_set_flags (0x4): Sets the link layer configuration flags. The value is a little endian 32-bit integer. Flag Values:

  • 0x00000001 - Disable Feature Exchange in peripheral role of the connection

  • 0x00000002 - Disable Feature Exchange in central role of the connection

• sl_bt_system_linklayer_config_key_clr_flags (0x5): The value is flags to clear. Flags are the same as in SET_FLAGS command.

• sl_bt_system_linklayer_config_key_set_afh_interval (0x7): Set the afh_scan_interval. Value is in units of 10 ms. Setting the interval to 0 will result in using the default value of 1 second.

• sl_bt_system_linklayer_config_key_set_priority_table (0x9): The value contains a priority table to be copied over the existing table. If the value is smaller than the full table, only those values are updated. See sl_bt_bluetooth_ll_priorities struct for the definition of a priority table.

• sl_bt_system_linklayer_config_key_set_rx_packet_filtering (0xa): Configure and enable or disable RX packet filtering feature. Value: >= 5 bytes.

  • Byte 1 - The filter count

  • Byte 2 - The filter offset

  • Byte 3 - The length of the filter list

  • Byte 4 - The bitmask flags

  • Rest of the data - The filter list

• sl_bt_system_linklayer_config_key_set_simultaneous_scanning (0xb): Enable or disable simultaneous scanning on the 1M and Coded PHYs. Value: 1 byte.

  • 0 - Disable simultaneous scanning.

  • 1 - Enable simultaneous scanning.

• sl_bt_system_linklayer_config_key_set_channelmap_flags (0xc): Configure channelmap adaptivity flags. Value: 4 bytes.

• sl_bt_system_linklayer_config_key_power_control_golden_range (0x10): Power control golden range configuration. The first byte of the value is the lower boundary and the second byte is the upper boundary. Values are in dBm. Set golden range parameters. Value: 8 bytes.

  • Byte 1 - Minimal RSSI on 1M PHY

  • Byte 2 - Maximal RSSI on 1M PHY

  • Byte 3 - Minimal RSSI on 2M PHY

  • Byte 4 - Maximal RSSI on 2M PHY

  • Byte 5 - Minimal RSSI on Coded PHY S=8

  • Byte 6 - Maximal RSSI on Coded PHY S=8

  • Byte 7 - Minimal RSSI on Coded PHY S=2

  • Byte 8 - Maximal RSSI on Coded PHY S=2

• sl_bt_system_linklayer_config_key_active_scanner_backoff_upper_limit (0x11): Value: uint16_t Adjust upper limit for backoff counter. If 0 restores default value of 256 Value must be between 16 - 256

• sl_bt_system_linklayer_config_key_afh_rssi_threshold (0x12): Value: int8_t Configures RSSI limit for AFH channel blocking

• sl_bt_system_linklayer_config_key_afh_channel_cooldown (0x13): Value: int16_t Configures how long channel is blocked after activity is detected Default: 8000

• sl_bt_system_linklayer_config_key_set_report_all_scan_rsps (0x14): Value: uint8_t 0 - default, only reports scan responses that is received after sending scan_req nonzero - Will report all scan responses that are received on primary advertising channels | | [in] | data_len | Length of data in data | | [in] | data | Configuration data. Length and contents of the data field depend on the key value used. |

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_set_tx_power()#

Set the global minimum and maximum radiated TX power levels for Bluetooth. This returns selected power levels that are radiated from the antenna at TX. The transmitter power at antenna pin will apply the RF TX path gain to match this setting. RF TX path gain can be set in the Bluetooth configuration. If the GATT server contains a TX power service, the TX Power Level attribute will be updated with the selected maximum power level.

A selected power level may be different than the requested value because of Bluetooth feature restrictions or the device's radio characteristics. For Bluetooth connections, the maximum radiated TX power is limited to 10 dBm if Adaptive Frequency Hopping (AFH) is not enabled.

The minimum TX power setting is used by LE power control. It has no effect in Bluetooth stack if the LE power control feature is not enabled. However, the application may still use this setting for other purposes, e.g., setting the minimum TX power for DTM transmitter test.

The minimum and maximum radiated TX power levels can also be configured in the Bluetooth configuration and passed into the Bluetooth stack initialization. By default, the minimum radiated TX power level is configured to -3 dBm and the maximum radiated TX power level to 8 dBm.

NOTE: Do not use this command while advertising or scanning. Furthermore, the stack does not allow setting TX powers during connections.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_get_tx_power_setting()#

Get TX power settings including the minimum and maximum radiated TX power levels the device supports, the minimum and maximum radiated TX power levels currently set in the stack, and the TX RF path gain configuration.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_set_identity_address()#

Store the device's Bluetooth identity address in persistent storage using NVM keys. The address can be a public device address or a static device address. The stack returns an error if the static device address does not conform to the Bluetooth specification.

The new address will be effective in the next system reboot. The stack will use the address in the NVM keys when present. Otherwise, it uses the default Bluetooth public device address which is programmed at production.

The stack treats 00:00:00:00:00:00 and ff:ff:ff:ff:ff:ff as invalid addresses. Therefore, passing one of them into this command will cause the stack to delete the NVM keys and use the default address in the next system reboot.

Note: Because the NVM keys are located in flash and flash wearing can occur, avoid calling this command regularly.

Parameters

• 1: Static device address |

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_get_identity_address()#

Read the Bluetooth identity address used by the device, which can be a public or random static device address.

Parameters

• 1: Static random address |

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_get_random_data()#

Get random data.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_data_buffer_write()#

Write data into the system data buffer. Data will be appended to the end of existing data.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_data_buffer_clear()#

Remove all data from the system data buffer.

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_get_counters()#

Get packet and error counters. Passing a non-zero value also resets counters.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

◆sl_bt_system_set_lazy_soft_timer()#

Deprecated . Use the sleeptimer component (in platform services category) for timers. As the sleeptimer does not support a timer with slack yet, the Bluetooth stack will continue to support this command until another component provides the functionality.

Start a software timer with slack. The slack parameter allows the stack to optimize wakeups and save power. The timer event is triggered between time and time + slack.

Multiple concurrent timers can be running simultaneously. 256 unique timer handles (IDs) are available. The maximum number of concurrent timers is configurable at device initialization. Up to 16 concurrent timers can be configured. The default configuration is 4. As the RAM for storing timer data is pre-allocated at initialization, an application should not configure the amount more than it needs for minimizing RAM usage.

Parameters

• 1: true (timer runs only once) |

ReturnsSL_STATUS_OK if successful. Error code otherwise. Events

• sl_bt_evt_system_soft_timer - Sent after this timer has lapsed.