Functions
fsp_err_t	RM_MESH_SENSOR_CLT_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	RM_MESH_SENSOR_CLT_Close (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

fsp_err_t	RM_MESH_SENSOR_CLT_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	RM_MESH_SENSOR_CLT_SendReliablePdu (rm_ble_mesh_model_client_ctrl_t const p_ctrl, uint32_t req_opcode, void const const p_parameter, uint32_t rsp_opcode)

fsp_err_t	RM_MESH_SENSOR_CLT_DescriptorGet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_Get (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_ColumnGet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_SeriesGet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_CadenceGet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_CadenceSet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_CadenceSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_SettingsGet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_SettingGet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_SettingSet (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

fsp_err_t	RM_MESH_SENSOR_CLT_SettingSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t const p_ctrl, void const const p_parameter)

Detailed Description

Overview

Target Devices

The BLE Mesh Network Sensor Client module supports the following devices.

RA4W1

Configuration

Build Time Configurations for rm_mesh_sensor_clt

The following build time configurations are defined in fsp_cfg/rm_mesh_sensor_clt_cfg.h:

Configuration	Options	Default	Description

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Sensor Client (rm_mesh_sensor_clt)

This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Sensor Client (rm_mesh_sensor_clt).

Configuration	Options	Default	Description
Interrupts
Callback Provided when Timeout Occurs	Name Must Be a Valid C Symbol	NULL	Callback provided when mesh sensor client ISR occurs
Name	Name Must Be a Valid C Symbol	g_rm_mesh_sensor_clt0	Module name.

Data Structures
struct	rm_mesh_sensor_clt_instance_ctrl_t

Data Structure Documentation

◆ rm_mesh_sensor_clt_instance_ctrl_t

struct rm_mesh_sensor_clt_instance_ctrl_t

BLE mesh sensor instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_SENSOR_CLT_Open() is called.

Function Documentation

◆ RM_MESH_SENSOR_CLT_Open()

fsp_err_t RM_MESH_SENSOR_CLT_Open	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		rm_ble_mesh_model_client_cfg_t const *const	p_cfg
	)

Open Sensor Client middleware. This is to initialize Sensor Client model and to register with Access layer.

Implements rm_ble_mesh_model_client_api_t::open.

Example:

    /* Open the module. */
    err = RM_MESH_SENSOR_CLT_Open(&g_mesh_sensor_clt0_ctrl, &g_mesh_sensor_clt0_cfg);

Return values

FSP_SUCCESS	Model opened successfully.
FSP_ERR_ASSERTION	Pointer to control block or configuration structure is NULL.
FSP_ERR_ALREADY_OPEN	Model is already open.
FSP_ERR_NOT_FOUND	The number of models has exceeded the limit.
FSP_ERR_ABORTED	Model initialization is failed.

◆ RM_MESH_SENSOR_CLT_Close()

fsp_err_t RM_MESH_SENSOR_CLT_Close ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Close Sensor Client middleware.

Implements rm_ble_mesh_model_client_api_t::close.

Example:

    /* Close the module. */
    err = RM_MESH_SENSOR_CLT_Close(&g_mesh_sensor_clt0_ctrl);

Return values

FSP_SUCCESS	Model successfully closed.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.

◆ RM_MESH_SENSOR_CLT_GetModelHandle()

fsp_err_t RM_MESH_SENSOR_CLT_GetModelHandle	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		rm_ble_mesh_access_model_handle_t *const	p_model_handle
	)

This is to get the handle of Sensor client model.

Implements rm_ble_mesh_model_client_api_t::getModelHandle.

Example:

    /* Get the handle of sensor client model. */
    err = RM_MESH_SENSOR_CLT_GetModelHandle(&g_mesh_sensor_clt0_ctrl, &model_handle);

Return values

FSP_SUCCESS	Got model handle successfully.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_POINTER	The parameter p_model_handle is NULL.

◆ RM_MESH_SENSOR_CLT_SendReliablePdu()

fsp_err_t RM_MESH_SENSOR_CLT_SendReliablePdu	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		uint32_t	req_opcode,
		void const *const	p_parameter,
		uint32_t	rsp_opcode
	)

This is to initialize sending acknowledged commands.

Implements rm_ble_mesh_model_client_api_t::sendReliablePdu.

Example:

    /* Initialize sending acknowledged commands. */
    err = RM_MESH_SENSOR_CLT_SendReliablePdu(&g_mesh_sensor_clt0_ctrl, req_opcode, p_parameter, rsp_opcode);

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_DescriptorGet()

fsp_err_t RM_MESH_SENSOR_CLT_DescriptorGet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Descriptor Get is an acknowledged message used to get the Sensor Descriptor state of all sensors within an element. The response to a Sensor Descriptor Get message is a Sensor Descriptor Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Descriptor Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_Get()

fsp_err_t RM_MESH_SENSOR_CLT_Get	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Get is an acknowledged message used to get the Sensor Data state. The response to the Sensor Get message is a Sensor Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_ColumnGet()

fsp_err_t RM_MESH_SENSOR_CLT_ColumnGet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Column Get is an acknowledged message used to get the Sensor Series Column state. The response to the Sensor Column Get message is a Sensor Column Status message

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Column Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_SeriesGet()

fsp_err_t RM_MESH_SENSOR_CLT_SeriesGet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Series Get is an acknowledged message used to get a sequence of the Sensor Series Column states. The response to the Sensor Series Get message is a Sensor Series Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Series Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_CadenceGet()

fsp_err_t RM_MESH_SENSOR_CLT_CadenceGet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Cadence Get is an acknowledged message used to get the Sensor Cadence state of an element. The response to the Sensor Cadence Get message is a Sensor Cadence Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Cadence Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_CadenceSet()

fsp_err_t RM_MESH_SENSOR_CLT_CadenceSet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Cadence Set is an acknowledged message used to set the Sensor Cadence state of an element. The response to the Sensor Cadence Set message is a Sensor Cadence Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Cadence Set message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_CadenceSetUnacknowledged()

fsp_err_t RM_MESH_SENSOR_CLT_CadenceSetUnacknowledged	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Cadence Set Unacknowledged is an unacknowledged message used to set the Sensor Cadence state of an element.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Cadence Set message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_SettingsGet()

fsp_err_t RM_MESH_SENSOR_CLT_SettingsGet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Settings Get is an acknowledged message used to get the list of Sensor Setting states of an element. The response to the Sensor Settings Get message is a Sensor Settings Status message

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Settings Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_SettingGet()

fsp_err_t RM_MESH_SENSOR_CLT_SettingGet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Setting Get is an acknowledged message used to get the Sensor Setting state of an element. The response to the Sensor Setting Get message is a Sensor Setting Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Settings Get message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_SettingSet()

fsp_err_t RM_MESH_SENSOR_CLT_SettingSet	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Setting Set is an acknowledged message used to set the Sensor Setting state of an element. The response to the Sensor Setting Set message is a Sensor Setting Status message.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Settings Set message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

◆ RM_MESH_SENSOR_CLT_SettingSetUnacknowledged()

fsp_err_t RM_MESH_SENSOR_CLT_SettingSetUnacknowledged	(	rm_ble_mesh_model_client_ctrl_t *const	p_ctrl,
		void const *const	p_parameter
	)

Sensor Setting Set Unacknowledged is an unacknowledged message used to set the Sensor Setting state of an element.

Parameters

[in]	p_ctrl	rm_mesh_sensor_clt control block.
[in]	p_parameter	Pointer to Sensor Settings Set message.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
FSP_ERR_INVALID_POINTER	The parameter p_parameter is NULL.
FSP_ERR_APPROXIMATION	Lower layer is invalid state.
FSP_ERR_NOT_FOUND	Input parameter is not found.
FSP_ERR_INVALID_ADDRESS	Invalid source address.
FSP_ERR_OUT_OF_MEMORY	Memory allocation is failed.
FSP_ERR_OVERFLOW	TX queue is full.
FSP_ERR_UNDERFLOW	TX queue is empty.
FSP_ERR_ABORTED	Operation is failed.

Functions

Detailed Description

Overview

Target Devices

Configuration

Build Time Configurations for rm_mesh_sensor_clt

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Sensor Client (rm_mesh_sensor_clt)

Data Structures

Data Structure Documentation

◆ rm_mesh_sensor_clt_instance_ctrl_t

Function Documentation

◆ RM_MESH_SENSOR_CLT_Open()

◆ RM_MESH_SENSOR_CLT_Close()

◆ RM_MESH_SENSOR_CLT_GetModelHandle()

◆ RM_MESH_SENSOR_CLT_SendReliablePdu()

◆ RM_MESH_SENSOR_CLT_DescriptorGet()

◆ RM_MESH_SENSOR_CLT_Get()

◆ RM_MESH_SENSOR_CLT_ColumnGet()

◆ RM_MESH_SENSOR_CLT_SeriesGet()

◆ RM_MESH_SENSOR_CLT_CadenceGet()

◆ RM_MESH_SENSOR_CLT_CadenceSet()

◆ RM_MESH_SENSOR_CLT_CadenceSetUnacknowledged()

◆ RM_MESH_SENSOR_CLT_SettingsGet()

◆ RM_MESH_SENSOR_CLT_SettingGet()

◆ RM_MESH_SENSOR_CLT_SettingSet()

◆ RM_MESH_SENSOR_CLT_SettingSetUnacknowledged()