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

fsp_err_t	RM_MESH_GENERIC_PROP_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_GENERIC_PROP_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_GENERIC_PROP_CLT_UserPropertiesGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

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

fsp_err_t	RM_MESH_GENERIC_PROP_CLT_AdminPropertiesGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

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

fsp_err_t	RM_MESH_GENERIC_PROP_CLT_ManufacturerPropertiesGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

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

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

Detailed Description

Overview

Target Devices

The BLE Mesh Network Generic Property Client module supports the following devices.

RA4W1

Configuration

Build Time Configurations for rm_mesh_generic_prop_clt

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

Configuration	Options	Default	Description

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Generic Property Client (rm_mesh_generic_prop_clt)

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

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

Data Structures
struct	rm_mesh_generic_prop_clt_instance_ctrl_t

Data Structure Documentation

◆ rm_mesh_generic_prop_clt_instance_ctrl_t

struct rm_mesh_generic_prop_clt_instance_ctrl_t

BLE mesh generic prop instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_GENERIC_PROP_CLT_Open() is called.

Function Documentation

◆ RM_MESH_GENERIC_PROP_CLT_Open()

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

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

Implements rm_ble_mesh_model_client_api_t::open.

Example:

    /* Open the module. */
    err = RM_MESH_GENERIC_PROP_CLT_Open(&g_mesh_generic_prop_clt0_ctrl, &g_mesh_generic_prop_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_GENERIC_PROP_CLT_Close()

fsp_err_t RM_MESH_GENERIC_PROP_CLT_Close ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Close Generic_Property Client middleware. Example:

    /* Close the module. */
    err = RM_MESH_GENERIC_PROP_CLT_Close(&g_mesh_generic_prop_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_GENERIC_PROP_CLT_GetModelHandle()

fsp_err_t RM_MESH_GENERIC_PROP_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 Generic_Property client model.

Implements rm_ble_mesh_model_client_api_t::getModelHandle.

Example:

    /* Get the handle of generic property client model. */
    err = RM_MESH_GENERIC_PROP_CLT_GetModelHandle(&g_mesh_generic_prop_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_GENERIC_PROP_CLT_SendReliablePdu()

fsp_err_t RM_MESH_GENERIC_PROP_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_GENERIC_PROP_CLT_SendReliablePdu(&g_mesh_generic_prop_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_GENERIC_PROP_CLT_UserPropertiesGet()

fsp_err_t RM_MESH_GENERIC_PROP_CLT_UserPropertiesGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Generic User Properties Get is an acknowledged message used to get the list of Generic User Property states of an element. The response to the Generic User Properties Get message is a Generic User Properties Status message. The message has no parameters.

Parameters

[in] p_ctrl rm_mesh_generic_prop_clt control block.

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_GENERIC_PROP_CLT_UserPropertyGet()

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

Generic User Property Get is an acknowledged message used to get the Generic User Property state of an element. The response to the Generic User Property Get message is a Generic User Property Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic User Property 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_GENERIC_PROP_CLT_UserPropertySet()

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

Generic User Property Set is an acknowledged message used to set the Generic User Property state of an element. The response to the Generic User Property Set message is a Generic User Property Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic User Property 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_GENERIC_PROP_CLT_UserPropertySetUnacknowledged()

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

Generic User Property Set Unacknowledged is an unacknowledged message used to set the Generic User Property state of an element.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic User Property 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_GENERIC_PROP_CLT_AdminPropertiesGet()

fsp_err_t RM_MESH_GENERIC_PROP_CLT_AdminPropertiesGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Generic Admin Properties Get is an acknowledged message used to get the list of Generic Admin Property states of an element. The response to the Generic Admin Properties Get message is a Generic Admin Properties Status message. The message has no parameters.

Parameters

[in] p_ctrl rm_mesh_generic_prop_clt control block.

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_GENERIC_PROP_CLT_AdminPropertyGet()

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

Generic Admin Property Get is an acknowledged message used to get the Generic Admin Property state of an element. The response to the Generic Admin Property Get message is a Generic Admin Property Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Admin Property 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_GENERIC_PROP_CLT_AdminPropertySet()

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

Generic Admin Property Set is an acknowledged message used to set the Generic Admin Property state of an element. The response to the Generic Admin Property Set message is a Generic Admin Property Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Admin Property 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_GENERIC_PROP_CLT_AdminPropertySetUnacknowledged()

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

Generic Admin Property Set Unacknowledged is an unacknowledged message used to set the Generic Admin Property state of an element.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Admin Property 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_GENERIC_PROP_CLT_ManufacturerPropertiesGet()

fsp_err_t RM_MESH_GENERIC_PROP_CLT_ManufacturerPropertiesGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Generic Manufacturer Properties Get is an acknowledged message used to get the list of Generic Manufacturer Property states of an element. The response to the Generic Manufacturer Properties Get message is a Generic Manufacturer Properties Status message. The message has no parameters.

Parameters

[in] p_ctrl rm_mesh_generic_prop_clt control block.

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_GENERIC_PROP_CLT_ManufacturerPropertyGet()

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

Generic Manufacturer Property Get is an acknowledged message used to get the Generic Manufacturer Property state of an element. The response to the Generic Manufacturer Property Get message is a Generic Manufacturer Property Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Manufacturer Property 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_GENERIC_PROP_CLT_ManufacturerPropertySet()

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

Generic Manufacturer Property Set is an acknowledged message used to set the Generic Manufacturer Property User Access state of an element. The response to the Generic Manufacturer Property Set message is a Generic Manufacturer Property Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Manufacturer Property 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_GENERIC_PROP_CLT_ManufacturerPropertySetUnacknowledged()

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

The Generic Manufacturer Property Set Unacknowledged is an unacknowledged message used to set the Generic Manufacturer Property User Access state of an element.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Manufacturer Property 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_GENERIC_PROP_CLT_ClientPropertiesGet()

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

Generic Client Properties Get is an acknowledged message used to get the list of Generic Client Property states of an element. The response to the Generic Client Properties Get message is a Generic Client Properties Status message.

Parameters

[in]	p_ctrl	rm_mesh_generic_prop_clt control block.
[in]	p_parameter	Pointer to Generic Client Properties 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.

Functions

Detailed Description

Overview

Target Devices

Configuration

Build Time Configurations for rm_mesh_generic_prop_clt

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Generic Property Client (rm_mesh_generic_prop_clt)

Data Structures

Data Structure Documentation

◆ rm_mesh_generic_prop_clt_instance_ctrl_t

Function Documentation

◆ RM_MESH_GENERIC_PROP_CLT_Open()

◆ RM_MESH_GENERIC_PROP_CLT_Close()

◆ RM_MESH_GENERIC_PROP_CLT_GetModelHandle()

◆ RM_MESH_GENERIC_PROP_CLT_SendReliablePdu()

◆ RM_MESH_GENERIC_PROP_CLT_UserPropertiesGet()

◆ RM_MESH_GENERIC_PROP_CLT_UserPropertyGet()

◆ RM_MESH_GENERIC_PROP_CLT_UserPropertySet()

◆ RM_MESH_GENERIC_PROP_CLT_UserPropertySetUnacknowledged()

◆ RM_MESH_GENERIC_PROP_CLT_AdminPropertiesGet()

◆ RM_MESH_GENERIC_PROP_CLT_AdminPropertyGet()

◆ RM_MESH_GENERIC_PROP_CLT_AdminPropertySet()

◆ RM_MESH_GENERIC_PROP_CLT_AdminPropertySetUnacknowledged()

◆ RM_MESH_GENERIC_PROP_CLT_ManufacturerPropertiesGet()

◆ RM_MESH_GENERIC_PROP_CLT_ManufacturerPropertyGet()

◆ RM_MESH_GENERIC_PROP_CLT_ManufacturerPropertySet()

◆ RM_MESH_GENERIC_PROP_CLT_ManufacturerPropertySetUnacknowledged()

◆ RM_MESH_GENERIC_PROP_CLT_ClientPropertiesGet()