BLE Mesh Model Client Interface

Detailed Description

Interface for BLE Mesh Model Client functions.

Summary

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

Data Structures
struct	rm_ble_mesh_model_client_callback_args_t
struct	rm_ble_mesh_model_client_cfg_t
struct	rm_ble_mesh_model_client_api_t
struct	rm_ble_mesh_model_client_instance_t

Typedefs
typedef void	rm_ble_mesh_model_client_ctrl_t

---

Data Structure Documentation

rm_ble_mesh_model_client_callback_args_t

struct rm_ble_mesh_model_client_callback_args_t

Mesh model client callback parameter definition

Data Fields
void const *	p_context	Placeholder for user data.
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_model_client_cfg_t

struct rm_ble_mesh_model_client_cfg_t

BLE mesh model health client configuration parameters.

Data Fields
rm_ble_mesh_access_instance_t const *	p_access_instance
	Access Layer instance structure. More...
void(*	p_callback )(rm_ble_mesh_model_client_callback_args_t *p_args)
	Mesh model client callback.
void const *	p_context
	Placeholder for user data.
void const *	p_extend
	Placeholder for user extension.

Field Documentation

p_access_instance

rm_ble_mesh_access_instance_t const* rm_ble_mesh_model_client_cfg_t::p_access_instance

Access Layer instance structure.

the parameters for initialization.

rm_ble_mesh_model_client_api_t

struct rm_ble_mesh_model_client_api_t

Shared Interface definition for BLE MESH

Data Fields
fsp_err_t(*	open )(rm_ble_mesh_model_client_ctrl_t *const p_ctrl, rm_ble_mesh_model_client_cfg_t const *const p_cfg)
fsp_err_t(*	close )(rm_ble_mesh_model_client_ctrl_t *const p_ctrl)
fsp_err_t(*	getModelHandle )(rm_ble_mesh_model_client_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t *const p_model_handle)
fsp_err_t(*	sendReliablePdu )(rm_ble_mesh_model_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_model_client_api_t::open) (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, rm_ble_mesh_model_client_cfg_t const *const p_cfg)

API to open client model.

Parameters

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

close

fsp_err_t(* rm_ble_mesh_model_client_api_t::close) (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

API to close client model.

Parameters

[in]

p_ctrl

Pointer to control structure.

getModelHandle

fsp_err_t(* rm_ble_mesh_model_client_api_t::getModelHandle) (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t *const p_model_handle)

API to get Model client model handle.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_model_handle	Pointer to model handle to be filled/returned.

sendReliablePdu

fsp_err_t(* rm_ble_mesh_model_client_api_t::sendReliablePdu) (rm_ble_mesh_model_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_model_client_instance_t

struct rm_ble_mesh_model_client_instance_t

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

Data Fields
rm_ble_mesh_model_client_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
rm_ble_mesh_model_client_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
rm_ble_mesh_model_client_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

rm_ble_mesh_model_client_ctrl_t

typedef void rm_ble_mesh_model_client_ctrl_t

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