meshx_ble_mesh_light_srv.h File Reference

Header file for the MeshX BLE Mesh Light Server module. This file defines the data structures, function prototypes, and callback parameters for managing the Light Server models in a BLE Mesh network. It includes support for various lighting models such as Light CTL, HSL, xyL, and LC. More...

#include "../meshx_ble_mesh_cmn.h"
#include "meshx_control_task.h"

Include dependency graph for meshx_ble_mesh_light_srv.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_state_change_light_lightness_set_t
struct	meshx_state_change_light_lightness_linear_set_t
struct	meshx_state_change_light_lightness_default_set_t
struct	meshx_state_change_light_lightness_range_set_t
struct	meshx_state_change_light_ctl_set_t
struct	meshx_state_change_light_ctl_temperature_set_t
struct	meshx_state_change_light_ctl_temperature_range_set_t
struct	meshx_state_change_light_ctl_default_set_t
struct	meshx_state_change_light_hsl_set_t
struct	meshx_state_change_light_hsl_hue_set_t
struct	meshx_state_change_light_hsl_saturation_set_t
struct	meshx_state_change_light_hsl_default_set_t
struct	meshx_state_change_light_hsl_range_set_t
struct	meshx_state_change_light_xyl_set_t
struct	meshx_state_change_light_xyl_default_set_t
struct	meshx_state_change_light_xyl_range_set_t
struct	meshx_state_change_light_lc_mode_set_t
struct	meshx_state_change_light_lc_om_set_t
struct	meshx_state_change_light_lc_light_onoff_set_t
struct	meshx_state_change_light_lc_property_set_t
struct	meshx_state_change_sensor_status_t
union	meshx_lighting_server_state_change_t
	Lighting Server Model state change value union. More...
struct	meshx_lighting_server_cb_param
struct	meshx_light_ctl_srv_state
struct	meshx_light_ctl_srv
	Structure representing the Light CTL Server model. More...

Typedefs
typedef struct meshx_lighting_server_cb_param	meshx_lighting_server_cb_param_t
typedef struct meshx_light_ctl_srv_state	meshx_light_ctl_srv_state_t
typedef struct meshx_light_ctl_srv	meshx_light_ctl_srv_t
	Structure representing the Light CTL Server model.

Functions
meshx_err_t	meshx_plat_light_srv_init (void)
	Initialize the platform-specific Light Server.
meshx_err_t	meshx_plat_light_ctl_setup_srv_create (meshx_ptr_t p_model, meshx_ptr_t *p_pub, meshx_ptr_t *p_ctl_srv)
	Creates and initializes a Light CTL (Color Temperature Lightness) Setup Server model instance.
meshx_err_t	meshx_plat_light_ctl_srv_create (meshx_ptr_t p_model, meshx_ptr_t *p_pub, meshx_ptr_t *p_ctl_srv)
	Create a Light CTL Server instance.
meshx_err_t	meshx_plat_light_srv_delete (meshx_ptr_t *p_pub, meshx_ptr_t *p_ctl_srv)
	Delete a Light CTL Server instance.
meshx_err_t	meshx_plat_set_light_ctl_srv_state (meshx_ptr_t p_model, uint16_t delta_uv, uint16_t lightness, uint16_t temperature, uint16_t temp_range_max, uint16_t temp_range_min)
	Set the state of the Light CTL Server.
meshx_err_t	meshx_plat_light_ctl_srv_restore (meshx_ptr_t p_model, uint16_t delta_uv, uint16_t lightness, uint16_t temperature, uint16_t temp_range_max, uint16_t temp_range_min)
	Restore the state of the Light CTL Server.
meshx_err_t	meshx_plat_gen_light_srv_send_status (const meshx_model_t *p_model, const meshx_ctx_t *p_ctx, const meshx_lighting_server_state_change_t *state_change)
	Send a status message from the Light Server. This function constructs and sends a status message containing the current state of the Light Server.

Detailed Description

Header file for the MeshX BLE Mesh Light Server module. This file defines the data structures, function prototypes, and callback parameters for managing the Light Server models in a BLE Mesh network. It includes support for various lighting models such as Light CTL, HSL, xyL, and LC.

Copyright (c) 2024 - 2025 MeshX

• Defines state change event structures for different lighting models.
• Provides APIs for initializing, creating, deleting, and managing Light Server instances.
• Supports Light CTL Server state management, including setting and restoring states.
• Includes callback parameters for handling received lighting messages.

Author

Pranjal Chanda

Definition in file meshx_ble_mesh_light_srv.h.

Typedef Documentation

meshx_light_ctl_srv_state_t

typedef struct meshx_light_ctl_srv_state meshx_light_ctl_srv_state_t

meshx_light_ctl_srv_t

typedef struct meshx_light_ctl_srv meshx_light_ctl_srv_t

Structure representing the Light CTL Server model.

This structure contains the model and state information for the Light CTL Server.

meshx_lighting_server_cb_param_t

typedef struct meshx_lighting_server_cb_param meshx_lighting_server_cb_param_t

Lighting Server Model callback parameters

Function Documentation

meshx_plat_gen_light_srv_send_status()

meshx_err_t meshx_plat_gen_light_srv_send_status	(	const meshx_model_t *	p_model,
		const meshx_ctx_t *	p_ctx,
		const meshx_lighting_server_state_change_t *	state_change )

Send a status message from the Light Server. This function constructs and sends a status message containing the current state of the Light Server.

Parameters

[in]	p_model	Pointer to the Light Server model.
[in]	p_ctx	Pointer to the context containing message information.
[in]	state_change	The state change data to be sent in the status message.

Returns

• MESHX_SUCCESS: Successfully sent the status message.
• MESHX_INVALID_ARG: Invalid argument provided.
• MESHX_ERR_PLAT: Platform-specific error occurred.

Definition at line 194 of file esp_light_srv_model.c.

{
    if (!p_model || !p_ctx || !state_change)
    {
        return MESHX_INVALID_ARG;
    }
    meshx_err_t err = MESHX_SUCCESS;
    static esp_ble_mesh_msg_ctx_t ctx;
    const esp_ble_mesh_msg_ctx_t *pctx = (esp_ble_mesh_msg_ctx_t *)p_ctx->p_ctx;
    if(pctx != NULL)
    {
        memcpy(&ctx, pctx, sizeof(esp_ble_mesh_msg_ctx_t));
    }
    meshx_plat_ctl_status_t ctl_status_union;
    uint8_t ctl_status_pack_len = 0;
 
    switch (p_ctx->opcode)
    {
    case MESHX_MODEL_OP_LIGHT_CTL_STATUS:
        ctl_status_union.ctl_status.temperature = state_change->ctl_set.temperature;
        ctl_status_union.ctl_status.lightness = state_change->ctl_set.lightness;
        ctl_status_pack_len = sizeof(ctl_status_union.ctl_status);
        break;
    case MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_STATUS:
        ctl_status_union.ctl_temp_status.temperature = state_change->ctl_temp_set.temperature;
        ctl_status_union.ctl_temp_status.delta_uv = state_change->ctl_temp_set.delta_uv;
        ctl_status_pack_len = sizeof(ctl_status_union.ctl_temp_status);
        break;
    case MESHX_MODEL_OP_LIGHT_CTL_DEFAULT_STATUS:
        ctl_status_union.ctl_default.delta_uv_def = state_change->ctl_default_set.delta_uv;
        ctl_status_union.ctl_default.lightness_def = state_change->ctl_default_set.lightness;
        ctl_status_union.ctl_default.temperature_def = state_change->ctl_default_set.temperature;
        ctl_status_pack_len = sizeof(ctl_status_union.ctl_default);
        break;
    case MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_RANGE_STATUS:
        ctl_status_union.ctl_temp_range.status_code = MESHX_SUCCESS;
        ctl_status_union.ctl_temp_range.range_min = state_change->ctl_temp_range_set.range_min;
        ctl_status_union.ctl_temp_range.range_max = state_change->ctl_temp_range_set.range_max;
        ctl_status_pack_len = sizeof(ctl_status_union.ctl_temp_range);
        break;
    default:
        err = MESHX_INVALID_ARG;
    }
 
    ctx.net_idx    =   p_ctx->net_idx;
    ctx.app_idx    =   p_ctx->app_idx;
    ctx.addr       =   p_ctx->dst_addr;
    ctx.send_ttl   =   ESP_BLE_MESH_TTL_DEFAULT;
    ctx.send_cred  =   0;
    ctx.send_tag   =   BIT1;
 
    esp_err_t esp_err = esp_ble_mesh_server_model_send_msg(p_model->p_model,
                                                       &ctx,
                                                       p_ctx->opcode,
                                                       ctl_status_pack_len,
                                                       (uint8_t *)&ctl_status_union);
    if (esp_err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Mesh Model msg send failed (err: 0x%x)", esp_err);
        return MESHX_ERR_PLAT;
    }
    MESHX_LOGD(MODULE_ID_MODEL_SERVER, "Mesh Model msg sent (opcode: 0x%04x, len: %d)", p_ctx->opcode, ctl_status_pack_len);
 
    return err;
}

Here is the caller graph for this function:

meshx_plat_light_ctl_setup_srv_create()

