Light CTL models

The Color-Tunable Light (CTL) models allow remote control and configuration of CTLs on a mesh device.

The Light CTL models can represent the lightness states on a linear or perceptually uniform lightness scale. See Light Lightness models for details.

The Light CTL models also feature their own common types, listed below. For types common to all models, see Bluetooth Mesh models.

Subpages:

• Light CTL Client
• Light CTL Server
• Light CTL Temperature Server

Common types

This section lists the types common to the Light CTL mesh models.

Header file: include/bluetooth/mesh/light_ctl.h

group bt_mesh_light_ctl

API for the Light CTL models.

Defines

BT_MESH_LIGHT_TEMP_MIN

Minimum permitted Temperature level

BT_MESH_LIGHT_TEMP_MAX

Maximum permitted Temperature level

BT_MESH_LIGHT_TEMP_UNKNOWN

Unknown Temperature range boundaries

struct bt_mesh_light_ctl

#include <light_ctl.h>

All Light CTL parameters

Public Members

uint16_t light

Light level

uint16_t temp

Light temperature

int16_t delta_uv

Delta UV

struct bt_mesh_light_temp

#include <light_ctl.h>

Light temperature parameters.

Public Members

uint16_t temp

Light temperature

int16_t delta_uv

Delta UV

struct bt_mesh_light_ctl_set

#include <light_ctl.h>

Light CTL set message parameters.

Public Members

struct bt_mesh_light_ctl params

CTL set parameters.

const struct bt_mesh_model_transition *transition

Transition time parameters for the state change, or NULL.

When sending, setting the transition to NULL makes the receiver use its default transition time parameters, or 0 if no default transition time is set.

struct bt_mesh_light_ctl_status

#include <light_ctl.h>

Light CTL status message parameters.

Public Members

uint16_t current_light

Current light level.

uint16_t current_temp

Current light temperature.

uint16_t target_light

Target light level.

uint16_t target_temp

Target light temperature.

uint32_t remaining_time

Remaining time for the state change (ms).

struct bt_mesh_light_temp_set

#include <light_ctl.h>

Light CTL Temperature set message parameters.

Public Members

struct bt_mesh_light_temp params

New light temperature.

const struct bt_mesh_model_transition *transition

Transition time parameters for the state change, or NULL.

When sending, setting the transition to NULL makes the receiver use its default transition time parameters, or 0 if no default transition time is set.

struct bt_mesh_light_temp_status

#include <light_ctl.h>

Light temperature status.

Public Members

struct bt_mesh_light_temp current

Current light temperature parameters.

struct bt_mesh_light_temp target

Target light temperature parameters.

uint32_t remaining_time

Remaining time for the state change (ms).

struct bt_mesh_light_temp_range

#include <light_ctl.h>

Light temperature range parameters.

Public Members

uint16_t min

Minimum light temperature.

uint16_t max

Maximum light temperature.

struct bt_mesh_light_temp_range_status

#include <light_ctl.h>

Light CTL range status message parameters.

Public Members

enum bt_mesh_model_status status

Status of the previous operation.

struct bt_mesh_light_temp_range range

Current light temperature range.