Bluetooth Mesh Friend Node API#

Bluetooth Mesh Friend Node API.

These commands and events are for the Friend operation, available in nodes which have the Friend feature.

Modules#

sl_btmesh_evt_friend_friendship_established

sl_btmesh_evt_friend_friendship_terminated

Functions#

Macros#

Function Documentation#

sl_btmesh_friend_init#

sl_status_t sl_btmesh_friend_init ()

Initialize the Friend mode. The node needs to be provisioned before calling this command. After the Friend mode is initialized, it is ready to accept friend requests from low-power nodes. This call has to be made before calling the other commands in this class.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7856 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_friend_deinit#

sl_status_t sl_btmesh_friend_deinit ()

Deinitialize the Friend functionality. After calling this command, a possible friendship with a Low Power node is terminated and all friendships are terminated. After calling this command, don't call other commands in this class before the Friend mode is sl_btmesh_friend_init again.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7869 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

Macro Definition Documentation#

sl_btmesh_cmd_friend_init_id#

#define sl_btmesh_cmd_friend_init_id
Value:
0x00240028

Definition at line 7794 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_cmd_friend_deinit_id#

#define sl_btmesh_cmd_friend_deinit_id
Value:
0x01240028

Definition at line 7795 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_rsp_friend_init_id#

#define sl_btmesh_rsp_friend_init_id
Value:
0x00240028

Definition at line 7796 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_rsp_friend_deinit_id#

#define sl_btmesh_rsp_friend_deinit_id
Value:
0x01240028

Definition at line 7797 of file /mnt/raid/workspaces/ws.iS2YF8Lrv/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h