meshx_composition_builder.cpp File Reference

Implementation of MeshX Composition Builder and its C-wrapper. More...

#include <meshx_composition_builder.hpp>
#include <meshx_composition.hpp>
#include <meshx_device.hpp>
#include <variants/meshx_relay_element.hpp>
#include <variants/meshx_cwww_element.hpp>
#include <variants/meshx_sensor_element.hpp>
#include <variants/meshx_rgb_element.hpp>
#include <variants/meshx_root_element.hpp>

Functions
bool	meshx_builder_is_active (void)
	C-Wrapper Implementation.
meshx_err_t	meshx_builder_bake (dev_struct_t *pdev, uint16_t cid, uint16_t pid, uint16_t vid)
	Bakes the dynamic composition into the device structure.
void	meshx_builder_add_element (meshx_element_type_t type, uint16_t count)
	Adds elements of a specific type to the composition.
void	meshx_builder_begin (void)
	C-Friendly Builder functions.
void	meshx_builder_commit (void)

Detailed Description

Implementation of MeshX Composition Builder and its C-wrapper.

Author

Pranjal Chanda

Date

2024-2025

Function Documentation

meshx_builder_add_element()

void meshx_builder_add_element	(	meshx_element_type_t	type,
		uint16_t	count )

Adds elements of a specific type to the composition.

Parameters

type	The type of element to add.
count	The number of elements of this type to add.

                                                                          {
    meshXCompositionBuilder builder;
    switch(type) {
#if CONFIG_RELAY_SERVER_COUNT > 0
        case MESHX_ELEMENT_TYPE_RELAY_SERVER:
            for(uint16_t i=0; i<count; ++i) builder.add_relay_server();
            break;
#endif
#if CONFIG_RELAY_CLIENT_COUNT > 0
        case MESHX_ELEMENT_TYPE_RELAY_CLIENT:
            for(uint16_t i=0; i<count; ++i) builder.add_relay_client();
            break;
#endif
#if CONFIG_LIGHT_CWWW_SRV_COUNT > 0
        case MESHX_ELEMENT_TYPE_LIGHT_CWWW_SERVER:
            for(uint16_t i=0; i<count; ++i) builder.add_cwww_server();
            break;
#endif
#if CONFIG_LIGHT_CWWW_CLIENT_COUNT > 0
        case MESHX_ELEMENT_TYPE_LIGHT_CWWW_CLIENT:
            for(uint16_t i=0; i<count; ++i) builder.add_cwww_client();
            break;
#endif
#if CONFIG_SENSOR_SERVER_COUNT > 0
        case MESHX_ELEMENT_TYPE_SENSOR_SERVER:
            for(uint16_t i=0; i<count; ++i) builder.add_sensor_server();
            break;
#endif
#if CONFIG_RGB_SERVER_COUNT > 0
        case MESHX_ELEMENT_TYPE_LIGHT_HSL_SERVER:
            for(uint16_t i=0; i<count; ++i) builder.add_rgb_server();
            break;
#endif
        default:
            MESHX_LOGW(MODULE_ID_COMMON, "Builder: No implementation for element type %d", type);
            break;
    }
}

meshx_builder_bake()

meshx_err_t meshx_builder_bake	(	dev_struct_t *	pdev,
		uint16_t	cid,
		uint16_t	pid,
		uint16_t	vid )

Bakes the dynamic composition into the device structure.

Parameters

pdev	Pointer to the device structure.
cid	Company ID.
pid	Product ID.
vid	Version ID.

Returns

MESHX_SUCCESS on success, or error code.

                                                                                             {
    // 1. Initialize the C++ Device wrapper
    meshXDevice::get_instance().init(pdev);
 
    // 2. Perform the bake
    meshXComposition::get_instance().set_device_struct(pdev);
    meshx_err_t err = meshXComposition::get_instance().bake(cid, pid, vid);
 
    // 3. Visualize the result
    if (err == MESHX_SUCCESS) {
        meshXDevice::get_instance().visualize_status();
    }
 
    return err;
}

meshx_builder_begin()

void meshx_builder_begin

(

void

)

C-Friendly Builder functions.

C-friendly builder lifecycle functions.

                               {
    meshXCompositionBuilder builder;
    builder.begin();
}

meshx_builder_commit()

void meshx_builder_commit

(

void

)

                                {
    meshXCompositionBuilder builder;
    builder.commit();
}

meshx_builder_is_active()

bool meshx_builder_is_active

(

void

)

C-Wrapper Implementation.

Checks if a dynamic composition has been built.

                                   {
    return meshXComposition::get_instance().has_elements();
}