meshx_err_t meshx_plat_light_ctl_setup_srv_create	(	meshx_ptr_t	p_model,
		meshx_ptr_t *	p_pub,
		meshx_ptr_t *	p_ctl_srv )

Creates and initializes a Light CTL (Color Temperature Lightness) Setup Server model instance.

This function sets up the Light CTL Setup Server for a given model, configuring publication and server context pointers.

Parameters

[in]	p_model	Pointer to the parent model instance.
[out]	p_pub	Pointer to the publication context to be initialized.
[out]	p_ctl_srv	Pointer to the Light CTL Setup Server context to be initialized.

Returns

meshx_err_t Error code indicating the result of the operation.

• MESHX_OK on success
• Appropriate error code otherwise

Definition at line 293 of file esp_light_srv_model.c.

{
    if (!p_model || !p_pub || !p_ctl_srv)
        return MESHX_INVALID_ARG;
 
    meshx_err_t err = MESHX_SUCCESS;
 
    err = meshx_plat_create_model_pub(p_pub, 1);
    if (err)
        return meshx_plat_del_model_pub(p_pub);
 
    *p_ctl_srv = (MESHX_LIGHT_CTL_SETUP_SRV *)MESHX_CALOC(1, sizeof(MESHX_LIGHT_CTL_SETUP_SRV));
    if (!*p_ctl_srv)
        return MESHX_NO_MEM;
 
    /* SIG CTL Setup Server initialisation */
    memcpy(p_model, &light_ctl_setup_sig_template, sizeof(MESHX_MODEL));
 
    ((MESHX_LIGHT_CTL_SETUP_SRV *)*p_ctl_srv)->rsp_ctrl.get_auto_rsp = ESP_BLE_MESH_SERVER_AUTO_RSP;
    ((MESHX_LIGHT_CTL_SETUP_SRV *)*p_ctl_srv)->rsp_ctrl.set_auto_rsp = ESP_BLE_MESH_SERVER_AUTO_RSP;
 
    ((MESHX_LIGHT_CTL_SETUP_SRV *)*p_ctl_srv)->state = (MESHX_LIGHT_CTL_STATE *)MESHX_CALOC(1, sizeof(MESHX_LIGHT_CTL_STATE));
    if (!((MESHX_LIGHT_CTL_SETUP_SRV *)*p_ctl_srv)->state)
    {
        MESHX_FREE(*p_ctl_srv);
        return MESHX_NO_MEM;
    }
 
    ((MESHX_LIGHT_CTL_SETUP_SRV *)*p_ctl_srv)->state->temperature_range_max = 0;
    ((MESHX_LIGHT_CTL_SETUP_SRV *)*p_ctl_srv)->state->temperature_range_min = 0;
 
    ((MESHX_MODEL *)p_model)->user_data = *p_ctl_srv;
 
    meshx_ptr_t *temp = (meshx_ptr_t *)&((MESHX_MODEL *)p_model)->pub;
 
    *temp = *p_pub;
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_light_ctl_srv_create()

meshx_err_t meshx_plat_light_ctl_srv_create	(	meshx_ptr_t	p_model,
		meshx_ptr_t *	p_pub,
		meshx_ptr_t *	p_ctl_srv )

Create a Light CTL Server instance.

This function initializes and allocates resources for a Light CTL Server model.

Parameters

[in]	p_model	Pointer to the model instance.
[out]	p_pub	Pointer to the publication context.
[out]	p_ctl_srv	Pointer to the Light CTL Server instance.

Returns

• MESHX_SUCCESS on success.
• Appropriate error code on failure.

Definition at line 333 of file esp_light_srv_model.c.

{
    if (!p_model || !p_pub || !p_ctl_srv)
        return MESHX_INVALID_ARG;
 
    meshx_err_t err = MESHX_SUCCESS;
 
    err = meshx_plat_create_model_pub(p_pub, 1);
    if (err)
        return meshx_plat_del_model_pub(p_pub);
 
    *p_ctl_srv = (MESHX_LIGHT_CTL_SRV *)MESHX_CALOC(1, sizeof(MESHX_LIGHT_CTL_SRV));
    if (!*p_ctl_srv)
        return MESHX_NO_MEM;
 
    /* SIG ON OFF initialisation */
 
    memcpy(p_model, &light_ctl_sig_template, sizeof(MESHX_MODEL));
 
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->rsp_ctrl.get_auto_rsp = ESP_BLE_MESH_SERVER_AUTO_RSP;
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->rsp_ctrl.set_auto_rsp = ESP_BLE_MESH_SERVER_AUTO_RSP;
 
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state = (MESHX_LIGHT_CTL_STATE *)MESHX_CALOC(1, sizeof(MESHX_LIGHT_CTL_STATE));
    if (!((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state)
    {
        MESHX_FREE(*p_ctl_srv);
        return MESHX_NO_MEM;
    }
 
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state->temperature = 0;
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state->lightness = 0;
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state->delta_uv = 0;
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state->temperature_range_min = 0;
    ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state->temperature_range_max = 0;
 
    ((MESHX_MODEL *)p_model)->user_data = *p_ctl_srv;
 
    meshx_ptr_t *temp = (meshx_ptr_t *)&((MESHX_MODEL *)p_model)->pub;
 
    *temp = *p_pub;
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_light_ctl_srv_restore()

meshx_err_t meshx_plat_light_ctl_srv_restore	(	meshx_ptr_t	p_model,
		uint16_t	delta_uv,
		uint16_t	lightness,
		uint16_t	temperature,
		uint16_t	temp_range_max,
		uint16_t	temp_range_min )

Restore the state of the Light CTL Server.

This function restores the state of the Light CTL Server with the provided parameters.

Parameters

[in]	p_model	Pointer to the model instance.
[in]	delta_uv	Delta UV value.
[in]	lightness	Lightness value.
[in]	temperature	Temperature value.
[in]	temp_range_max	Maximum temperature range.
[in]	temp_range_min	Minimum temperature range.

Returns

• MESHX_SUCCESS on success.
• Appropriate error code on failure.

Definition at line 398 of file esp_light_srv_model.c.

{
    return meshx_plat_set_light_ctl_srv_state(
        p_model,
        delta_uv,
        lightness,
        temperature,
        temp_range_max,
        temp_range_min
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_light_srv_delete()

meshx_err_t meshx_plat_light_srv_delete	(	meshx_ptr_t *	p_pub,
		meshx_ptr_t *	p_ctl_srv )

Delete a Light CTL Server instance.

This function releases resources associated with a Light CTL Server model.

Parameters

[in,out]	p_pub	Pointer to the publication context to be deleted.
[in,out]	p_ctl_srv	Pointer to the Light CTL Server instance to be deleted.

Returns

• MESHX_SUCCESS on success.
• Appropriate error code on failure.

Definition at line 277 of file esp_light_srv_model.c.

{
    if (p_ctl_srv)
    {
        if(*p_ctl_srv && ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state)
        {
            MESHX_FREE(((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state);
            ((MESHX_LIGHT_CTL_SRV *)*p_ctl_srv)->state = NULL;
        }
        MESHX_FREE(*p_ctl_srv);
        *p_ctl_srv = NULL;
    }
 
    return meshx_plat_del_model_pub(p_pub);
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_light_srv_init()

meshx_err_t meshx_plat_light_srv_init

(

void

)

Initialize the platform-specific Light Server.

This function sets up the necessary resources for the Light Server.

Returns

• MESHX_SUCCESS on success.
• Appropriate error code on failure.

Definition at line 263 of file esp_light_srv_model.c.

{
    /* Register callback for enabling Sending of Model Msg From MeshX to BLE Layer */
    meshx_err_t err = MESHX_SUCCESS;
    /* Register the ESP Generic Server callback */
    esp_err_t esp_err = esp_ble_mesh_register_lighting_server_callback(
        (MESHX_LIGHT_SRV_CB)&meshx_ble_lightness_server_cb
    );
    if (esp_err != ESP_OK)
        err = MESHX_ERR_PLAT;
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_set_light_ctl_srv_state()

meshx_err_t meshx_plat_set_light_ctl_srv_state	(	meshx_ptr_t	p_model,
		uint16_t	delta_uv,
		uint16_t	lightness,
		uint16_t	temperature,
		uint16_t	temp_range_max,
		uint16_t	temp_range_min )

Set the state of the Light CTL Server.

This function updates the state of the Light CTL Server with the provided parameters.

Parameters

[in]	p_model	Pointer to the model instance.
[in]	delta_uv	Delta UV value.
[in]	lightness	Lightness value.
[in]	temperature	Temperature value.
[in]	temp_range_max	Maximum temperature range.
[in]	temp_range_min	Minimum temperature range.

Returns

• MESHX_SUCCESS on success.
• Appropriate error code on failure.

Definition at line 377 of file esp_light_srv_model.c.

{
    if (!p_model)
        return MESHX_INVALID_ARG;
 
    MESHX_MODEL *model = (MESHX_MODEL *)p_model;
    MESHX_LIGHT_CTL_SRV *srv = (MESHX_LIGHT_CTL_SRV *)model->user_data;
    srv->state->delta_uv = delta_uv;
    srv->state->lightness = lightness;
    srv->state->temperature = temperature;
    srv->state->temperature_range_min = temp_range_min;
    srv->state->temperature_range_max = temp_range_max;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function: