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 stack does not produce or consume any messages belonging to this class.

Modules#

sl_bt_evt_user_message_to_host

Functions#

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)
sl_status_t
sl_bt_user_manage_event_filter(size_t data_len, const uint8_t *data)

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)
Parameters
[in]data_len

Length of data in data

[in]data

The message

[in]max_response_size

Size of output buffer passed in response

[out]response_len

On return, set to the length of output data written to response

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


Definition at line 15328 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/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)
Parameters
[in]data_len

Length of data in data

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


Definition at line 15349 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/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.


Definition at line 15361 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/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_id
Value:
0x00ff0020

Definition at line 15281 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_user_manage_event_filter_id#

#define sl_bt_cmd_user_manage_event_filter_id
Value:
0x01ff0020

Definition at line 15282 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_user_reset_to_dfu_id#

#define sl_bt_cmd_user_reset_to_dfu_id
Value:
0x02ff0020

Definition at line 15283 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_user_message_to_target_id#

#define sl_bt_rsp_user_message_to_target_id
Value:
0x00ff0020

Definition at line 15284 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_user_manage_event_filter_id#

#define sl_bt_rsp_user_manage_event_filter_id
Value:
0x01ff0020

Definition at line 15285 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_user_reset_to_dfu_id#

#define sl_bt_rsp_user_reset_to_dfu_id
Value:
0x02ff0020

Definition at line 15286 of file /mnt/raid/workspaces/ws.pY3F1RWXq/overlay/gsdk/protocol/bluetooth/build_release/bt_api/sw/bgapi/inc/sl_bt_api.h