meshx_cwww_element.cpp File Reference

Implementation of MeshX CWWW Element (Tasks A-E). More...

#include <cstring>
#include <meshx_element_factory.hpp>
#include <meshx_element_registry.hpp>
#include <variants/meshx_cwww_element.hpp>
#include <light_model/meshx_model_ctl.hpp>
#include <generic_model/meshx_model_onoff.hpp>
#include <variants/meshx_relay_msg_defs.h>

Data Structures
struct	meshx_light_ctl_cli_msg

Macros
#define	CONFIG_SERVER_CB_MASK
#define	CWWW_CLI_TO_BLE_EVT_MASK   (CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF | CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL)
#define	CWWW_SRV_TO_BLE_EVT_MASK   (CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF_SRV | CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL_SRV)
#define	MESHX_GEN_ON_OFF_CLI_MSG_ACK   1
#define	MESHX_GEN_ON_OFF_CLI_MSG_NO_ACK   0

Typedefs
typedef struct meshx_light_ctl_cli_msg	meshx_light_ctl_cli_msg_t

Functions
meshx_err_t	cwww_cli_ut_handler (int cmd_id, int argc, char **argv)
meshx_err_t	cwww_srv_ut_handler (int cmd_id, int argc, char **argv)
meshx_err_t	create_cwww_server_elements_cpp (dev_struct_t *pdev, uint16_t element_cnt)
	C++ factory for CWWW Server elements.
meshx_err_t	create_cwww_client_elements_cpp (dev_struct_t *pdev, uint16_t element_cnt)
	C++ factory for CWWW Client elements.

Detailed Description

Implementation of MeshX CWWW Element (Tasks A-E).

Author

Pranjal Chanda

Date

2024-2025

Copyright

Copyright 2024 - 2025 MeshX

Macro Definition Documentation

CONFIG_SERVER_CB_MASK

#define CONFIG_SERVER_CB_MASK

Value:

  CONTROL_TASK_MSG_EVT_PUB_ADD  \
| CONTROL_TASK_MSG_EVT_PUB_DEL  \
| CONTROL_TASK_MSG_EVT_APP_KEY_BIND

#define CONFIG_SERVER_CB_MASK   \
    CONTROL_TASK_MSG_EVT_PUB_ADD  \
  | CONTROL_TASK_MSG_EVT_PUB_DEL  \
  | CONTROL_TASK_MSG_EVT_APP_KEY_BIND

CWWW_CLI_TO_BLE_EVT_MASK

#define CWWW_CLI_TO_BLE_EVT_MASK   (CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF | CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL)

CWWW_SRV_TO_BLE_EVT_MASK

#define CWWW_SRV_TO_BLE_EVT_MASK   (CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF_SRV | CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL_SRV)

MESHX_GEN_ON_OFF_CLI_MSG_ACK

#define MESHX_GEN_ON_OFF_CLI_MSG_ACK   1

MESHX_GEN_ON_OFF_CLI_MSG_NO_ACK

#define MESHX_GEN_ON_OFF_CLI_MSG_NO_ACK   0

Typedef Documentation

meshx_light_ctl_cli_msg_t

typedef struct meshx_light_ctl_cli_msg meshx_light_ctl_cli_msg_t

Function Documentation

create_cwww_client_elements_cpp()

meshx_err_t create_cwww_client_elements_cpp	(	dev_struct_t *	pdev,
		uint16_t	element_cnt )

C++ factory for CWWW Client elements.

Constructs CONFIG_LIGHT_CWWW_CLIENT_COUNT meshXCWWWClientElement objects and registers each with the platform BLE Mesh composition.

Parameters

pdev	Pointer to the device structure.
element_cnt	Number of light CWWW client elements to create. Capped by CONFIG_LIGHT_CWWW_CLI_COUNT.

Returns

MESHX_SUCCESS on success, error code otherwise.

{
    return meshx_element_factory_helper<meshXCWWWClientElement, meshx_cwww_cli_el_ctx_t>(
        pdev,
        element_cnt,
        CONFIG_LIGHT_CWWW_CLIENT_COUNT,
        MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT,
        "CWWW Cli"
    );
}

create_cwww_server_elements_cpp()

meshx_err_t create_cwww_server_elements_cpp	(	dev_struct_t *	pdev,
		uint16_t	element_cnt )

C++ factory for CWWW Server elements.

Constructs CONFIG_LIGHT_CWWW_SRV_COUNT meshXCWWWServerElement objects and registers each with the platform BLE Mesh composition.

Parameters

pdev	Pointer to the device structure.
element_cnt	Number of light CWWW server elements to create. Capped by CONFIG_LIGHT_CWWW_SRV_COUNT.

Returns

MESHX_SUCCESS on success, error code otherwise.

{
    return meshx_element_factory_helper<meshXCWWWServerElement, meshx_cwww_srv_el_ctx_t>(
        pdev,
        element_cnt,
        CONFIG_LIGHT_CWWW_SRV_COUNT,
        MODULE_ID_ELEMENT_LIGHT_CWWW_SERVER,
        "CWWW Srv"
    );
}

cwww_cli_ut_handler()

meshx_err_t cwww_cli_ut_handler	(	int	cmd_id,
		int	argc,
		char **	argv )

{
    if (argc < 1) return MESHX_INVALID_ARG;
    uint16_t el_id = UT_GET_ARG(0, uint16_t, argv);
 
    MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: cmd_id=%d, argc=%d, el_id=%d", cmd_id, argc, el_id);
 
    auto *el = meshXElementRegistry::get_instance().find_and_cast<meshXCWWWClientElement>(
        el_id, MESHX_ELEMENT_TYPE_LIGHT_CWWW_CLIENT);
    if (!el) {
        MESHX_LOGE(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: Element %d not found!", el_id);
        return MESHX_NOT_FOUND;
    }
 
    auto &ctx = el->get_ctx();
    MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "CWWW Cli [%d]: pub_addr=0x%04x, app_id=%d", el_id, ctx.pub_addr, ctx.app_id);
    if (ctx.pub_addr == MESHX_ADDR_UNASSIGNED) {
        MESHX_LOGW(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "CWWW Cli [%d]: no pub addr", el_id);
    }
 
    if (cmd_id == 0x01 || cmd_id == 0x02) { // ONOFF SET / SET UNACK
        meshx_gen_on_off_cli_msg_t msg = {};
        msg.ack        = (uint8_t)(cmd_id == 0x01 ? 1 : 0);
        msg.set_get    = MESHX_GEN_ON_OFF_CLI_MSG_SET;
        msg.on_off     = ctx.gen_on_off_state.next_on_off;
        msg.reserved   = 0;
        msg.element_id = el_id;
 
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: Publishing ONOFF SET, on_off=%d, ack=%d, size=%zu",
                   msg.on_off, msg.ack, sizeof(msg));
        return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE, CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF, &msg, sizeof(msg));
    }
    else if (cmd_id == 0x04 || cmd_id == 0x05) { // CTL SET / SET UNACK
        if (argc < 4) return MESHX_INVALID_ARG;
        meshx_light_ctl_cli_msg_t msg = {};
        msg.ack        = (cmd_id == 0x04);
        msg.set_get    = MESHX_GEN_ON_OFF_CLI_MSG_SET;
        msg.element_id = el_id;
 
        msg.lightness   = UT_GET_ARG(1, uint16_t, argv);
        msg.temperature = UT_GET_ARG(2, uint16_t, argv);
        msg.delta_uv    = UT_GET_ARG(3, int16_t, argv);
 
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: Publishing CTL SET, light=%d, temp=%d, delta=%d, ack=%d, size=%zu",
                   msg.lightness, msg.temperature, msg.delta_uv, msg.ack, sizeof(msg));
        return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE, CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL, &msg, sizeof(msg));
    }
    else if (cmd_id == 0x06 || cmd_id == 0x07) { // LIGHTNESS SET / UNACK
        if (argc < 2) return MESHX_INVALID_ARG;
        meshx_light_ctl_cli_msg_t msg = {};
        msg.ack        = (cmd_id == 0x06);
        msg.set_get    = MESHX_GEN_ON_OFF_CLI_MSG_SET;
        msg.element_id = el_id;
        msg.lightness   = UT_GET_ARG(1, uint16_t, argv);
        msg.temperature = ctx.light_ctl_state.temperature;
        msg.delta_uv    = ctx.light_ctl_state.delta_uv;
 
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: Publishing Lightness SET, value=%d, ack=%d, size=%zu",
                   msg.lightness, msg.ack, sizeof(msg));
        return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE, CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL, &msg, sizeof(msg));
    }
    else if (cmd_id == 0x08 || cmd_id == 0x09) { // TEMPERATURE SET / UNACK
        if (argc < 2) return MESHX_INVALID_ARG;
        meshx_light_ctl_cli_msg_t msg = {};
        msg.ack        = (cmd_id == 0x08);
        msg.set_get    = MESHX_GEN_ON_OFF_CLI_MSG_SET;
        msg.element_id = el_id;
        msg.temperature = UT_GET_ARG(1, uint16_t, argv);
        msg.lightness   = ctx.light_ctl_state.lightness;
        msg.delta_uv    = ctx.light_ctl_state.delta_uv;
 
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: Publishing Temp SET, value=%d, ack=%d, size=%zu",
                   msg.temperature, msg.ack, sizeof(msg));
        return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE, CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL, &msg, sizeof(msg));
    }
    else if (cmd_id == 0x0A || cmd_id == 0x0B) { // DELTA UV SET / UNACK
        if (argc < 2) return MESHX_INVALID_ARG;
        meshx_light_ctl_cli_msg_t msg = {};
        msg.ack        = (cmd_id == 0x0A);
        msg.set_get    = MESHX_GEN_ON_OFF_CLI_MSG_SET;
        msg.element_id = el_id;
        msg.delta_uv    = UT_GET_ARG(1, int16_t, argv);
        msg.lightness   = ctx.light_ctl_state.lightness;
        msg.temperature = ctx.light_ctl_state.temperature;
 
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_CLIENT, "cwww_cli_ut_handler: Publishing DeltaUV SET, value=%d, ack=%d, size=%zu",
                   msg.delta_uv, msg.ack, sizeof(msg));
        return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE, CONTROL_TASK_MSG_EVT_TO_BLE_SET_CTL, &msg, sizeof(msg));
    }
    return MESHX_FAIL;
}

cwww_srv_ut_handler()

meshx_err_t cwww_srv_ut_handler	(	int	cmd_id,
		int	argc,
		char **	argv )

{
    if (argc < 1) return MESHX_INVALID_ARG;
    uint16_t el_id = UT_GET_ARG(0, uint16_t, argv);
 
    MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_SERVER, "cwww_srv_ut_handler: cmd_id=%d, argc=%d, el_id=%d", cmd_id, argc, el_id);
 
    auto *el = meshXElementRegistry::get_instance().find_and_cast<meshXCWWWServerElement>(
        el_id, MESHX_ELEMENT_TYPE_LIGHT_CWWW_SERVER);
    if (!el) {
        MESHX_LOGE(MODULE_ID_ELEMENT_LIGHT_CWWW_SERVER, "cwww_srv_ut_handler: Element %d not found!", el_id);
        return MESHX_NOT_FOUND;
    }
 
    if (cmd_id == 0x01) { // Check ONOFF state
        uint8_t expected = UT_GET_ARG(1, uint8_t, argv);
        uint8_t actual = el->get_onoff();
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_SERVER, "CWWW Server [%d] ONOFF state: %d, expected: %d", el_id, actual, expected);
        return (actual == expected) ? MESHX_SUCCESS : MESHX_FAIL;
    }
    else if (cmd_id == 0x02) { // Check CTL state
        uint16_t exp_light = UT_GET_ARG(1, uint16_t, argv);
        uint16_t exp_temp  = UT_GET_ARG(2, uint16_t, argv);
        auto actual = el->get_ctl();
        MESHX_LOGI(MODULE_ID_ELEMENT_LIGHT_CWWW_SERVER, "CWWW Server [%d] CTL state: light %d, temp %d, expected: light %d, temp %d",
                   el_id, actual.lightness, actual.temperature, exp_light, exp_temp);
        return (actual.lightness == exp_light && actual.temperature == exp_temp) ? MESHX_SUCCESS : MESHX_FAIL;
    }
    return MESHX_FAIL;
}