meshx_light_ctl_srv.h File Reference

Header file for the Light CTL Server module. More...

#include "meshx_common.h"
#include "meshx_light_server.h"
#include "meshx_control_task.h"
#include "interface/ble_mesh/meshx_ble_mesh_cmn.h"

Include dependency graph for meshx_light_ctl_srv.h:

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

Go to the source code of this file.

Typedefs
typedef meshx_model_interface_t	meshx_ctl_setup_server_model_t
	Structure representing the MeshX CTL (Color Temperature Lightness) Setup Server Model.
typedef meshx_model_interface_t	meshx_ctl_server_model_t
	Structure representing the MeshX CTL (Color Temperature Lightness) server model.

Functions
meshx_err_t	meshx_light_ctl_server_create (meshx_ctl_server_model_t **p_model, meshx_ptr_t p_sig_model)
	Create and initialize a new CTL server model instance.
meshx_err_t	meshx_light_ctl_server_delete (meshx_ctl_server_model_t **p_model)
	Delete the CTL server model instance.
meshx_err_t	meshx_light_ctl_srv_state_restore (meshx_ctl_server_model_t *p_model, meshx_light_ctl_srv_state_t ctl_state)
	Restore the CTL state for the generic server model.
meshx_err_t	meshx_light_ctl_server_init (void)
	Initialize the CTL server model.
meshx_err_t	meshx_get_ctl_setup_srv_model (meshx_ptr_t p_model)
	Retrieves the CTL (Color Temperature Lightness) Setup Server model instance.
meshx_err_t	meshx_light_ctl_srv_status_send (meshx_model_t *p_model, meshx_ctx_t *ctx, int16_t delta_uv, uint16_t lightness, uint16_t temperature)
	Send the Light CTL status message.
meshx_err_t	meshx_light_ctl_srv_send_pack_create (meshx_ptr_t p_model, uint16_t element_id, uint16_t net_idx, uint16_t app_idx, uint16_t pub_addr, meshx_light_ctl_srv_state_t ctl_state, meshx_lighting_server_cb_param_t *light_srv_send)
	Create a Light CTL Server send message packet.

Detailed Description

Header file for the Light CTL Server module.

Copyright © 2024 - 2025 MeshX

This file contains the function declarations and necessary includes for initializing and managing the Light CTL Server in the BLE mesh network.

Author

Pranjal Chanda

Definition in file meshx_light_ctl_srv.h.

Typedef Documentation

meshx_ctl_server_model_t

typedef meshx_model_interface_t meshx_ctl_server_model_t

Structure representing the MeshX CTL (Color Temperature Lightness) server model.

This structure encapsulates pointers to the CTL server SIG model, publication structures, and generic server structures used in the MeshX lighting control server implementation.

Definition at line 37 of file meshx_light_ctl_srv.h.

meshx_ctl_setup_server_model_t

typedef meshx_model_interface_t meshx_ctl_setup_server_model_t

Structure representing the MeshX CTL (Color Temperature Lightness) Setup Server Model.

This structure encapsulates pointers to the SIG model, publication structures, and generic server structures required for the CTL setup server functionality.

Definition at line 29 of file meshx_light_ctl_srv.h.

Function Documentation

meshx_get_ctl_setup_srv_model()

meshx_err_t meshx_get_ctl_setup_srv_model

(

meshx_ptr_t

p_model

)

Retrieves the CTL (Color Temperature Lightness) Setup Server model instance.

This function is used to obtain a reference or handle to the CTL Setup Server model, which is responsible for managing color temperature and lightness control in a mesh network.

Parameters

[in]

p_model

Pointer to the model structure or context.

Returns

meshx_err_t Returns an error code indicating the result of the operation. Typically, MESHX_OK on success or an appropriate error code on failure.

Definition at line 289 of file meshx_light_ctl_srv.c.

{
    if (!p_model)
        return MESHX_INVALID_ARG;
 
    if (g_meshx_light_ctl_srv.ctl_setup_server.meshx_srv_model == NULL)
        return MESHX_FAIL;
 
    memcpy(p_model, &g_meshx_light_ctl_srv.ctl_setup_server.ctl_setup_srv_model, sizeof(MESHX_MODEL));
    return MESHX_SUCCESS;
}

meshx_light_ctl_server_create()

meshx_err_t meshx_light_ctl_server_create	(	meshx_ctl_server_model_t **	p_model,
		meshx_ptr_t	p_sig_model )

Create and initialize a new CTL server model instance.

This function allocates memory for a new CTL server model and initializes it using the platform-specific creation function. It ensures that the model is properly set up for handling Generic OnOff messages in a BLE Mesh network.

Parameters

[in,out]	p_model	Pointer to a pointer where the newly created CTL server model instance will be stored.
[in,out]	p_sig_model	Pointer to a pointer where the offset of the model will be stored.

Returns

• MESHX_SUCCESS: Successfully created and initialized the model.
• MESHX_INVALID_ARG: The provided pointer is NULL.
• MESHX_NO_MEM: Memory allocation failed.

Definition at line 357 of file meshx_light_ctl_srv.c.

{
    meshx_err_t err = MESHX_SUCCESS;
    if (!p_model || !p_sig_model)
    {
        return MESHX_INVALID_ARG;
    }
 
    *p_model = (meshx_ctl_server_model_t *)MESHX_CALOC(1, sizeof(meshx_ctl_server_model_t));
    if (!*p_model)
    {
        return MESHX_NO_MEM;
    }
 
    err = meshx_plat_light_ctl_srv_create(
        p_sig_model,
        &((*p_model)->meshx_pub),
        &((*p_model)->meshx_gen));
    if(err != MESHX_SUCCESS)
    {
        /* Tops down deinit for CTL server model */
        meshx_light_ctl_server_delete(p_model);
        return err;
    }
 
    if(     g_meshx_light_ctl_srv.ctl_lighting_server_created == 0
        &&  g_meshx_light_ctl_srv.ctl_setup_server.ctl_setup_server_init == 0)
    {
        MESHX_LOGI(MODULE_ID_MODEL_SERVER, "Creating CTL setup server model");
        /* Create CTL setup server */
        err = meshx_light_ctl_setup_server_create();
        if(err != MESHX_SUCCESS)
        {
            /* Tops down deinit for CTL server model */
            meshx_light_ctl_setup_server_delete();
            /* The code execution below is only possible if this is the very first model being created */
            meshx_light_ctl_server_delete(p_model);
            return err;
        }
        g_meshx_light_ctl_srv.ctl_setup_server.ctl_setup_server_init = MESHX_SERVER_INIT_MAGIC_NO;
    }
    else
    {
        g_meshx_light_ctl_srv.ctl_lighting_server_created++;
    }
 
    (*p_model)->meshx_sig = p_sig_model;
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_light_ctl_server_delete()

meshx_err_t meshx_light_ctl_server_delete

(

meshx_ctl_server_model_t **

p_model

)

Delete the CTL server model instance.

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

Parameters

[in,out]

p_model

Double pointer to the CTL server model instance to be deleted.

Returns

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

Definition at line 420 of file meshx_light_ctl_srv.c.

{
    if (p_model == NULL || *p_model == NULL)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_plat_light_srv_delete(
        &((*p_model)->meshx_pub),
        &((*p_model)->meshx_gen));
 
    MESHX_FREE(*p_model);
    *p_model = NULL;
    if (g_meshx_light_ctl_srv.ctl_lighting_server_created == 0)
    {
        MESHX_LOGW(MODULE_ID_MODEL_SERVER, "Deleting CTL setup server model");
        /* Delete CTL setup server */
    }
    else
    {
        g_meshx_light_ctl_srv.ctl_lighting_server_created--;
    }
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_light_ctl_server_init()

meshx_err_t meshx_light_ctl_server_init

(

void

)

Initialize the CTL server model.

This function initializes the CTL server model for the BLE mesh node.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Failure

Initialize the CTL server model.

This function initializes the Light CTL (Color Temperature Light) Server model for the BLE Mesh Node. It sets up the necessary configurations and state for the Light CTL Server to operate correctly.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Failure

Definition at line 311 of file meshx_light_ctl_srv.c.

{
    meshx_err_t err = MESHX_SUCCESS;
 
    if (g_meshx_light_ctl_srv.ctl_setup_server.ctl_setup_server_init == MESHX_SERVER_INIT_MAGIC_NO)
        return MESHX_SUCCESS;
 
    g_meshx_light_ctl_srv.ctl_setup_server.ctl_setup_server_init = MESHX_SERVER_INIT_MAGIC_NO;
 
    err = meshx_lighting_srv_init();
    if (err)
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to initialize prod server");
 
    err = meshx_lighting_reg_cb(
        MESHX_MODEL_ID_LIGHT_CTL_SRV,
        (meshx_lighting_server_cb)&meshx_handle_light_ctl_msg
    );
    if (err)
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to initialize meshx_gen_srv_reg_cb (Err: %d)", err);
 
    err = meshx_lighting_reg_cb(
        MESHX_MODEL_ID_LIGHT_CTL_SETUP_SRV,
        (meshx_lighting_server_cb)&meshx_handle_light_ctl_msg
    );
    if (err)
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to initialize meshx_gen_srv_reg_cb (Err: %d)", err);
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_light_ctl_srv_send_pack_create()

meshx_err_t meshx_light_ctl_srv_send_pack_create	(	meshx_ptr_t	p_model,
		uint16_t	element_id,
		uint16_t	net_idx,
		uint16_t	app_idx,
		uint16_t	pub_addr,
		meshx_light_ctl_srv_state_t	ctl_state,
		meshx_lighting_server_cb_param_t *	light_srv_send )

Create a Light CTL Server send message packet.

This function creates a Light CTL Server send message packet with the provided parameters.

Parameters

[in]	p_model	Pointer to the MeshX model structure.
[in]	element_id	Element ID associated with the model.
[in]	net_idx	Network Index for the message.
[in]	app_idx	Application Index for the message.
[in]	pub_addr	Publication address for the message.
[in]	ctl_state	Current state of the Light CTL Server.
[out]	light_srv_send	Pointer to the structure where the created message packet will be stored.

Returns

• MESHX_SUCCESS: Successfully created the message packet.
• MESHX_INVALID_ARG: Invalid argument provided.

Definition at line 536 of file meshx_light_ctl_srv.c.

{
    if (!p_model || !light_srv_send)
    {
        return MESHX_INVALID_ARG;
    }
 
    memset(light_srv_send, 0, sizeof(meshx_lighting_server_cb_param_t));
    light_srv_send->ctx.net_idx = net_idx;
    light_srv_send->ctx.app_idx = app_idx;
    light_srv_send->ctx.src_addr = element_id;
    light_srv_send->ctx.dst_addr = pub_addr;
    light_srv_send->ctx.opcode = MESHX_MODEL_OP_LIGHT_CTL_STATUS;
    light_srv_send->ctx.p_ctx = NULL;
 
    light_srv_send->model.el_id = element_id;
    light_srv_send->model.p_model = p_model;
 
    light_srv_send->state_change.ctl_set.delta_uv = ctl_state.delta_uv;
    light_srv_send->state_change.ctl_set.lightness = ctl_state.lightness;
    light_srv_send->state_change.ctl_set.temperature = ctl_state.temperature;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_light_ctl_srv_state_restore()

meshx_err_t meshx_light_ctl_srv_state_restore	(	meshx_ctl_server_model_t *	p_model,
		meshx_light_ctl_srv_state_t	ctl_state )

Restore the CTL state for the generic server model.

This function restores the CTL state of the specified server model using the provided state value. It checks for a valid model pointer before proceeding with the restoration.

Parameters

p_model	Pointer to the CTL server model structure.
ctl_state	The CTL state to be restored.

Returns

• MESHX_INVALID_STATE: If the model pointer is NULL.
• Result of the platform-specific restoration function.

Definition at line 459 of file meshx_light_ctl_srv.c.

{
    if (!p_model)
        return MESHX_INVALID_STATE;
 
    return meshx_plat_light_ctl_srv_restore(p_model->meshx_sig,
                                            ctl_state.delta_uv,
                                            ctl_state.lightness,
                                            ctl_state.temperature,
                                            ctl_state.temperature_range_max,
                                            ctl_state.temperature_range_min);
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_light_ctl_srv_status_send()

meshx_err_t meshx_light_ctl_srv_status_send	(	meshx_model_t *	p_model,
		meshx_ctx_t *	ctx,
		int16_t	delta_uv,
		uint16_t	lightness,
		uint16_t	temperature )

Send the Light CTL status message.

This function sends the Light CTL status message to the specified context.

Parameters

[in]	p_model	Pointer to the MeshX model structure.
[in]	ctx	Context structure containing the necessary parameters for sending the message.
[in]	delta_uv	The Delta UV value to be included in the status message.
[in]	lightness	The Lightness value to be included in the status message.
[in]	temperature	The Temperature value to be included in the status message.

Returns

• MESHX_SUCCESS: Successfully sent the status message.
• Appropriate error code on failure.

Definition at line 486 of file meshx_light_ctl_srv.c.

{
    if (!p_model)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_lighting_server_state_change_t state_change = {
        .ctl_set = {
            .delta_uv = delta_uv,
            .lightness = lightness,
            .temperature = temperature
        }
    };
 
    meshx_err_t err = meshx_gen_light_srv_status_send(
        p_model,
        ctx,
        &state_change
    );
 
    if (err != MESHX_SUCCESS)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to send Light CTL status: %d", err);
    }
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function: