meshx_light_ctl_client.h File Reference

Header file for the Light CTL (Color Temperature Light) Client model. More...

#include "meshx_common.h"
#include "meshx_control_task.h"
#include "meshx_gen_light_cli.h"

Include dependency graph for meshx_light_ctl_client.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	meshx_ctl_el_state
	Structure to hold arguments for sending Light CTL messages. More...
struct	meshx_ctl_cli_el_msg
	Structure to hold the On/Off Server to element message. More...
struct	meshx_gen_ctl_send_params
	Structure to hold the parameters for sending a Generic Ctl message. More...

Macros
#define	MESHX_LIGHT_CTL_CLI_MSG_SET   0
#define	MESHX_LIGHT_CTL_CLI_MSG_GET   1
#define	MESHX_LIGHT_CTL_CLI_MSG_ACK   1
#define	MESHX_LIGHT_CTL_CLI_MSG_NO_ACK   0

Typedefs
typedef struct meshx_ctl_el_state	meshx_ctl_el_state_t
	Structure to hold arguments for sending Light CTL messages.
typedef struct meshx_ctl_cli_el_msg	meshx_ctl_cli_el_msg_t
	Structure to hold the On/Off Server to element message.
typedef meshx_model_interface_t	meshx_light_ctl_client_model_t
	Structure representing the Light CTL (Color Temperature Lightness) client model in MeshX.
typedef struct meshx_gen_ctl_send_params	meshx_gen_ctl_send_params_t
	Structure to hold the parameters for sending a Generic Ctl message.

Functions
meshx_err_t	meshx_light_ctl_client_init ()
	Initialize the Light CTL Client model.
meshx_err_t	meshx_light_ctl_client_create (meshx_light_ctl_client_model_t **p_model, void *p_sig_model)
	Creates and initializes a Generic Light Client model instance.
meshx_err_t	meshx_light_ctl_client_delete (meshx_light_ctl_client_model_t **p_model)
	Delete the Light client model instance.
meshx_err_t	meshx_light_ctl_client_send_msg (meshx_gen_ctl_send_params_t *params)
	Sends a Light CTL (Color Temperature Lightness) message from the Light CTL Client model.
meshx_err_t	meshx_light_ctl_temperature_client_send_msg (meshx_gen_ctl_send_params_t *params)
	Sends a Light CTL Temperature message from the client model.
meshx_err_t	meshx_light_ctl_temp_range_client_send_msg (meshx_gen_ctl_send_params_t *params)
	Sends a Light CTL Temperature Range message from the client model.
meshx_err_t	meshx_light_ctl_state_change_handle (const meshx_ctl_cli_el_msg_t *param, meshx_ctl_el_state_t *p_ctl_prev_state, const meshx_ctl_el_state_t *p_ctl_next_state)
	Handles state changes for the Light CTL client element.

Detailed Description

Header file for the Light CTL (Color Temperature Light) Client model.

Copyright © 2024 - 2025 MeshX

This file contains the definitions and function declarations for the Light CTL Client model used in ESP32 BLE Mesh applications. The Light CTL Client model is responsible for sending messages to control the color temperature and lightness of a light.

The file includes necessary BLE Mesh headers and defines the event types, callback function types, and structures used for registering and handling Light CTL Client events.

Author

Pranjal Chanda

Definition in file meshx_light_ctl_client.h.

Macro Definition Documentation

MESHX_LIGHT_CTL_CLI_MSG_ACK

#define MESHX_LIGHT_CTL_CLI_MSG_ACK   1

Definition at line 28 of file meshx_light_ctl_client.h.

MESHX_LIGHT_CTL_CLI_MSG_GET

#define MESHX_LIGHT_CTL_CLI_MSG_GET   1

Definition at line 27 of file meshx_light_ctl_client.h.

MESHX_LIGHT_CTL_CLI_MSG_NO_ACK

#define MESHX_LIGHT_CTL_CLI_MSG_NO_ACK   0

Definition at line 29 of file meshx_light_ctl_client.h.

MESHX_LIGHT_CTL_CLI_MSG_SET

#define MESHX_LIGHT_CTL_CLI_MSG_SET   0

Definition at line 26 of file meshx_light_ctl_client.h.

