RA Flexible Software Package Documentation  Release v5.2.0

 
BLE Mesh Network Light Control Server (rm_mesh_light_ctl_srv)

Functions

fsp_err_t RM_MESH_LIGHT_CTL_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_LIGHT_CTL_SRV_Close (rm_ble_mesh_model_server_ctrl_t *const p_ctrl)
 
fsp_err_t RM_MESH_LIGHT_CTL_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_LIGHT_CTL_SRV_TemperatureServerStateUpdate (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 Light Control Server module supports the following devices.

Configuration

Build Time Configurations for rm_mesh_light_ctl_srv

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

ConfigurationOptionsDefaultDescription

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Light Control Server (rm_mesh_light_ctl_srv)

This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Light Control Server (rm_mesh_light_ctl_srv).

ConfigurationOptionsDefaultDescription
Interrupts
Callback Provided when Timeout OccursName Must Be a Valid C SymbolNULL Callback provided when mesh light control server ISR occurs
Callback Provided when an Timeout ISR OccursName Must Be a Valid C SymbolNULL Callback provided when mesh light control server timeout ISR occurs
NameName Must Be a Valid C Symbolg_rm_mesh_light_ctl_srv0 Module name.

Data Structures

struct  rm_mesh_light_ctl_srv_info_t
 
struct  rm_mesh_light_ctl_srv_default_info_t
 
struct  rm_mesh_light_ctl_srv_temperature_info_t
 
struct  rm_mesh_light_ctl_srv_temperature_range_info_t
 
struct  rm_mesh_light_ctl_srv_extended_cfg_t
 
struct  rm_mesh_light_ctl_srv_instance_ctrl_t
 

Data Structure Documentation

◆ rm_mesh_light_ctl_srv_info_t

struct rm_mesh_light_ctl_srv_info_t

Light CTL state is a composite state that includes the Light CTL Lightness, the Light CTL Temperature and the Light CTL Delta UV states

Data Fields
uint16_t ctl_lightness

Light CTL Lightness

uint16_t target_ctl_lightness

Target Light CTL Lightness - Used in response path

uint16_t ctl_temperature

Light CTL Temperature

uint16_t target_ctl_temperature

Terget Light CTL Temperature - Used in response path

uint16_t ctl_delta_uv

Light CTL Delta UV

uint8_t tid

TID - Used in request path

uint8_t transition_time

Transition Time - Used in request path. Used as remaining time in response path.

uint8_t delay

Delay - Used in request path

uint16_t transition_time_handle

Transition Timer Handle

◆ rm_mesh_light_ctl_srv_default_info_t

struct rm_mesh_light_ctl_srv_default_info_t

Light CTL Default state is a composite state that includes the Light CTL Lightness, the Light CTL Temperature and the Light CTL Delta UV states

Data Fields
uint16_t ctl_lightness

Light CTL Lightness

uint16_t ctl_temperature

Light CTL Temperature

uint16_t ctl_delta_uv

Light CTL Delta UV

◆ rm_mesh_light_ctl_srv_temperature_info_t

struct rm_mesh_light_ctl_srv_temperature_info_t

Light CTL Temperature state is a composite state that includes the Light CTL Temperature and the Light CTL Delta UV states

Data Fields
uint16_t ctl_temperature

Light CTL Temperature

uint16_t target_ctl_temperature

Target Light CTL Temperature - Used in response path

uint16_t ctl_delta_uv

Light CTL Delta UV

uint16_t target_ctl_delta_uv

Target Light CTL Delta UV - Used in response path

uint8_t tid

TID - Used in request path

uint8_t transition_time

Transition Time - Used in request path. Used as remaining time in response path.

uint8_t delay

Delay - Used in request path

◆ rm_mesh_light_ctl_srv_temperature_range_info_t

struct rm_mesh_light_ctl_srv_temperature_range_info_t

Light CTL Temperature Range state determines the minimum and maximum color temperatures of tunable white light an element is capable of emitting

Data Fields
uint16_t ctl_temperature_range_min

CTL Temperature Range Min

uint16_t ctl_temperature_range_max

CTL Temperature Range Max

uint8_t status

Status - Used in response path

◆ rm_mesh_light_ctl_srv_extended_cfg_t

struct rm_mesh_light_ctl_srv_extended_cfg_t

BLE mesh light ctl extension for BLE mesh light ctl.

Data Fields
rm_ble_mesh_access_instance_t
const *
p_temperature_access_instance Pointer to access instance for temperature model.

◆ rm_mesh_light_ctl_srv_instance_ctrl_t

struct rm_mesh_light_ctl_srv_instance_ctrl_t

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

Function Documentation

◆ RM_MESH_LIGHT_CTL_SRV_Open()

fsp_err_t RM_MESH_LIGHT_CTL_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 Light_Ctl Server model and to initialize Light_Ctl_Temperature Server model. This is to initialize Light_Ctl Server model and to register with Access layer. And this is to initialize Light_Ctl_Temperature Server model and to register with Access layer. Implements rm_ble_mesh_model_server_api_t::open.

Example:

/* Open the module. */
err = RM_MESH_LIGHT_CTL_SRV_Open(&g_mesh_light_ctl_srv0_ctrl, &g_mesh_light_ctl_srv0_cfg);
Return values
FSP_SUCCESSModel opened successfully.
FSP_ERR_ASSERTIONPointer to control block or configuration structure is NULL.
FSP_ERR_ALREADY_OPENModel is already open.
FSP_ERR_NOT_FOUNDThe number of models has exceeded the limit.
FSP_ERR_ABORTEDModel initialization is failed.

◆ RM_MESH_LIGHT_CTL_SRV_Close()

fsp_err_t RM_MESH_LIGHT_CTL_SRV_Close ( rm_ble_mesh_model_server_ctrl_t *const  p_ctrl)

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

Implements rm_ble_mesh_model_server_api_t::close.

Example:

/* Close the module. */
err = RM_MESH_LIGHT_CTL_SRV_Close(&g_mesh_light_ctl_srv0_ctrl);
Return values
FSP_SUCCESSModel successfully closed.
FSP_ERR_ASSERTIONThe parameter p_ctrl is NULL.
FSP_ERR_NOT_OPENModel is not open.

◆ RM_MESH_LIGHT_CTL_SRV_StateUpdate()

fsp_err_t RM_MESH_LIGHT_CTL_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_LIGHT_CTL_SRV_StateUpdate(&g_mesh_light_ctl_srv0_ctrl, &state);
Return values
FSP_SUCCESSUpdated server status successfully.
FSP_ERR_ASSERTIONThe parameter p_ctrl is NULL.
FSP_ERR_INVALID_POINTERThe parameter p_state is NULL.
FSP_ERR_NOT_OPENModel is not open.
FSP_ERR_INVALID_ARGUMENTInput parameter is invalid.
FSP_ERR_APPROXIMATIONLower layer is invalid state.
FSP_ERR_NOT_FOUNDInput parameter is not found.
FSP_ERR_INVALID_ADDRESSInvalid source address.
FSP_ERR_OUT_OF_MEMORYMemory allocation is failed.
FSP_ERR_OVERFLOWTX queue is full.
FSP_ERR_UNDERFLOWTX queue is empty.
FSP_ERR_ABORTEDOperation is failed.

◆ RM_MESH_LIGHT_CTL_SRV_TemperatureServerStateUpdate()

fsp_err_t RM_MESH_LIGHT_CTL_SRV_TemperatureServerStateUpdate ( 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_ctrlrm_mesh_light_ctl_srv control block.
[in]p_stateTo send reply for a request or to inform change in state.
Return values
FSP_SUCCESSOperation succeeded.
FSP_ERR_ASSERTIONThe parameter p_ctrl is NULL.
FSP_ERR_INVALID_POINTERThe parameter p_state is NULL.
FSP_ERR_NOT_OPENModel is not open.
FSP_ERR_INVALID_ARGUMENTInput parameter is invalid.
FSP_ERR_APPROXIMATIONLower layer is invalid state.
FSP_ERR_NOT_FOUNDInput parameter is not found.
FSP_ERR_INVALID_ADDRESSInvalid source address.
FSP_ERR_OUT_OF_MEMORYMemory allocation is failed.
FSP_ERR_OVERFLOWTX queue is full.
FSP_ERR_UNDERFLOWTX queue is empty.
FSP_ERR_ABORTEDOperation is failed.