BLE Mesh Network Generic Power Level Server (rm_mesh_generic_pl_srv)

Functions
fsp_err_t	RM_MESH_GENERIC_PL_SRV_Open (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_model_server_cfg_t const *const p_cfg)
fsp_err_t	RM_MESH_GENERIC_PL_SRV_Close (rm_ble_mesh_model_server_ctrl_t *const p_ctrl)
fsp_err_t	RM_MESH_GENERIC_PL_SRV_StateUpdate (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state)
fsp_err_t	RM_MESH_GENERIC_PL_SRV_SetupServerStateUpdate (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state)

Detailed Description

Overview

Target Devices

The BLE Mesh Network Generic Power Level Server module supports the following devices.

• RA4W1

Configuration

Build Time Configurations for rm_mesh_generic_pl_srv

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

Configuration	Options	Default	Description

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Generic Power Level Server (rm_mesh_generic_pl_srv)

This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Generic Power Level Server (rm_mesh_generic_pl_srv).

Configuration	Options	Default	Description
Interrupts
Callback Provided when Timeout Occurs	Name Must Be a Valid C Symbol	NULL	Callback provided when mesh generic power level server ISR occurs
Callback Provided when an Timeout ISR Occurs	Name Must Be a Valid C Symbol	NULL	Callback provided when mesh generic power level server timeout ISR occurs
Name	Name Must Be a Valid C Symbol	g_rm_mesh_generic_pl_srv0	Module name.

Data Structures
struct	rm_mesh_generic_pl_srv_actual_state_info_t
struct	rm_mesh_generic_pl_srv_last_state_info_t
struct	rm_mesh_generic_pl_srv_default_state_info_t
struct	rm_mesh_generic_pl_srv_range_state_info_t
struct	rm_mesh_generic_pl_srv_state_info_t
struct	rm_mesh_generic_pl_srv_instance_ctrl_t

---

Data Structure Documentation

rm_mesh_generic_pl_srv_actual_state_info_t

struct rm_mesh_generic_pl_srv_actual_state_info_t

Generic Power Actual state determines the linear percentage of the maximum power level of an element, representing a range from 0 percent through 100 percent

Data Fields
uint16_t	power_actual	Generic Power Actual
uint8_t	tid
uint16_t	power_target	Generic Power Target - Used only in response path
uint8_t	transition_time	Transition Time - Used in request path Used as Remaining Time in response path
uint8_t	delay
uint16_t	transition_time_handle	Transition Timer Handle

rm_mesh_generic_pl_srv_last_state_info_t

struct rm_mesh_generic_pl_srv_last_state_info_t

Generic Power Last state is a 16-bit value representing a percentage ranging from (1/65535) percent to 100 percent

Data Fields
uint16_t	power_last	Generic Power Last

rm_mesh_generic_pl_srv_default_state_info_t

struct rm_mesh_generic_pl_srv_default_state_info_t

Generic Power Default state is a 16-bit value ranging from 0 through 65535

Data Fields
uint16_t	power_default	Generic Power Default

rm_mesh_generic_pl_srv_range_state_info_t

struct rm_mesh_generic_pl_srv_range_state_info_t

Generic Power Range state determines the minimum and maximum power levels of an element relative to the maximum power level an element can output

Data Fields
uint16_t	power_range_min	Generic Power Range - Minimum
uint16_t	power_range_max	Generic Power Range - Maximum
uint8_t	status	Status - Used only in the response path

rm_mesh_generic_pl_srv_state_info_t

struct rm_mesh_generic_pl_srv_state_info_t

Generic Power Level state is a composite state that includes a Generic Power Actual state, a Generic Power Last state, a Generic Power Default state, and a Generic Power Range state

Data Fields
rm_mesh_generic_pl_srv_actual_state_info_t	generic_power_actual	Generic Power Actual
rm_mesh_generic_pl_srv_last_state_info_t	generic_power_last	Generic Power Last
rm_mesh_generic_pl_srv_default_state_info_t	generic_power_default	Generic Power Default
rm_mesh_generic_pl_srv_range_state_info_t	generic_power_range	Generic Power Range

rm_mesh_generic_pl_srv_instance_ctrl_t

struct rm_mesh_generic_pl_srv_instance_ctrl_t

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

Function Documentation

RM_MESH_GENERIC_PL_SRV_Open()

fsp_err_t RM_MESH_GENERIC_PL_SRV_Open	(	rm_ble_mesh_model_server_ctrl_t *const	p_ctrl,
		rm_ble_mesh_model_server_cfg_t const *const	p_cfg
	)

API to initialize Generic_Power_Level Server model and to initialize Generic_Power_Level_Setup Server model. This is to initialize Generic_Power_Level Server model and to register with Access layer. And this is to initialize Generic_Power_Level_Setup Server model and to register with Access layer.

Implements rm_ble_mesh_model_server_api_t::open.

Example:

    /* Open the module. */
    err = RM_MESH_GENERIC_PL_SRV_Open(&g_mesh_generic_pl_srv0_ctrl, &g_mesh_generic_pl_srv0_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_PL_SRV_Close()

fsp_err_t RM_MESH_GENERIC_PL_SRV_Close

(

rm_ble_mesh_model_server_ctrl_t *const

p_ctrl

)

API to terminate Generic_Power_Level Server model. This is to terminate Generic_Power_Level Server model and to register with Access layer.

Implements rm_ble_mesh_model_server_api_t::close.

Example:

    /* Close the module. */
    err = RM_MESH_GENERIC_PL_SRV_Close(&g_mesh_generic_pl_srv0_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_PL_SRV_StateUpdate()

fsp_err_t RM_MESH_GENERIC_PL_SRV_StateUpdate	(	rm_ble_mesh_model_server_ctrl_t *const	p_ctrl,
		rm_ble_mesh_access_server_state_t const *const	p_state
	)

API to send reply or to update state change. This is to send reply for a request or to inform change in state.

Implements rm_ble_mesh_model_server_api_t::stateUpdate.

Example:

    /* Update server status. */
    err = RM_MESH_GENERIC_PL_SRV_StateUpdate(&g_mesh_generic_pl_srv0_ctrl, &state);

Return values

FSP_SUCCESS	Updated server status successfully.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_INVALID_POINTER	The parameter p_state is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
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_PL_SRV_SetupServerStateUpdate()

fsp_err_t RM_MESH_GENERIC_PL_SRV_SetupServerStateUpdate	(	rm_ble_mesh_model_server_ctrl_t *const	p_ctrl,
		rm_ble_mesh_access_server_state_t const *const	p_state
	)

API to send reply or to update state change. This is to send reply for a request or to inform change in state.

Parameters

[in]	p_ctrl	rm_mesh_generic_pl_srv control block.
[in]	p_state	To send reply for a request or to inform change in state.

Return values

FSP_SUCCESS	Operation succeeded.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_INVALID_POINTER	The parameter p_state is NULL.
FSP_ERR_NOT_OPEN	Model is not open.
FSP_ERR_INVALID_ARGUMENT	Input parameter is invalid.
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.