Typedef Documentation

meshx_ctl_cli_el_msg_t

typedef struct meshx_ctl_cli_el_msg meshx_ctl_cli_el_msg_t

Structure to hold the On/Off Server to element message.

meshx_ctl_el_state_t

typedef struct meshx_ctl_el_state meshx_ctl_el_state_t

Structure to hold arguments for sending Light CTL messages.

meshx_gen_ctl_send_params_t

typedef struct meshx_gen_ctl_send_params meshx_gen_ctl_send_params_t

Structure to hold the parameters for sending a Generic Ctl message.

meshx_light_ctl_client_model_t

typedef meshx_model_interface_t meshx_light_ctl_client_model_t

Structure representing the Light CTL (Color Temperature Lightness) client model in MeshX.

This structure holds pointers to the SIG model, publication structures, and generic structures associated with the Light CTL client functionality.

Definition at line 63 of file meshx_light_ctl_client.h.

Function Documentation

meshx_light_ctl_client_create()

meshx_err_t meshx_light_ctl_client_create	(	meshx_light_ctl_client_model_t **	p_model,
		void *	p_sig_model )

Creates and initializes a Generic Light Client model instance.

This function allocates and sets up a Generic Light Client model, associating it with the provided SIG model context.

Parameters

[out]	p_model	Pointer to a pointer where the created model instance will be stored.
[in]	p_sig_model	Pointer to the SIG model context to associate with the client model.

Returns

meshx_err_t Returns an error code indicating the result of the operation.

• MESHX_OK on success
• Appropriate error code otherwise

Definition at line 157 of file meshx_light_ctl_client.c.

