meshx.c File Reference

meshX application file for ESP BLE Mesh node. More...

#include "meshx.h"

Include dependency graph for meshx.c:

Go to the source code of this file.

Macros
#define	ROOT_ELEMENT_IDX   0
	Defines the index for the root element.
#define	FRESHBOOT_TIMEOUT_MS   1500
	Defines the timeout duration in milliseconds for a fresh boot.

Functions
size_t	get_root_sig_models_count (void)
	Returns the count of the root models.
size_t	get_root_ven_models_count (void)
	Returns the count of the vendor root models.
meshx_ptr_t	get_root_sig_models (void)
	Returns the root models for BLE Mesh elements.
meshx_ptr_t	get_root_ven_models (void)
	Returns the root models for BLE Mesh elements.
meshx_err_t	meshx_create_element_composition (dev_struct_t *p_dev, meshx_config_t const *config)
	Creates the BLE Mesh element composition.
static meshx_err_t	meshx_element_init (dev_struct_t *p_dev, meshx_config_t const *config)
	Initializes BLE Mesh elements.
static meshx_err_t	meshx_tasks_init (dev_struct_t *pdev)
	Initializes application tasks.
static meshx_err_t	meshx_dev_restore (dev_struct_t *pdev, meshx_config_t const *config)
	Restore the device state from the NVS.
static meshx_err_t	meshx_ble_mesh_init (meshx_config_t *config)
	Initializes the BLE Mesh subsystem.
meshx_err_t	meshx_init (meshx_config_t const *config)
	MeshX initialisation function.

Variables
static const char	meshX_banner []
static dev_struct_t	g_dev
static meshx_config_t	g_config
meshx_prov_params_t	g_prov_cfg

Detailed Description

meshX application file for ESP BLE Mesh node.

Copyright

Copyright © 2024 - 2025 MeshX

This file contains initialization routines for BLE Mesh provisioning, configuration, and light control servers, as well as the main application entry point.

Author

Pranjal Chanda

Definition in file meshx.c.

Macro Definition Documentation

FRESHBOOT_TIMEOUT_MS

#define FRESHBOOT_TIMEOUT_MS   1500

Defines the timeout duration in milliseconds for a fresh boot.

Definition at line 25 of file meshx.c.

ROOT_ELEMENT_IDX

#define ROOT_ELEMENT_IDX   0

Defines the index for the root element.

Definition at line 19 of file meshx.c.

Function Documentation

get_root_sig_models()

meshx_ptr_t get_root_sig_models ( void )

extern

Returns the root models for BLE Mesh elements.

Returns

Pointer to the root models.

Definition at line 89 of file composition.c.

{
    meshx_err_t err;
    static MESHX_MODEL temp_model;
    if(meshx_sig_root_model_arr == NULL && meshx_sig_root_model_arr_len)
    {
        meshx_sig_root_model_arr = (MESHX_MODEL *) MESHX_MALLOC(sizeof(MESHX_MODEL) * meshx_sig_root_model_arr_len);
        if(meshx_sig_root_model_arr == NULL)
        {
            MESHX_LOGE(MODULE_ID_COMMON, "Failed to allocate memory for root models");
            return NULL;
        }
        memset(meshx_sig_root_model_arr, 0, sizeof(MESHX_MODEL) * meshx_sig_root_model_arr_len);
 
        for(uint16_t i = 0; i < meshx_sig_root_model_arr_len; i++)
        {
            if(meshx_sig_root_model_getfn[i] == NULL)
            {
                continue;
            }
            err = meshx_sig_root_model_getfn[i]((void**)&temp_model);
            if (err != MESHX_SUCCESS)
            {
                MESHX_LOGE(MODULE_ID_COMMON, "Failed to get root model (%p) (%d)", meshx_sig_root_model_getfn[i], err);
                return NULL;
            }
            memcpy(&meshx_sig_root_model_arr[i], &temp_model, sizeof(MESHX_MODEL));
        }
    }
    return meshx_sig_root_model_arr;
}

Here is the caller graph for this function:

get_root_sig_models_count()

size_t get_root_sig_models_count ( void )

extern

Returns the count of the root models.

Returns

Size of the root models.

Definition at line 156 of file composition.c.

{
    return meshx_sig_root_model_arr_len;
}

Here is the caller graph for this function:

get_root_ven_models()

meshx_ptr_t get_root_ven_models ( void )

extern

Returns the root models for BLE Mesh elements.

Returns

Pointer to the root models.

Definition at line 126 of file composition.c.

{
    static MESHX_MODEL temp_model;
    if(meshx_ven_root_model_arr == NULL && meshx_ven_root_model_arr_len)
    {
        meshx_ven_root_model_arr = (MESHX_MODEL *) MESHX_MALLOC(sizeof(MESHX_MODEL) * meshx_ven_root_model_arr_len);
        if(meshx_ven_root_model_arr == NULL)
        {
            MESHX_LOGE(MODULE_ID_COMMON, "Failed to allocate memory for root models");
            return NULL;
        }
        memset(meshx_ven_root_model_arr, 0, sizeof(MESHX_MODEL) * meshx_ven_root_model_arr_len);
 
        for(uint16_t i = 0; i < meshx_ven_root_model_arr_len; i++)
        {
            if(meshx_ven_root_model_getfn[i] == NULL)
            {
                continue;
            }
            meshx_ven_root_model_getfn[i]((void**)&temp_model);
            memcpy(&meshx_ven_root_model_arr[i], &temp_model, sizeof(MESHX_MODEL));
        }
    }
    return meshx_ven_root_model_arr;
}

get_root_ven_models_count()

size_t get_root_ven_models_count ( void )

extern

Returns the count of the vendor root models.

Returns

Size of the vendor root models.

Definition at line 166 of file composition.c.

{
    return meshx_ven_root_model_arr_len;
}

Here is the caller graph for this function:

meshx_ble_mesh_init()

static meshx_err_t meshx_ble_mesh_init ( meshx_config_t * config )

static

Initializes the BLE Mesh subsystem.

This function sets up provisioning, configuration servers, and BLE Mesh stack initialization.

Returns

MESHX_SUCCESS on success, error code otherwise.

Definition at line 194 of file meshx.c.

