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

fsp_err_t	RM_MESH_LIGHT_HSL_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_LIGHT_HSL_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_LIGHT_HSL_CLT_Get (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

fsp_err_t	RM_MESH_LIGHT_HSL_CLT_TargetGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

fsp_err_t	RM_MESH_LIGHT_HSL_CLT_DefaultGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

fsp_err_t	RM_MESH_LIGHT_HSL_CLT_RangeGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

fsp_err_t	RM_MESH_LIGHT_HSL_CLT_HueGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

fsp_err_t	RM_MESH_LIGHT_HSL_CLT_SaturationGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl)

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

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

Detailed Description

Overview

Target Devices

The BLE Mesh Network Light Hsl Client module supports the following devices.

RA4W1

Configuration

Build Time Configurations for rm_mesh_light_hsl_clt

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

Configuration	Options	Default	Description

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Light HSL Client (rm_mesh_light_hsl_clt)

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

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

Data Structures
struct	rm_mesh_light_hsl_clt_instance_ctrl_t

Data Structure Documentation

◆ rm_mesh_light_hsl_clt_instance_ctrl_t

struct rm_mesh_light_hsl_clt_instance_ctrl_t

BLE mesh light hsl instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_LIGHT_HSL_CLT_Open() is called.

Function Documentation

◆ RM_MESH_LIGHT_HSL_CLT_Open()

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

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

Implements rm_ble_mesh_model_client_api_t::open.

