Overview#

  This document contains the full API reference for the Silicon Labs Bluetooth Software.

The Blue Gecko family of the Silicon Labs' Bluetooth chipsets deliver a high performance, low energy and easy-to-use Bluetooth solution integrated into a small form factor package.

The ultra-low power operating modes and fast wake-up times of the Silicon Labs' energy friendly 32-bit MCUs, combined with the low transmit and receive power consumption of the Bluetooth radio, result in a solution optimized for battery powered applications.

API Payload#

The parameters of a Bluetooth API command, response, or event are passed between the application and firmware in a payload. For example, a parameter of uint32_t type uses 4 bytes of the payload space. A byte array parameter uses one byte to describe the length of the array. Data in the array is copied into the remaining free payload space.

API Payload Size#

The payload size is configurable using SL_BGAPI_MAX_PAYLOAD_SIZE. The configurable range is from 256 bytes (minimum) to 2047 bytes (maximum).

The API library validates payload sizes when commands are called:

• SL_STATUS_COMMAND_TOO_LONG (0x49): Returned when the combined size of input parameters exceeds the configured payload size limit.

• SL_STATUS_WOULD_OVERFLOW (0x1d): Returned when the buffer size provided for an output parameter is insufficient to hold the response data.

Decode API Binary Data#

For decoding a message in binary format, see Decode a BGAPI Message.

Deprecations#

Deprecated commands, enumerations, and events are documented in this API reference manual. It is highly recommended to migrate to the replacements as early as possible. A deprecated command may not support new features although it remains functional on current Bluetooth stack. Deprecated items will be removed in some future release.