nRF5 SDK for Mesh v5.0.0
Modules | Data Structures | Macros | Enumerations
Light CTL models

This model implements the message based interface required to set the Lightness, Color temperature and Delta UV value on the server. More...

Modules

 Light CTL Client model interface
 
 Persistence module for the Light CTL Setup Server model related states
 This module provides APIs for handling persistence of the Light CTL Setup Server model related states.
 
 Light CTL Setup Server model interface
 This model is defined as a top level model in the SDK to enable implementation of the tunable white light.
 
 Utility functions for the Light CTL model
 These utility functions are used to handle internal 32 bit representation (temperature32) of Light CTL Temperature state values.
 

Data Structures

struct  light_ctl_set_params_t
 Unpacked message structure typedefs are used for API interfaces and for implementing model code. More...
 
struct  light_ctl_temperature_set_params_t
 Message format for the CTL Temperature Set message. More...
 
struct  light_ctl_temperature_range_set_params_t
 Message format for the CTL Temperature Range Set message. More...
 
struct  light_ctl_default_set_params_t
 Message format for the CTL Default Set message. More...
 
struct  light_ctl_temperature_delta_set_params_t
 Message format for the CTL delta set "message". More...
 
struct  light_ctl_temperature_move_set_params_t
 Message format for the Light CTL Temperature Move Set "message". More...
 
struct  light_ctl_status_params_t
 Parameters for the Light CTL Status message. More...
 
struct  light_ctl_temperature_status_params_t
 Parameters for the Light CTL Temperature Status message. More...
 
struct  light_ctl_temperature_range_status_params_t
 Parameters for the Light CTL Temperature Range Status message. More...
 
struct  light_ctl_default_status_params_t
 Parameters for the Light CTL Default Status message. More...
 
struct  light_ctl_saved_values_t
 Storage format for model states while booting - the stored values will be read and passed to the model to do any state binding and set the current states based on these stored values. More...
 

Macros

#define LIGHT_CTL_COMPANY_ID   (0xFFFF)
 Model Company ID.
 
#define LIGHT_CTL_TEMPERATURE_UNKNOWN   (0xFFFF)
 Unknown Light CTL Temperature value.
 
#define LIGHT_CTL_TEMPERATURE_MIN_LIMIT   (0x0320)
 The Light CTL Temperature Range - Minimum limit allowed by mesh spec - Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.1.
 
#define LIGHT_CTL_TEMPERATURE_MAX_LIMIT   (0x4E20)
 The Light CTL Temperature Range - Maximum limit allowed by mesh spec - Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.1.
 
#define LIGHT_CTL_DEFAULT_TEMPERATURE   (8000)
 Defines the default value for the Light CTL Temperature state from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.1.
 
#define LIGHT_CTL_DEFAULT_TEMPERATURE_DEFAULT   (8000)
 Defines the default value for the Light CTL Delta UV state from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.2.
 
#define LIGHT_CTL_DEFAULT_ALLOWED_TEMPERATURE_MIN   (0x0320)
 Defines the application specific value for the minumum Light CTL Temperature from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.3.
 
#define LIGHT_CTL_DEFAULT_ALLOWED_TEMPERATURE_MAX   (0x4E20)
 Defines the application specific value for the maximum Light CTL Temperature from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.3.
 
#define LIGHT_CTL_DEFAULT_DELTA_UV   (0)
 Defines the default value for the Light CTL Delta UV state from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.4.
 
#define LIGHT_CTL_DEFAULT_DELTA_UV_DEFAULT   (0)
 Defines the default value for the Light CTL Delta UV Default state from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.3.5.
 

Enumerations

enum  light_ctl_range_status_t { LIGHT_CTL_RANGE_STATUS_GOOD, LIGHT_CTL_RANGE_STATUS_CANNOT_SET_MIN_RANGE, LIGHT_CTL_RANGE_STATUS_CANNOT_SET_MAX_RANGE }
 Status values for light_ctl_temperature_range_status_params_t. More...
 

Detailed Description

This model implements the message based interface required to set the Lightness, Color temperature and Delta UV value on the server.

Server model itself is a stateless model. The state information resides in the user application.

Enumeration Type Documentation

◆ light_ctl_range_status_t

Status values for light_ctl_temperature_range_status_params_t.

Enumerator
LIGHT_CTL_RANGE_STATUS_GOOD 

The provided range set values are valid.

LIGHT_CTL_RANGE_STATUS_CANNOT_SET_MIN_RANGE 

The provided MINIMUM range set value is invalid.

LIGHT_CTL_RANGE_STATUS_CANNOT_SET_MAX_RANGE 

The provided MAXIMUM range set value is invalid.

Definition at line 99 of file light_ctl_common.h.


Documentation feedback | Developer Zone | Subscribe | Updated