User Messaging#
User Messaging.
This class provides commands and events, which can be used by a NCP host and target to implement a communication mechanism with a custom proprietary protocol. An application must decide whether and how the command and event are used. The Bluetooth host stack does not produce or consume any messages belonging to this class.
Modules#
sl_bt_evt_user_message_to_host
sl_bt_evt_user_cs_service_message_to_host
Functions#
Macros#
Function Documentation#
sl_bt_user_message_to_target#
sl_status_t sl_bt_user_message_to_target (size_t data_len, const uint8_t * data, size_t max_response_size, size_t * response_len, uint8_t * response)
[in] | data_len | Length of data in |
[in] | data | The message |
[in] | max_response_size | Size of output buffer passed in |
[out] | response_len | On return, set to the length of output data written to |
[out] | response | The response message |
Used by an NCP host to send a message to the target application on device. The application on the target must send the response with sl_bt_send_rsp_user_message_to_target.
Returns
SL_STATUS_OK if successful. Error code otherwise.
14785
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_user_manage_event_filter#
sl_status_t sl_bt_user_manage_event_filter (size_t data_len, const uint8_t * data)
[in] | data_len | Length of data in |
[in] | data | The message for managing event filter |
Manage NCP event filter. When the event filter is in use, API events passing the filter will be sent to the host and those that do not pass are discarded by the target. For functionality details, see the NCP component in the Bluetooth SDK.
By default, the NCP does not use the event filter.
Returns
SL_STATUS_OK if successful. Error code otherwise.
14806
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_user_reset_to_dfu#
void sl_bt_user_reset_to_dfu ()
Reset the target device to DFU mode from the NCP host. This command is used by specific SDK DFU component on the target device for the functionality related to DFU. Do not use it in other circumstances. This command does not have a response.
14818
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_user_cs_service_message_to_target#
sl_status_t sl_bt_user_cs_service_message_to_target (size_t data_len, const uint8_t * data, size_t max_response_size, size_t * response_len, uint8_t * response)
[in] | data_len | Length of data in |
[in] | data | The message |
[in] | max_response_size | Size of output buffer passed in |
[out] | response_len | On return, set to the length of output data written to |
[out] | response | The response message |
Used by an NCP host to send a message to the Channel Sounding service component on target device. The Channel Sounding service on target device must send the response with sl_bt_send_rsp_user_cs_service_message_to_target.
Returns
SL_STATUS_OK if successful. Error code otherwise.
14837
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
Macro Definition Documentation#
sl_bt_cmd_user_message_to_target_id#
#define sl_bt_cmd_user_message_to_target_idValue:
0x00ff0020
14714
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_cmd_user_manage_event_filter_id#
#define sl_bt_cmd_user_manage_event_filter_idValue:
0x01ff0020
14715
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_cmd_user_reset_to_dfu_id#
#define sl_bt_cmd_user_reset_to_dfu_idValue:
0x02ff0020
14716
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_cmd_user_cs_service_message_to_target_id#
#define sl_bt_cmd_user_cs_service_message_to_target_idValue:
0x03ff0020
14717
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_rsp_user_message_to_target_id#
#define sl_bt_rsp_user_message_to_target_idValue:
0x00ff0020
14718
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_rsp_user_manage_event_filter_id#
#define sl_bt_rsp_user_manage_event_filter_idValue:
0x01ff0020
14719
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_rsp_user_reset_to_dfu_id#
#define sl_bt_rsp_user_reset_to_dfu_idValue:
0x02ff0020
14720
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h
sl_bt_rsp_user_cs_service_message_to_target_id#
#define sl_bt_rsp_user_cs_service_message_to_target_idValue:
0x03ff0020
14721
of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/sw/bgapi/inc/sl_bt_api.h