BLE Mesh Model Configuration Client Interface

Detailed Description

Interface for BLE Mesh Model Configuration Client functions.

Summary

The BLE Mesh interface for the BLE Mesh Model Configuration Client (BLE MESH MODEL CONFIG CLIENT) middleware provides BLE Mesh Model Configuration Client functionality.

Data Structures
struct	rm_ble_mesh_config_client_callback_args_t
struct	rm_ble_mesh_config_client_cfg_t
struct	rm_ble_mesh_config_client_api_t
struct	rm_ble_mesh_config_client_instance_t

Typedefs
typedef void	rm_ble_mesh_config_client_ctrl_t

---

Data Structure Documentation

rm_ble_mesh_config_client_callback_args_t

struct rm_ble_mesh_config_client_callback_args_t

Mesh model client callback parameter definition

Data Fields
void const *	p_context
rm_ble_mesh_access_model_req_msg_context_t *	p_msg_context	Context of message received for a specific model instance.
rm_ble_mesh_access_req_msg_raw_t *	p_msg_raw	Uninterpreted/raw received message for a specific model instance.

rm_ble_mesh_config_client_cfg_t

struct rm_ble_mesh_config_client_cfg_t

BLE mesh model health client configuration parameters.

Data Fields
rm_ble_mesh_access_instance_t const *	p_access_instance
void(*	p_callback )(rm_ble_mesh_config_client_callback_args_t *p_args)
	Callback function.
void const *	p_context
	Placeholder for user data. Passed to the user callback in ble_abs_callback_args_t.
void const *	p_extend
	Placeholder for user extension.

Field Documentation

p_access_instance

rm_ble_mesh_access_instance_t const* rm_ble_mesh_config_client_cfg_t::p_access_instance

the parameters for initialization.

rm_ble_mesh_config_client_api_t

struct rm_ble_mesh_config_client_api_t

Shared Interface definition for BLE MESH

Data Fields
fsp_err_t(*	open )(rm_ble_mesh_config_client_ctrl_t *const p_ctrl, rm_ble_mesh_config_client_cfg_t const *const p_cfg)
fsp_err_t(*	close )(rm_ble_mesh_config_client_ctrl_t *const p_ctrl)
fsp_err_t(*	setServer )(rm_ble_mesh_config_client_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t server_addr, uint8_t *p_dev_key)
fsp_err_t(*	sendReliablePdu )(rm_ble_mesh_config_client_ctrl_t *const p_ctrl, uint32_t req_opcode, void const *const p_parameter, uint32_t rsp_opcode)

Field Documentation

open

fsp_err_t(* rm_ble_mesh_config_client_api_t::open) (rm_ble_mesh_config_client_ctrl_t *const p_ctrl, rm_ble_mesh_config_client_cfg_t const *const p_cfg)

API to open configuration client model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to configuration structure.

close

fsp_err_t(* rm_ble_mesh_config_client_api_t::close) (rm_ble_mesh_config_client_ctrl_t *const p_ctrl)

API to close configuration client model.

Parameters

[in]

p_ctrl

Pointer to control structure.

setServer

fsp_err_t(* rm_ble_mesh_config_client_api_t::setServer) (rm_ble_mesh_config_client_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t server_addr, uint8_t *p_dev_key)

API to set configuration server.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	server_addr	Address of Configuration Server.
[in]	p_dev_key	Pointer to device Key of Configuration Server.

sendReliablePdu

fsp_err_t(* rm_ble_mesh_config_client_api_t::sendReliablePdu) (rm_ble_mesh_config_client_ctrl_t *const p_ctrl, uint32_t req_opcode, void const *const p_parameter, uint32_t rsp_opcode)

API to send acknowledged commands.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	req_opcode	Request Opcode.
[in]	p_parameter	Pointer to parameter associated with Request Opcode.
[in]	rsp_opcode	Response Opcode.

rm_ble_mesh_config_client_instance_t

struct rm_ble_mesh_config_client_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
rm_ble_mesh_config_client_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
rm_ble_mesh_config_client_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
rm_ble_mesh_config_client_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

rm_ble_mesh_config_client_ctrl_t

typedef void rm_ble_mesh_config_client_ctrl_t

BLE MESH CONFIG CLIENT control block. Allocate an instance specific control block to pass into the BLE mesh model health client API calls.