mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-30 03:25:23 +00:00
6a679a92db
Fills in all missing API documentation for the public Bluetooth Mesh API, and unifies the formatting of all entries. Some defines and enum values have been left without documentation in cases where the meaning is self explanatory, and documentation wouldn't add any value. Structure members that are just internal parameters are left without documentation, as this also hides them from the generated documentation output. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
43 lines
816 B
C
43 lines
816 B
C
/** @file
|
|
* @brief Bluetooth Mesh Proxy APIs.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2017 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_MESH_PROXY_H_
|
|
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_PROXY_H_
|
|
|
|
/**
|
|
* @brief Bluetooth Mesh Proxy
|
|
* @defgroup bt_mesh_proxy Bluetooth Mesh Proxy
|
|
* @ingroup bt_mesh
|
|
* @{
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** @brief Enable advertising with Node Identity.
|
|
*
|
|
* This API requires that GATT Proxy support has been enabled. Once called
|
|
* each subnet will start advertising using Node Identity for the next
|
|
* 60 seconds.
|
|
*
|
|
* @return 0 on success, or (negative) error code on failure.
|
|
*/
|
|
int bt_mesh_proxy_identity_enable(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_PROXY_H_ */
|