Example:

    /* Open the module. */
    err = RM_MESH_LIGHT_HSL_CLT_Open(&g_mesh_light_hsl_clt0_ctrl, &g_mesh_light_hsl_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_LIGHT_HSL_CLT_Close()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_Close ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Close Light_Hsl Client middleware.

Implements rm_ble_mesh_model_client_api_t::close.

Example:

    /* Close the module. */
    err = RM_MESH_LIGHT_HSL_CLT_Close(&g_mesh_light_hsl_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_LIGHT_HSL_CLT_GetModelHandle()

fsp_err_t RM_MESH_LIGHT_HSL_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 Light_Hsl client model.

Implements rm_ble_mesh_model_client_api_t::getModelHandle.

Example:

    /* Get the handle of light hsl client model. */
    err = RM_MESH_LIGHT_HSL_CLT_GetModelHandle(&g_mesh_light_hsl_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_LIGHT_HSL_CLT_SendReliablePdu()

fsp_err_t RM_MESH_LIGHT_HSL_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_LIGHT_HSL_CLT_SendReliablePdu(&g_mesh_light_hsl_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_LIGHT_HSL_CLT_Get()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_Get ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

The Light HSL Get is an acknowledged message used to get the Light HSL Lightness, Light HSL Hue, and Light HSL Saturation states of an element. The response to the Light HSL Get message is a Light HSL Status message. There are no parameters for this message.

Parameters

[in] p_ctrl rm_mesh_light_hsl_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_LIGHT_HSL_CLT_Set()

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

The Light HSL Set Unacknowledged is an unacknowledged message used to set the Light HSL Lightness state, Light HSL Hue state, and the Light HSL Saturation state of an element.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL 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_LIGHT_HSL_CLT_SetUnacknowledged()

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

The Light HSL Set is an acknowledged message used to set the Light HSL Lightness state, Light HSL Hue state, and the Light HSL Saturation state of an element. The response to the Light HSL Set message is a Light HSL Status message.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL 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_LIGHT_HSL_CLT_TargetGet()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_TargetGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Light HSL Target Get is an acknowledged message used to get the target Light HSL Lightness, Light HSL Hue, and Light HSL Saturation states of an element. The response to the Light HSL Target Get message is a Light HSL Target Status message. There are no parameters for this message.

Parameters

[in] p_ctrl rm_mesh_light_hsl_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_LIGHT_HSL_CLT_DefaultGet()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_DefaultGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

Light HSL Default Get is an acknowledged message used to get the Light Lightness Default, the Light HSL Hue Default, and Light HSL Saturation Default states of an element. The response to the Light HSL Default Get message is a Light HSL Default Status message. There are no parameters for this message.

Parameters

[in] p_ctrl rm_mesh_light_hsl_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_LIGHT_HSL_CLT_DefaultSet()

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

Light HSL Default Set is an acknowledged message used to set the Light Lightness Default, the Light HSL Hue Default, and Light HSL Saturation Default states of an element. The response to the Light HSL Default Set message is a Light HSL Default Status message.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Default 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_LIGHT_HSL_CLT_DefaultSetUnacknowledged()

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

Light HSL Default Set Unacknowledged is an unacknowledged message used to set the Light Lightness Default, the Light HSL Hue Default, and Light HSL Saturation Default states of an element.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Default 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_LIGHT_HSL_CLT_RangeGet()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_RangeGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

The Light HSL Range Get is an acknowledged message used to get the Light HSL Hue Range and Light HSL Saturation Range states of an element. The response to the Light HSL Range Get message is a Light HSL Range Status message. There are no parameters for this message.

Parameters

[in] p_ctrl rm_mesh_light_hsl_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_LIGHT_HSL_CLT_RangeSet()

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

Light HSL Range Set is an acknowledged message used to set the Light HSL Hue Range and Light HSL Saturation Range states of an element. The response to the Light HSL Range Set message is a Light HSL Range Status message.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Range 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_LIGHT_HSL_CLT_RangeSetUnacknowledged()

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

Light HSL Range Set Unacknowledged is an unacknowledged message used to set the Light HSL Hue Range and Light HSL Saturation Range states of an element.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Range 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_LIGHT_HSL_CLT_HueGet()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_HueGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

The Light HSL Hue Get is an acknowledged message used to get the Light HSL Hue state of an element. The response to the Light HSL Hue Get message is a Light HSL Hue Status message. There are no parameters for this message.

Parameters

[in] p_ctrl rm_mesh_light_hsl_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_LIGHT_HSL_CLT_HueSet()

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

The Light HSL Hue Set is an acknowledged message used to set the target Light HSL Hue state of an element. The response to the Light HSL Hue Set message is a Light HSL Hue Status message.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Hue 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_LIGHT_HSL_CLT_HueSetUnacknowledged()

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

The Light HSL Hue Set Unacknowledged is an unacknowledged message used to set the target Light HSL Hue state of an element.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Hue 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_LIGHT_HSL_CLT_SaturationGet()

fsp_err_t RM_MESH_LIGHT_HSL_CLT_SaturationGet ( rm_ble_mesh_model_client_ctrl_t *const p_ctrl )

The Light HSL Saturation Get is an acknowledged message used to get the Light HSL Saturation state of an element. The response to the Light HSL Saturation Get message is a Light HSL Saturation Status message. There are no parameters for this message.

Parameters

[in] p_ctrl rm_mesh_light_hsl_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_LIGHT_HSL_CLT_SaturationSet()

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

The Light HSL Saturation Set is an acknowledged message used to set the target Light HSL Saturation state of an element. The response to the Light HSL Saturation Set message is a Light HSL Saturation Status message.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Saturation 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_LIGHT_HSL_CLT_SaturationSetUnacknowledged()

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

The Light HSL Saturation Set Unacknowledged is an unacknowledged message used to set the target Light HSL Saturation state of an element.

Parameters

[in]	p_ctrl	rm_mesh_light_hsl_clt control block.
[in]	p_parameter	Pointer to Light HSL Saturation 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_light_hsl_clt

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Light HSL Client (rm_mesh_light_hsl_clt)

Data Structures

Data Structure Documentation

◆ rm_mesh_light_hsl_clt_instance_ctrl_t

Function Documentation

◆ RM_MESH_LIGHT_HSL_CLT_Open()

◆ RM_MESH_LIGHT_HSL_CLT_Close()

◆ RM_MESH_LIGHT_HSL_CLT_GetModelHandle()

◆ RM_MESH_LIGHT_HSL_CLT_SendReliablePdu()

◆ RM_MESH_LIGHT_HSL_CLT_Get()

◆ RM_MESH_LIGHT_HSL_CLT_Set()

◆ RM_MESH_LIGHT_HSL_CLT_SetUnacknowledged()

◆ RM_MESH_LIGHT_HSL_CLT_TargetGet()

◆ RM_MESH_LIGHT_HSL_CLT_DefaultGet()

◆ RM_MESH_LIGHT_HSL_CLT_DefaultSet()

◆ RM_MESH_LIGHT_HSL_CLT_DefaultSetUnacknowledged()

◆ RM_MESH_LIGHT_HSL_CLT_RangeGet()

◆ RM_MESH_LIGHT_HSL_CLT_RangeSet()

◆ RM_MESH_LIGHT_HSL_CLT_RangeSetUnacknowledged()

◆ RM_MESH_LIGHT_HSL_CLT_HueGet()

◆ RM_MESH_LIGHT_HSL_CLT_HueSet()

◆ RM_MESH_LIGHT_HSL_CLT_HueSetUnacknowledged()

◆ RM_MESH_LIGHT_HSL_CLT_SaturationGet()

◆ RM_MESH_LIGHT_HSL_CLT_SaturationSet()

◆ RM_MESH_LIGHT_HSL_CLT_SaturationSetUnacknowledged()