meshx_light_cwww_client_element.h File Reference

Implementation of the CW-WW (Cool White - Warm White) client model for BLE Mesh. More...

#include "meshx_common.h"
#include "meshx_control_task.h"
#include "meshx_onoff_client.h"
#include "meshx_light_ctl_client.h"

Include dependency graph for meshx_light_cwww_client_element.h:

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

Go to the source code of this file.

Data Structures
struct	cwww_cli_ctx
	Structure to hold the context of the cwww client. More...
struct	cwww_client_msg
	Structure to hold the cwww client message sent from APP layer. More...
struct	cwww_client_element
	Structure to hold the cwww client element. More...
struct	cwww_client_element_ctrl
	Structure to hold the cwww client elements. More...

Macros
#define	CWWW_CLI_MODEL_SIG_CNT   CWWW_CLI_SIG_ID_MAX
	Number of SIG models in a CW-WW model element.
#define	CWWW_CLI_MODEL_VEN_CNT   0
	Number of Vendor models in a CW-WW model element.
#define	CWWW_CLI_MSG_SET   0
	Message type for setting CW-WW client state.
#define	CWWW_CLI_MSG_GET   1
	Message type for getting CW-WW client state.
#define	CWWW_CLI_MSG_ACK   1
	Acknowledgment message type.
#define	CWWW_CLI_MSG_NO_ACK   0
	Non-acknowledgment message type.
#define	CWWW_ARG_BMAP_ONOFF_SET   MESHX_BIT(0)
#define	CWWW_ARG_BMAP_LIGHTNESS_SET   MESHX_BIT(1)
#define	CWWW_ARG_BMAP_TEMPERATURE_SET   MESHX_BIT(2)
#define	CWWW_ARG_BMAP_DELTA_UV_SET   MESHX_BIT(3)
#define	CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MIN   MESHX_BIT(4)
#define	CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MAX   MESHX_BIT(5)
#define	CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET   (CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MIN | CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MAX)
	Argument bitmap for setting the temperature range.
#define	CWWW_ARG_BMAP_CTL_SET   (CWWW_ARG_BMAP_LIGHTNESS_SET | CWWW_ARG_BMAP_TEMPERATURE_SET | CWWW_ARG_BMAP_DELTA_UV_SET)
	Argument bitmap for setting the CW-WW client control state.
#define	CWWW_ARG_BMAP_ALL   (CWWW_ARG_BMAP_ONOFF_SET | CWWW_ARG_BMAP_CTL_SET | CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET)
	Argument bitmap for setting all CW-WW client states.

Typedefs
typedef struct cwww_cli_ctx	meshx_cwww_client_model_ctx_t
	Structure to hold the context of the cwww client.
typedef struct cwww_client_msg	meshx_cwww_client_msg_t
	Structure to hold the cwww client message sent from APP layer.
typedef struct cwww_client_element	meshx_cwww_client_elements_t
	Structure to hold the cwww client element.
typedef struct cwww_client_element_ctrl	meshx_cwww_client_elements_ctrl_t
	Structure to hold the cwww client elements.

Enumerations
enum	cwww_cli_sig_id_t {   CWWW_CLI_SIG_ONOFF_MODEL_ID ,   CWWW_CLI_SIG_L_CTL_MODEL_ID ,   CWWW_CLI_SIG_ID_MAX }
	Enumeration of CW-WW SIG model IDs. More...

Functions
meshx_err_t	meshx_cwww_el_get_state (uint16_t element_id, cwww_cli_sig_id_t model_id)
	Retrieves the current state of the CW/WW (Cool White/Warm White) light element for the specified element ID.
meshx_err_t	create_cwww_client_elements (dev_struct_t *pdev, uint16_t element_cnt)
	Create Dynamic CW-WW Model Elements.

Detailed Description

Implementation of the CW-WW (Cool White - Warm White) client model for BLE Mesh.

Copyright © 2024 - 2025 MeshX

Author

Pranjal Chanda

Definition in file meshx_light_cwww_client_element.h.

Macro Definition Documentation

CWWW_ARG_BMAP_ALL

#define CWWW_ARG_BMAP_ALL   (CWWW_ARG_BMAP_ONOFF_SET | CWWW_ARG_BMAP_CTL_SET | CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET)

Argument bitmap for setting all CW-WW client states.

Definition at line 78 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_CTL_SET

#define CWWW_ARG_BMAP_CTL_SET   (CWWW_ARG_BMAP_LIGHTNESS_SET | CWWW_ARG_BMAP_TEMPERATURE_SET | CWWW_ARG_BMAP_DELTA_UV_SET)

Argument bitmap for setting the CW-WW client control state.

Definition at line 72 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_DELTA_UV_SET

#define CWWW_ARG_BMAP_DELTA_UV_SET   MESHX_BIT(3)

Definition at line 58 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_LIGHTNESS_SET

#define CWWW_ARG_BMAP_LIGHTNESS_SET   MESHX_BIT(1)

Definition at line 56 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_ONOFF_SET

#define CWWW_ARG_BMAP_ONOFF_SET   MESHX_BIT(0)

Definition at line 55 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET

#define CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET   (CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MIN | CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MAX)

Argument bitmap for setting the temperature range.

Definition at line 66 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MAX

#define CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MAX   MESHX_BIT(5)

Definition at line 60 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MIN

#define CWWW_ARG_BMAP_TEMPERATURE_RANGE_SET_MIN   MESHX_BIT(4)

Definition at line 59 of file meshx_light_cwww_client_element.h.

CWWW_ARG_BMAP_TEMPERATURE_SET

#define CWWW_ARG_BMAP_TEMPERATURE_SET   MESHX_BIT(2)

Definition at line 57 of file meshx_light_cwww_client_element.h.

CWWW_CLI_MODEL_SIG_CNT

#define CWWW_CLI_MODEL_SIG_CNT   CWWW_CLI_SIG_ID_MAX

Number of SIG models in a CW-WW model element.

Definition at line 23 of file meshx_light_cwww_client_element.h.

CWWW_CLI_MODEL_VEN_CNT

#define CWWW_CLI_MODEL_VEN_CNT   0

Number of Vendor models in a CW-WW model element.

Definition at line 29 of file meshx_light_cwww_client_element.h.

CWWW_CLI_MSG_ACK

#define CWWW_CLI_MSG_ACK   1

Acknowledgment message type.

Definition at line 47 of file meshx_light_cwww_client_element.h.

CWWW_CLI_MSG_GET

#define CWWW_CLI_MSG_GET   1

Message type for getting CW-WW client state.

Definition at line 41 of file meshx_light_cwww_client_element.h.

CWWW_CLI_MSG_NO_ACK

#define CWWW_CLI_MSG_NO_ACK   0

Non-acknowledgment message type.

Definition at line 53 of file meshx_light_cwww_client_element.h.

CWWW_CLI_MSG_SET

#define CWWW_CLI_MSG_SET   0

Message type for setting CW-WW client state.

Definition at line 35 of file meshx_light_cwww_client_element.h.

Typedef Documentation

meshx_cwww_client_elements_ctrl_t

typedef struct cwww_client_element_ctrl meshx_cwww_client_elements_ctrl_t

Structure to hold the cwww client elements.

meshx_cwww_client_elements_t

typedef struct cwww_client_element meshx_cwww_client_elements_t

Structure to hold the cwww client element.

meshx_cwww_client_model_ctx_t

typedef struct cwww_cli_ctx meshx_cwww_client_model_ctx_t

Structure to hold the context of the cwww client.

meshx_cwww_client_msg_t

typedef struct cwww_client_msg meshx_cwww_client_msg_t

Structure to hold the cwww client message sent from APP layer.

Enumeration Type Documentation

cwww_cli_sig_id_t

enum cwww_cli_sig_id_t

Enumeration of CW-WW SIG model IDs.

Enumerator
CWWW_CLI_SIG_ONOFF_MODEL_ID	On/Off model ID
CWWW_CLI_SIG_L_CTL_MODEL_ID	Light CTL model ID
CWWW_CLI_SIG_ID_MAX	Maximum number of model IDs

Definition at line 83 of file meshx_light_cwww_client_element.h.

{
    CWWW_CLI_SIG_ONOFF_MODEL_ID, 
    CWWW_CLI_SIG_L_CTL_MODEL_ID, 
    CWWW_CLI_SIG_ID_MAX          
} cwww_cli_sig_id_t;

Function Documentation

create_cwww_client_elements()

meshx_err_t create_cwww_client_elements	(	dev_struct_t *	pdev,
		uint16_t	element_cnt )

Create Dynamic CW-WW Model Elements.

Parameters

[in]	pdev	Pointer to device structure
[in]	element_cnt	Maximum number of CW-WW models

Returns

meshx_err_t

Definition at line 998 of file meshx_light_cwww_client.c.

{
    meshx_err_t err;
 
    err = meshx_dev_create_cwww_model_space(pdev, element_cnt);
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "CWWW Model space create failed: (%d)", err);
        return err;
    }
 
    err = meshx_add_cwww_cli_model_to_element_list(pdev, (uint16_t *)&pdev->element_idx, element_cnt);
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "CWWW Model add to element create failed: (%d)", err);
        return err;
    }
 
    err = meshx_on_off_client_init();
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "meshx_onoff_client_init failed: (%d)", err);
        return err;
    }
 
    err = meshx_light_ctl_client_init();
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "meshx_light_ctl_client_init failed: (%d)", err);
        return err;
    }
 
#if CONFIG_ENABLE_CONFIG_SERVER
    err = meshx_config_server_cb_reg(
        (config_srv_cb_t) &cwww_client_config_srv_cb,
        CONFIG_SERVER_CB_MASK);
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "Light CWWW config server callback reg failed: (%d)", err);
        return err;
    }
#endif /* CONFIG_ENABLE_CONFIG_SERVER */
 
#if defined(__MESHX_CONTROL_TASK__)
    /* Register control task callback */
    err = meshx_cwww_cli_reg_app_req_cb();
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "control task callback reg failed: (%d)", err);
        return err;
    }
    /* Register element state change callback */
    err = meshx_cwww_cli_el_state_change_reg_cb();
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "element state change callback reg failed: (%d)", err);
        return err;
    }
    /* Register freshboot control task callback */
    err = meshx_prov_srv_reg_el_client_cb(
        (prov_srv_cb_t)&cwww_cli_prov_srv_msg_handle);
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "control task callback reg failed: (%d)", err);
        return err;
    }
 
#endif /* __MESHX_CONTROL_TASK__ */
#if CONFIG_ENABLE_UNIT_TEST
    err = register_unit_test(MODULE_ID_ELEMENT_LIGHT_CWWWW_CLIENT, &cwww_cli_unit_test_cb_handler);
    if (err)
    {
        MESHX_LOGE(MOD_LCC, "unit_test reg failed: (%d)", err);
        return err;
    }
#endif /* CONFIG_ENABLE_UNIT_TEST */
 
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_cwww_el_get_state()

meshx_err_t meshx_cwww_el_get_state	(	uint16_t	element_id,
		cwww_cli_sig_id_t	model_id )

Retrieves the current state of the CW/WW (Cool White/Warm White) light element for the specified element ID.

This function queries the state of a light element identified by the given element_id.

Parameters

[in]	element_id	The unique identifier of the light element whose state is to be retrieved.
[in]	model_id	The model ID to specify which model's state to retrieve. If set to CWWW_CLI_SIG_ID_MAX, it retrieves the state for all models.

Returns

meshx_err_t Returns MESHX_OK on success, or an appropriate error code on failure.

Definition at line 931 of file meshx_light_cwww_client.c.

{
    if (!IS_EL_IN_RANGE(element_id))
    {
        MESHX_LOGE(MOD_LCC, "Invalid element id: %d", element_id);
        return MESHX_INVALID_ARG;
    }
    meshx_cwww_client_msg_t msg = {0};
    msg.ack = CWWW_CLI_MSG_ACK;
    msg.set_get = CWWW_CLI_MSG_GET;
    msg.element_id = element_id;
 
    if (model_id != CWWW_CLI_SIG_ID_MAX)
    {
        MESHX_LOGD(MOD_LCC, "Sending GET for model: %d", model_id);
        if(model_id == CWWW_CLI_SIG_L_CTL_MODEL_ID)
        {
            control_task_msg_publish(
                CONTROL_TASK_MSG_CODE_TO_BLE,
                CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL,
                &msg,
                sizeof(msg));
        }
        else
        {
            control_task_msg_publish(
                CONTROL_TASK_MSG_CODE_TO_BLE,
                CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF,
                &msg,
                sizeof(msg));
        }
    }
    else
    {
        for(model_id = CWWW_CLI_SIG_ONOFF_MODEL_ID; model_id < CWWW_CLI_SIG_ID_MAX; model_id++)
        {
 
            MESHX_LOGD(MOD_LCC, "Sending GET for model: %d", model_id);
            if(model_id == CWWW_CLI_SIG_L_CTL_MODEL_ID)
            {
                control_task_msg_publish(
                    CONTROL_TASK_MSG_CODE_TO_BLE,
                    CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL,
                    &msg,
                    sizeof(msg));
            }
            else
            {
                control_task_msg_publish(
                    CONTROL_TASK_MSG_CODE_TO_BLE,
                    CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF,
                    &msg,
                    sizeof(msg));
            }
        }
    }
    return MESHX_SUCCESS;
}

Here is the call graph for this function: