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#

sl_status_t
sl_btmesh_friend_init(void)
sl_status_t
sl_btmesh_friend_deinit(void)

Macros#

#define
sl_btmesh_cmd_friend_init_id 0x00240028
#define
sl_btmesh_cmd_friend_deinit_id 0x01240028
#define
sl_btmesh_rsp_friend_init_id 0x00240028
#define
sl_btmesh_rsp_friend_deinit_id 0x01240028

Function Documentation#

sl_btmesh_friend_init#

sl_status_t sl_btmesh_friend_init (void )
Parameters
TypeDirectionArgument NameDescription
voidN/A

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.


sl_btmesh_friend_deinit#

sl_status_t sl_btmesh_friend_deinit (void )
Parameters
TypeDirectionArgument NameDescription
voidN/A

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.