bt_mesh_friend_set() function

Enable or disable the Friend feature. Any active friendships will be terminated immediately if the Friend feature is disabled. Support for the Friend feature must be enabled through the @c CONFIG_BT_MESH_FRIEND configuration option.

Syntax

Show:

Summary

Declaration

Definition

from cfg.h:201

int bt_mesh_friend_set(enum bt_mesh_feat_state friendship);

Implemented in cfg.c:139

Arguments

Argument

Description

friendship

New Friend feature state. Must be one of BT_MESH_FEATURE_ENABLED and BT_MESH_FEATURE_DISABLED.

Return value

0 Successfully changed the Friend feature state. -ENOTSUP The Friend feature is not supported. -EINVAL Invalid parameter. -EALREADY Already in the given state.

Examples

References

from examples

bt_mesh_friend_set() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle