BGAPI Types#
Common types in BGAPI protocol.
Modules#
Macros#
The length of a BGAPI message header which is 4 bytes.
The length of the BGAPI message payload of a generic error response.
Get the device type of a BGAPI message.
Get the identifier of a BGAPI message including device type, class ID, message type and message ID.
Get the data payload length in a BGAPI message.
The bit indicating whether data of a BGAPI message is encrypted.
Check whether data of a BGAPI message is encrypted.
Construct a BGAPI message header from an event ID and payload length.
Macro Definition Documentation#
SL_BT_TYPE_UINT8ARRARY#
#define SL_BT_TYPE_UINT8ARRARY
75
of file include/sl_bgapi.h
SL_BT_TYPE_BYTE_ARRARY#
#define SL_BT_TYPE_BYTE_ARRARY
84
of file include/sl_bgapi.h
SL_BT_TYPE_AES_KEY128#
#define SL_BT_TYPE_AES_KEY128
109
of file include/sl_bgapi.h
SL_BGAPI_MSG_HEADER_LEN#
#define SL_BGAPI_MSG_HEADER_LENValue:
(4)
The length of a BGAPI message header which is 4 bytes.
160
of file include/sl_bgapi.h
SL_BGAPI_MSG_ERROR_PAYLOAD_LEN#
#define SL_BGAPI_MSG_ERROR_PAYLOAD_LENValue:
(2)
The length of the BGAPI message payload of a generic error response.
See function sl_bgapi_set_error_response for how to generate a generic error response.
168
of file include/sl_bgapi.h
SL_BGAPI_MSG_DEVICE_TYPE#
#define SL_BGAPI_MSG_DEVICE_TYPEValue:
(HDR)
Get the device type of a BGAPI message.
175
of file include/sl_bgapi.h
SL_BGAPI_MSG_ID#
#define SL_BGAPI_MSG_IDValue:
(HDR)
Get the identifier of a BGAPI message including device type, class ID, message type and message ID.
183
of file include/sl_bgapi.h
SL_BGAPI_MSG_LEN#
#define SL_BGAPI_MSG_LENValue:
(HDR)
Get the data payload length in a BGAPI message.
190
of file include/sl_bgapi.h
SL_BGAPI_BIT_ENCRYPTED#
#define SL_BGAPI_BIT_ENCRYPTEDValue:
(1 << 6)
The bit indicating whether data of a BGAPI message is encrypted.
195
of file include/sl_bgapi.h
SL_BGAPI_MSG_ENCRYPTED#
#define SL_BGAPI_MSG_ENCRYPTEDValue:
(HDR)
Check whether data of a BGAPI message is encrypted.
202
of file include/sl_bgapi.h
SL_BGAPI_MSG_HEADER_FROM_ID_AND_LEN#
#define SL_BGAPI_MSG_HEADER_FROM_ID_AND_LENValue:
Construct a BGAPI message header from an event ID and payload length.
It is the caller's responsibility to verify that the input values are within valid range.
Returns
The header as a
uint32_t
value
216
of file include/sl_bgapi.h