{
    if (!p_model || !p_sig_model)
    {
        return MESHX_INVALID_ARG;
    }
 
    *p_model = (meshx_light_ctl_client_model_t *)MESHX_CALOC(1, sizeof(meshx_light_ctl_client_model_t));
    if (!*p_model)
    {
        return MESHX_NO_MEM;
    }
 
    return meshx_plat_light_ctl_client_create(
        p_sig_model,
        &((*p_model)->meshx_pub),
        &((*p_model)->meshx_gen));
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_light_ctl_client_delete()

meshx_err_t meshx_light_ctl_client_delete

(

meshx_light_ctl_client_model_t **

p_model

)

Delete the Light client model instance.

This function deletes an instance of the Light client model, freeing associated resources and setting the model pointer to NULL.

Parameters

[in,out]

p_model

Double pointer to the Light client model instance to be deleted.

Returns

• MESHX_SUCCESS: Successfully deleted the model.
• MESHX_INVALID_ARG: Invalid argument provided.

Definition at line 188 of file meshx_light_ctl_client.c.

{
    if (p_model == NULL || *p_model == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_plat_light_client_delete(
        &((*p_model)->meshx_pub),
        &((*p_model)->meshx_gen)
    );
 
    MESHX_FREE(*p_model);
    *p_model = NULL;
 
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

meshx_light_ctl_client_init()

meshx_err_t meshx_light_ctl_client_init

(

)

Initialize the Light CTL Client model.

This function initializes the Light CTL Client model, setting up necessary resources and configurations.

Returns

• MESHX_SUCCESS: Success
• MESHX_NO_MEM: Out of memory
• MESHX_FAIL: Other failures

This function initializes the Light CTL Client model by registering the Light Client callback with the BLE Mesh stack.

Returns

MESHX_SUCCESS on success, or an error code on failure.

Definition at line 117 of file meshx_light_ctl_client.c.

{
    meshx_err_t err = MESHX_SUCCESS;
 
    if (light_ctl_client_init_flag == LIGHT_CTL_CLIENT_INIT_MAGIC)
        return MESHX_SUCCESS;
 
    light_ctl_client_init_flag = LIGHT_CTL_CLIENT_INIT_MAGIC;
 
    err = meshx_gen_light_cli_init();
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Failed to initialize meshx client");
    }
 
    err = meshx_gen_light_client_from_ble_reg_cb(
        MESHX_MODEL_ID_LIGHT_CTL_CLI,
        (meshx_gen_light_client_cb_t)&meshx_handle_gen_light_msg
    );
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Failed to register Light CTL Client callback: %d", err);
    }
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_light_ctl_client_send_msg()

meshx_err_t meshx_light_ctl_client_send_msg

(

meshx_gen_ctl_send_params_t *

params

)

Sends a Light CTL (Color Temperature Lightness) message from the Light CTL Client model.

This function constructs and sends a Light CTL message to a specified destination address using the provided network and application indices. The message contains the desired lightness, temperature, and a transaction identifier (TID).

Parameters

[in]

params

Pointer to a structure containing the message parameters.

Returns

meshx_err_t Returns the result of the message send operation.

Definition at line 217 of file meshx_light_ctl_client.c.

{
    meshx_light_client_set_state_t set = {0};
    if (!params || !params->model || !params->model->meshx_sig)
    {
        return MESHX_INVALID_ARG; // Invalid model pointer
    }
    meshx_gen_light_client_send_params_t send_params = {
        .state      = &set,
        .addr       = params->addr,
        .opcode     = params->opcode,
        .app_idx    = params->app_idx,
        .net_idx    = params->net_idx,
        .model      = params->model->meshx_sig,
    };
 
    if (params->opcode == MESHX_MODEL_OP_LIGHT_CTL_GET)
    {
        MESHX_DO_NOTHING;
    }
    else if (params->opcode == MESHX_MODEL_OP_LIGHT_CTL_SET ||
             params->opcode == MESHX_MODEL_OP_LIGHT_CTL_SET_UNACK)
    {
        set.ctl_set.op_en           = false;
        set.ctl_set.tid             = params->tid;
        set.ctl_set.ctl_delta_uv    = params->delta_uv;
        set.ctl_set.ctl_lightness   = params->lightness;
        set.ctl_set.ctl_temperature = params->temperature;
    }
    else{
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid opcode for Light CTL Client: %04x", params->opcode);
        return MESHX_INVALID_ARG;
    }
    return meshx_gen_light_send_msg(&send_params);
}

Here is the call graph for this function:

meshx_light_ctl_state_change_handle()

meshx_err_t meshx_light_ctl_state_change_handle	(	const meshx_ctl_cli_el_msg_t *	param,
		meshx_ctl_el_state_t *	p_ctl_prev_state,
		const meshx_ctl_el_state_t *	p_ctl_next_state )

Handles state changes for the Light CTL client element.

This function processes state change events for the Light CTL client element.

Parameters

[in]	param	Pointer to the message structure containing the state change parameters.
[in,out]	p_ctl_prev_state	Pointer to the previous state structure.
[in,out]	p_ctl_next_state	Pointer to the next state structure (currently unused).

Returns

meshx_err_t Returns an error code indicating the result of the handler execution.

Definition at line 357 of file meshx_light_ctl_client.c.

{
    if (!p_ctl_prev_state || !param || !p_ctl_next_state)
        return MESHX_INVALID_ARG;
 
    /* Kept for future use */
    MESHX_UNUSED(p_ctl_next_state);
    bool state_change = false;
    if(param->err_code == MESHX_SUCCESS)
    {
        if (param->ctx.opcode == MESHX_MODEL_OP_LIGHT_CTL_STATUS)
        {
            if (p_ctl_prev_state->lightness != param->ctl_state.lightness
            || p_ctl_prev_state->temperature != param->ctl_state.temperature
            )
            {
                p_ctl_prev_state->lightness = param->ctl_state.lightness;
                p_ctl_prev_state->temperature = param->ctl_state.temperature;
                state_change = true;
            }
        }
        else if (param->ctx.opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_STATUS)
        {
            if(p_ctl_prev_state->delta_uv != param->ctl_state.delta_uv
            || p_ctl_prev_state->temperature != param->ctl_state.temperature)
            {
                p_ctl_prev_state->delta_uv = param->ctl_state.delta_uv;
                p_ctl_prev_state->temperature = param->ctl_state.temperature;
                state_change = true;
            }
        }
        else if (param->ctx.opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_RANGE_STATUS)
        {
            if (p_ctl_prev_state->temp_range_max != param->ctl_state.temp_range_max
            ||  p_ctl_prev_state->temp_range_min != param->ctl_state.temp_range_min)
            {
                p_ctl_prev_state->temp_range_max = param->ctl_state.temp_range_max;
                p_ctl_prev_state->temp_range_min = param->ctl_state.temp_range_min;
                state_change = true;
            }
        }
        else if (param->ctx.opcode == MESHX_MODEL_OP_LIGHT_CTL_DEFAULT_STATUS)
        {
            MESHX_DO_NOTHING;
        }
        else
        {
            /* Return as No CTL related OPCode were received */
            MESHX_DO_NOTHING;
        }
    }
    else
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "CWWW Client Element Message: Error (%d)", param->err_code);
        /* Retry sending the failed packet done by MeshX Light CTL Layer. Do not notify App */
        MESHX_DO_NOTHING;
    }
    return state_change ? MESHX_SUCCESS : MESHX_INVALID_STATE;
}

meshx_light_ctl_temp_range_client_send_msg()

meshx_err_t meshx_light_ctl_temp_range_client_send_msg

(

meshx_gen_ctl_send_params_t *

params

)

Sends a Light CTL Temperature Range message from the client model.

This function constructs and sends a Light CTL Temperature Range message to a specified address using the provided network and application indices. It allows the client to set or get the temperature range of a lighting element in a mesh network.

Parameters

[in]

params

Pointer to a structure containing the message parameters.

Returns

meshx_err_t Result of the message send operation.

Definition at line 312 of file meshx_light_ctl_client.c.

{
    meshx_light_client_set_state_t set = {0};
    if (!params || !params->model || !params->model->meshx_sig)
    {
        return MESHX_INVALID_ARG; // Invalid model pointer
    }
    meshx_gen_light_client_send_params_t send_params = {
        .state      = &set,
        .addr       = params->addr,
        .opcode     = params->opcode,
        .app_idx    = params->app_idx,
        .net_idx    = params->net_idx,
        .model      = params->model->meshx_sig,
    };
 
    if(params->opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_RANGE_GET)
    {
        MESHX_DO_NOTHING;
    }
    if (params->opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_RANGE_SET ||
        params->opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_RANGE_SET_UNACK)
    {
        set.ctl_temperature_range_set.range_min = params->temp_range_min;
        set.ctl_temperature_range_set.range_max = params->temp_range_max;
    }
    else{
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid opcode for Light CTL Client: %04x", params->opcode);
        return MESHX_INVALID_ARG;
    }
 
    return meshx_gen_light_send_msg(&send_params);
}

Here is the call graph for this function:

meshx_light_ctl_temperature_client_send_msg()

meshx_err_t meshx_light_ctl_temperature_client_send_msg

(

meshx_gen_ctl_send_params_t *

params

)

Sends a Light CTL Temperature message from the client model.

This function constructs and sends a Light CTL Temperature message to a specified address using the provided network and application indices. It allows the client to control the color temperature and delta UV of a lighting element in a mesh network.

Parameters

[in]

params

Pointer to a structure containing the message parameters.

Returns

meshx_err_t Result of the message send operation.

Definition at line 264 of file meshx_light_ctl_client.c.

{
    meshx_light_client_set_state_t set = {0};
    if (!params || !params->model || !params->model->meshx_sig)
    {
        return MESHX_INVALID_ARG; // Invalid model pointer
    }
    meshx_gen_light_client_send_params_t send_params = {
        .state      = &set,
        .addr       = params->addr,
        .opcode     = params->opcode,
        .app_idx    = params->app_idx,
        .net_idx    = params->net_idx,
        .model      = params->model->meshx_sig,
    };
 
    if (params->opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_GET)
    {
        MESHX_DO_NOTHING;
    }
    else if (params->opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_SET ||
             params->opcode == MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_SET_UNACK)
    {
        set.ctl_temperature_set.op_en           = false;
        set.ctl_temperature_set.tid             = params->tid;
        set.ctl_temperature_set.ctl_delta_uv    = params->delta_uv;
        set.ctl_temperature_set.ctl_temperature = params->temperature;
 
    }
    else{
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid opcode for Light CTL Client: %04x", params->opcode);
        return MESHX_INVALID_ARG;
    }
 
    return meshx_gen_light_send_msg(&send_params);
}

Here is the call graph for this function: