Light Lightness model utility functions

nRF5 SDK for Mesh v5.0.0
Functions

Functions

static uint16_t light_lightness_utils_actual_to_linear (uint16_t ll_actual)
 Converts the Light Lightness Actual state to the Light Lightness Linear state. More...
 
static uint16_t light_lightness_utils_linear_to_actual (uint16_t ll_linear)
 Convert the Light Lightness Linear state to the Light Lightness Actual state. More...
 
static int16_t light_lightness_utils_actual_to_generic_level (uint16_t ll_actual)
 Convert the Light Lightness Actual state to the Generic Level state. More...
 
static uint16_t light_lightness_utils_generic_level_to_actual (int16_t level)
 Convert the Generic Level state to the Light Lightness Actual state. More...
 
static uint8_t light_lightness_utils_actual_to_generic_onoff (uint16_t ll_actual)
 Convert the Light Lightness Actual state to the Generic OnOff state. More...
 
static uint16_t light_lightness_utils_actual_to_range_restrict (uint16_t ll_actual, uint16_t range_min, uint16_t range_max)
 Convert the Light Lightness Actual state to the Generic OnOff state. More...
 

Detailed Description

Function Documentation

◆ light_lightness_utils_actual_to_linear()

static uint16_t light_lightness_utils_actual_to_linear ( uint16_t  ll_actual)
inlinestatic

Converts the Light Lightness Actual state to the Light Lightness Linear state.

See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.2.1 for more details.

Parameters
[in]ll_actualThe Light Lightness Actual state.
Returns
The Light Lightness Linear state.

Definition at line 60 of file light_lightness_utils.h.

◆ light_lightness_utils_linear_to_actual()

static uint16_t light_lightness_utils_linear_to_actual ( uint16_t  ll_linear)
inlinestatic

Convert the Light Lightness Linear state to the Light Lightness Actual state.

See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.2.1 for more details.

Parameters
[in]ll_linearThe Light Lightness Linear state.
Returns
The Light Lightness Actual state.

Definition at line 74 of file light_lightness_utils.h.

◆ light_lightness_utils_actual_to_generic_level()

static int16_t light_lightness_utils_actual_to_generic_level ( uint16_t  ll_actual)
inlinestatic

Convert the Light Lightness Actual state to the Generic Level state.

See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.2.2 for more details.

Parameters
[in]ll_actualThe Light Lightness Actual state.
Returns
The Generic Level state.

Definition at line 88 of file light_lightness_utils.h.

References GENERIC_LEVEL_MIN.

◆ light_lightness_utils_generic_level_to_actual()

static uint16_t light_lightness_utils_generic_level_to_actual ( int16_t  level)
inlinestatic

Convert the Generic Level state to the Light Lightness Actual state.

See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.2.2 for more details.

Parameters
[in]levelThe Generic Level state.
Returns
The Light Lightness Actual state.

Definition at line 102 of file light_lightness_utils.h.

References GENERIC_LEVEL_MIN.

◆ light_lightness_utils_actual_to_generic_onoff()

static uint8_t light_lightness_utils_actual_to_generic_onoff ( uint16_t  ll_actual)
inlinestatic

Convert the Light Lightness Actual state to the Generic OnOff state.

See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.2.3 for more details.

Parameters
[in]ll_actualLight Lightness Actual state.
Returns
Generic OnOff state.

Definition at line 116 of file light_lightness_utils.h.

◆ light_lightness_utils_actual_to_range_restrict()

static uint16_t light_lightness_utils_actual_to_range_restrict ( uint16_t  ll_actual,
uint16_t  range_min,
uint16_t  range_max 
)
inlinestatic

Convert the Light Lightness Actual state to the Generic OnOff state.

See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.2.5 for more details.

Parameters
[in]ll_actualThe Light Lightness Actual state.
[in]range_minThe Light Lightness Range Min state.
[in]range_maxThe Light Lightness Range Max state.
Returns
The Light Lightness Range state.

Definition at line 132 of file light_lightness_utils.h.