System#

System.

Modules#

sl_bt_evt_system_boot

Indicates that the device has started and the radio is ready.

sl_bt_evt_system_error

Indicates that an error has occurred.

sl_bt_evt_system_hardware_error

Indicates that a hardware-related error has occurred.

sl_bt_evt_system_external_signal

Indicates that the external signals have been received.

sl_bt_evt_system_awake

Indicates that the device is awake and no longer in sleep mode.

sl_bt_evt_system_soft_timer

Indicates that a soft timer has lapsed.

Enumerations#

Functions#

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#

enum [sl_bt_system_boot_mode_t](/bluetooth/<docspace-docleaf-version>/bluetooth-commnd-events-system/#ga3ddbb71683836007ff79c6108b60b007)

Specifies the mode that the system will boot into.

sl_bt_system_linklayer_config_key_t#

enum [sl_bt_system_linklayer_config_key_t](/bluetooth/<docspace-docleaf-version>/bluetooth-commnd-events-system/#gabeb0cee19ac79ff0d4789a07e8e185af)

These Keys are used to configure Link Layer Operation.

Function Documentation#

sl_bt_system_hello()#

sl_status_t 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.

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_start_bluetooth()#

sl_status_t 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.

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_stop_bluetooth()#

sl_status_t 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.

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_get_version()#

sl_status_t sl_bt_system_get_version ( uint16_t * major,
                                    uint16_t * minor,
                                    uint16_t * patch,
                                    uint16_t * build,
                                    uint32_t * bootloader,
                                    uint32_t * hash
)

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

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_reset()#

void sl_bt_system_reset (uint8_t dfu)

Reset the system. The command does not have a response but it triggers one of the boot events (normal reset or boot to DFU mode) depending on the selected boot mode.

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

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()#

sl_status_t sl_bt_system_halt (uint8_t 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 (a few seconds at maximum). 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

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_linklayer_configure()#

sl_status_t sl_bt_system_linklayer_configure (uint8_t key,
                                            size_t data_len,
                                            const uint8_t * data)

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

Parameters

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_set_tx_power()#

sl_status_t sl_bt_system_set_tx_power ( int16_t min_power,
                                        int16_t max_power,
                                        int16_t * set_min,
                                        int16_t * set_max
                                      )

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

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_get_tx_power_setting()#

sl_status_t sl_bt_system_get_tx_power_setting ( int16_t * support_min,
                                                int16_t * support_max,
                                                int16_t * set_min,
                                                int16_t * set_max,
                                                int16_t * rf_path_gain
                                              )

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

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_set_identity_address()#

sl_status_t sl_bt_system_set_identity_address ( bd_addr address,
                                                uint8_t type
                                              )

Set the device's Bluetooth identity address. The address can be a public device address or a static device address. A valid address set with this command will be written into persistent storage using NVM keys. 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

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_get_identity_address()#

sl_status_t sl_bt_system_get_identity_address ( bd_addr * address
                                                uint8_t * type
                                              )

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

Parameters

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_get_random_data()#

sl_status_t sl_bt_system_get_random_data ( uint8_t length,
                                           size_t max_data_size,
                                           size_t * data_len,
                                           uint8_t * data
                                          )

Get random data.

Parameters

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_data_buffer_write()#

sl_status_t sl_bt_system_data_buffer_write ( size_t data_len,
                                             const uint8_t * data
                                            )

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

Parameters

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_data_buffer_clear()#

sl_status_t sl_bt_system_data_buffer_clear ()

Remove all data from the system data buffer.

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_get_counters()#

sl_status_t sl_bt_system_get_counters ( uint8_t reset,
                                        uint16_t * tx_packets,
                                        uint16_t * rx_packets,
                                        uint16_t * crc_errors,
                                        uint16_t * failures
                                        )

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

Parameters

Returns

SL_STATUS_OK if successful. Error code otherwise.

sl_bt_system_set_soft_timer()#

SL_BGAPI_DEPRECATED sl_status_t sl_bt_system_set_soft_timer ( uint32_t time,
                                                              uint8_t handle,
                                                              uint8_t single_shot
                                                            )

Deprecated . Use the sleeptimer component (in platform services category) for timers.

Start a software timer. 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

Returns

SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_system_soft_timer - Sent after this timer has lapsed.

sl_bt_system_set_lazy_soft_timer()#

sl_status_t sl_bt_system_set_lazy_soft_timer ( uint32_t time,
                                               uint32_t slack,
                                               uint8_t handle,
                                               uint8_t single_shot
                                               )

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. See also description of sl_bt_system_set_soft_timer command.

Parameters

Returns

SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_system_soft_timer - Sent after this timer has lapsed.