{
    if(config == NULL || config->product_name == NULL)
        return MESHX_INVALID_ARG;
 
    meshx_err_t err;
    g_prov_cfg.node_name = (uint8_t *)config->product_name;
 
    err = meshx_platform_bt_init(config->meshx_uuid_addr);
    MESHX_ERR_PRINT_RET("Platform BT init failed", err);
 
    g_prov_cfg.uuid = config->meshx_uuid_addr;
    g_prov_cfg.freshboot_timeout_ms = FRESHBOOT_TIMEOUT_MS;
 
    meshx_dev_restore(&g_dev, config);
 
    err = meshx_element_init(&g_dev, config);
    MESHX_ERR_PRINT_RET("Failed to initialize BLE Elements", err);
 
    err = meshx_init_prov(&g_dev, &g_prov_cfg);
    MESHX_ERR_PRINT_RET("Failed to initialize provisioning", err);
 
    err = meshx_plat_ble_mesh_init(&g_prov_cfg, g_dev.composition);
    MESHX_ERR_PRINT_RET("Failed to initialize BLE Mesh stack", err);
 
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_create_element_composition()

meshx_err_t meshx_create_element_composition ( dev_struct_t * p_dev, meshx_config_t const * config )

extern

Creates the BLE Mesh element composition.

Initializes the BLE Mesh elements for different configurations like relay servers, relay clients, and CWWW (Cool White and Warm White) servers.

Parameters

[in]	p_dev	Pointer to the device structure containing element information.
[in]	config	Pointer to the meshx configuration.

Returns

MESHX_SUCCESS on success, or an error code on failure.

Definition at line 182 of file composition.c.

{
#if CONFIG_MAX_ELEMENT_COUNT > 0
    meshx_err_t err;
#if CONFIG_SECTION_ENABLE_ELEMENT_TABLE
    element_comp_table_t *element_comp_table;
#endif /* CONFIG_SECTION_ENABLE_ELEMENT_TABLE */
    if(!p_dev || !config || !config->element_comp_arr_len || !config->element_comp_arr)
        return MESHX_INVALID_ARG;
 
    err = meshx_init_config_server();
    MESHX_ERR_PRINT_RET("Failed to initialize config server", err);
    for(uint16_t element_id = 0; element_id < config->element_comp_arr_len; element_id++)
    {
#if !CONFIG_SECTION_ENABLE_ELEMENT_TABLE
        if(config->element_comp_arr[element_id].element_cnt != 0
        && element_comp_fn[config->element_comp_arr[element_id].type] != NULL)
        {
            err = element_comp_fn[config->element_comp_arr[element_id].type](p_dev, config->element_comp_arr[element_id].element_cnt);
            if(err)
            {
                MESHX_LOGE(MODULE_ID_COMMON, "Element composition failed: (%d)", err);
                return err;
            }
        }
#else
        element_comp_table = &MESHX_ELEMENT_COMP_TABLE_START;
        while(element_comp_table < &MESHX_ELEMENT_COMP_TABLE_STOP)
        {
            if(element_comp_table->idx == element_id && config->element_comp_arr[element_id].element_cnt != 0)
            {
                err = element_comp_table->element_comp_fn(p_dev, config->element_comp_arr[element_id].element_cnt);
                if(err)
                {
                    MESHX_LOGE(MODULE_ID_COMMON, "Element composition failed: (%d)", err);
                    return err;
                }
            }
            element_comp_table++;
        }
#endif /* CONFIG_SECTION_ENABLE_ELEMENT_TABLE */
    }
#endif /* CONFIG_MAX_ELEMENT_COUNT */
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_dev_restore()

static meshx_err_t meshx_dev_restore ( dev_struct_t * pdev, meshx_config_t const * config )

static

Restore the device state from the NVS.

Parameters

[in]	pdev	Pointer to the device structure.
[in]	config	Pointer to the meshX configuration.

Returns

MESHX_SUCCESS on success, error code otherwise.

Definition at line 174 of file meshx.c.

{
    meshx_err_t err = MESHX_SUCCESS;
 
    err = meshx_nvs_open(config->cid, config->pid, config->meshx_nvs_save_period);
    MESHX_ERR_PRINT_RET("MeshX NVS Open failed", err);
 
    err = meshx_nvs_get(MESHX_NVS_STORE, &pdev->meshx_store, sizeof(meshx_app_store_t));
        MESHX_ERR_PRINT_RET("Failed to restore meshx device state", err);
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_element_init()

static meshx_err_t meshx_element_init ( dev_struct_t * p_dev, meshx_config_t const * config )

static

Initializes BLE Mesh elements.

Parameters

[in]	p_dev	Pointer to the device structure.
[in]	config	Pointer to the meshX configuration.

Returns

MESHX_SUCCESS on success, error code otherwise.

Initialise the root element

Note

We initialise the root element later as root element's models needs to be choosen based on the composition of the other elements

Definition at line 78 of file meshx.c.

{
    if (!p_dev)
        return MESHX_INVALID_STATE;
 
    meshx_err_t err = MESHX_SUCCESS;
    meshx_ptr_t meshx_sig_root_model_arr = NULL;
    meshx_ptr_t meshx_ven_root_model_arr = NULL;
 
    err = meshx_create_plat_composition(&p_dev->composition);
    if (err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to create platform composition: (%d)", err);
        return err;
    }
 
    /* Start with element index 1 as 0 is root element */
    p_dev->element_idx = 1;
 
    err = meshx_create_element_composition(p_dev, config);
    if(err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to create BLE Mesh Element Composition: (%d)", err);
        return err;
    }
    err = meshx_plat_composition_init(
        p_dev->composition,
        p_dev->elements,
        config->cid,
        config->pid,
        (uint16_t)p_dev->element_idx
    );
    if(err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to initialise MeshX Composition: (%d)", err);
        return err;
    }
 
    meshx_sig_root_model_arr = get_root_sig_models();
    if(meshx_sig_root_model_arr == NULL)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to get root SIG models");
        return MESHX_FAIL;
    }

    err = meshx_plat_add_element_to_composition(
        ROOT_ELEMENT_IDX,
        p_dev->elements,
        meshx_sig_root_model_arr,
        meshx_ven_root_model_arr,
        (uint8_t) get_root_sig_models_count(),
        (uint8_t) get_root_ven_models_count()
    );
    if(err)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to add element to composition: (%d)", err);
        return err;
    }
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_init()

meshx_err_t meshx_init

(

meshx_config_t const *

config

)

MeshX initialisation function.

This function initialises the MeshX stack with the given configuration.

Parameters

[in]

config

Pointer to the configuration structure

Returns

MESHX_SUCCESS, Success

Definition at line 231 of file meshx.c.

{
    /* Check if the configuration is valid */
    if(!config)
        return MESHX_INVALID_ARG;
 
    meshx_err_t err = MESHX_SUCCESS;
 
    /* Copy the configuration to the global config structure */
    memcpy(&g_config, config, sizeof(meshx_config_t));
 
    meshx_logging_t logging_cfg;
 
    logging_cfg.def_log_level = config->meshx_log_level == MESHX_LOG_VERBOSE ?
        CONFIG_MESHX_DEFAULT_LOG_LEVEL : config->meshx_log_level;
 
    err = meshx_logging_init(&logging_cfg);
    MESHX_ERR_PRINT_RET("Logging init failed", err);
 
    /* Initialise Platform deps */
    err = meshx_platform_init();
    MESHX_ERR_PRINT_RET("Platform init failed", err);
 
    /* Initialize OS timer */
    err = meshx_os_timer_init();
    MESHX_ERR_PRINT_RET("OS Timer Init failed", err);
 
    /* Initialize MeshX NVS */
    err = meshx_nvs_init();
    MESHX_ERR_PRINT_RET("MeshX NVS Init failed", err);
 
    /* Initialize application tasks */
    err = meshx_tasks_init(&g_dev);
    MESHX_ERR_PRINT_RET("Tasks initialization failed", err);
 
    /* Register application element callback */
    err = meshx_app_reg_element_callback(g_config.app_element_cb);
    MESHX_ERR_PRINT_RET("Failed to register app element callback", err);
 
    /* Register application control callback */
    err = meshx_app_reg_system_events_callback(g_config.app_ctrl_cb);
    MESHX_ERR_PRINT_RET("Failed to register app control callback", err);
 
    /* Initialize the Bluetooth Mesh Subsystem */
    err = meshx_ble_mesh_init(&g_config);
    MESHX_ERR_PRINT_RET("Bluetooth mesh init failed", err);
 
    /* Print the MeshX banner */
    CONFIG_MESHX_LOG_PRINTF(LOG_ANSI_COLOR_REGULAR(LOG_ANSI_COLOR_CYAN) "%s" LOG_ANSI_COLOR_RESET, meshX_banner);
 
#if CONFIG_ENABLE_UNIT_TEST
    /* Register unit test command */
    err = register_ut_command();
    MESHX_ERR_PRINT_RET("Failed to register unit test command", err);
 
    /* Initialize unit test console */
    err = init_unit_test_console();
    MESHX_ERR_PRINT_RET("Failed to initialize production console", err);
#endif /* CONFIG_ENABLE_UNIT_TEST */
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_tasks_init()

static meshx_err_t meshx_tasks_init ( dev_struct_t * pdev )

static

Initializes application tasks.

Parameters

[in]

pdev

Pointer to the device structure.

Returns

MESHX_SUCCESS on success, error code otherwise.

Definition at line 151 of file meshx.c.

{
    meshx_err_t err;
 
    err = create_control_task(pdev);
    MESHX_ERR_PRINT_RET("Failed to create control task", err);
 
#if CONFIG_TXCM_ENABLE
    err = meshx_txcm_init(pdev);
    MESHX_ERR_PRINT_RET("Failed to create Tx Control Module", err);
#endif /* CONFIG_TXCM_ENABLE */
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

g_config

meshx_config_t g_config

static

Definition at line 57 of file meshx.c.

g_dev

dev_struct_t g_dev

static

Definition at line 55 of file meshx.c.

g_prov_cfg

meshx_prov_params_t g_prov_cfg

Initial value:

= {
    .uuid = MESHX_UUID_EMPTY,  
    .node_name = NULL           
}

Definition at line 59 of file meshx.c.

                                 {
    .uuid = MESHX_UUID_EMPTY,  
    .node_name = NULL           
};

meshX_banner

const char meshX_banner[]

static

Initial value:

= {
"*********************************************************************************************************************\n"
"* MMMMMMMM               MMMMMMMM                                     hhhhhhh                 XXXXXXX       XXXXXXX *\n"
"* M:::::::M             M:::::::M                                     h:::::h                 X:::::X       X:::::X *\n"
"* M::::::::M           M::::::::M                                     h:::::h                 X:::::X       X:::::X *\n"
"* M:::::::::M         M:::::::::M                                     h:::::h                 X::::::X      X:::::X *\n"
"* M::::::::::M       M::::::::::M    eeeeeeeeeeee        ssssssssss   h:::: hhhhhh            XX:::::X     X:::::XX *\n"
"* M:::::::::::M     M:::::::::::M  ee::::::::::::ee    ss::::::::::s  h::::::::::hhh            X:::::X   X:::::X   *\n"
"* M:::::::M::::M   M::::M:::::::M e::::::eeeee:::::eess:::::::::::::s h::::::::::::::hh           X:::::X:::::X     *\n"
"* M::::::M M::::M M::::M M::::::Me::::::e     e:::::es::::::ssss:::::sh:::::::hhh::::::h           X:::::::::X      *\n"
"* M::::::M  M::::M::::M  M::::::Me:::::::eeeee::::::e s:::::s  ssssss h::::::h   h::::::h          X:::::::::X      *\n"
"* M::::::M   M:::::::M   M::::::Me:::::::::::::::::e    s::::::s      h:::::h     h:::::h         X:::::X:::::X     *\n"
"* M::::::M    M:::::M    M::::::Me::::::eeeeeeeeeee        s::::::s   h:::::h     h:::::h        X:::::X X:::::X    *\n"
"* M::::::M     MMMMM     M::::::Me:::::::e           ssssss   s:::::s h:::::h     h:::::h     XXX:::::X   X:::::XXX *\n"
"* M::::::M               M::::::Me::::::::e          s:::::ssss::::::sh:::::h     h:::::h     X::::::X     X::::::X *\n"
"* M::::::M               M::::::M e::::::::eeeeeeee  s::::::::::::::s h:::::h     h:::::h     X:::::X       X:::::X *\n"
"* M::::::M               M::::::M  ee:::::::::::::e   s:::::::::::ss  h:::::h     h:::::h     X:::::X       X:::::X *\n"
"* MMMMMMMM               MMMMMMMM    eeeeeeeeeeeeee    sssssssssss    hhhhhhh     hhhhhhh     XXXXXXX       XXXXXXX *\n"
"*********************************************************************************************************************\n"
}

A static constant character array that contains the banner information for the MeshX component. This banner is used for display purposes to indicate the presence of the MeshX component in the application.

Definition at line 34 of file meshx.c.

                                   {
"*********************************************************************************************************************\n"
"* MMMMMMMM               MMMMMMMM                                     hhhhhhh                 XXXXXXX       XXXXXXX *\n"
"* M:::::::M             M:::::::M                                     h:::::h                 X:::::X       X:::::X *\n"
"* M::::::::M           M::::::::M                                     h:::::h                 X:::::X       X:::::X *\n"
"* M:::::::::M         M:::::::::M                                     h:::::h                 X::::::X      X:::::X *\n"
"* M::::::::::M       M::::::::::M    eeeeeeeeeeee        ssssssssss   h:::: hhhhhh            XX:::::X     X:::::XX *\n"
"* M:::::::::::M     M:::::::::::M  ee::::::::::::ee    ss::::::::::s  h::::::::::hhh            X:::::X   X:::::X   *\n"
"* M:::::::M::::M   M::::M:::::::M e::::::eeeee:::::eess:::::::::::::s h::::::::::::::hh           X:::::X:::::X     *\n"
"* M::::::M M::::M M::::M M::::::Me::::::e     e:::::es::::::ssss:::::sh:::::::hhh::::::h           X:::::::::X      *\n"
"* M::::::M  M::::M::::M  M::::::Me:::::::eeeee::::::e s:::::s  ssssss h::::::h   h::::::h          X:::::::::X      *\n"
"* M::::::M   M:::::::M   M::::::Me:::::::::::::::::e    s::::::s      h:::::h     h:::::h         X:::::X:::::X     *\n"
"* M::::::M    M:::::M    M::::::Me::::::eeeeeeeeeee        s::::::s   h:::::h     h:::::h        X:::::X X:::::X    *\n"
"* M::::::M     MMMMM     M::::::Me:::::::e           ssssss   s:::::s h:::::h     h:::::h     XXX:::::X   X:::::XXX *\n"
"* M::::::M               M::::::Me::::::::e          s:::::ssss::::::sh:::::h     h:::::h     X::::::X     X::::::X *\n"
"* M::::::M               M::::::M e::::::::eeeeeeee  s::::::::::::::s h:::::h     h:::::h     X:::::X       X:::::X *\n"
"* M::::::M               M::::::M  ee:::::::::::::e   s:::::::::::ss  h:::::h     h:::::h     X:::::X       X:::::X *\n"
"* MMMMMMMM               MMMMMMMM    eeeeeeeeeeeeee    sssssssssss    hhhhhhh     hhhhhhh     XXXXXXX       XXXXXXX *\n"
"*********************************************************************************************************************\n"
};