meshx.h File Reference

This file contains the headers for meshx.c. More...

#include <meshx_common.h>
#include <meshx_nvs.h>
#include <meshx_api.h>
#include <meshx_err.h>
#include <meshx_os_timer.h>
#include <meshx_prov_srv.h>
#include <meshx_config_server.h>
#include "meshx_serial.h"
#include <meshx_txcm.h>
#include <interface/meshx_platform.h>
#include <meshx_builder_api.h>
#include <unit_test.h>

Go to the source code of this file.

Data Structures
struct	element_comp
	Structure for element composition. More...
struct	meshx_config
	Structure for MeshX configuration. More...

Macros
#define	MESHX_ERR_PRINT_RET(_e_str, _err)
	Print and return error message if an error occurs.
#define	CID_ESP   CONFIG_CID_ID

Typedefs
typedef struct element_comp	element_comp_t
typedef struct meshx_config	meshx_config_t

Functions
meshx_err_t	meshx_init (meshx_config_t const *config)
	MeshX initialisation function.

Detailed Description

This file contains the headers for meshx.c.

Copyright © 2024 - 2025 MeshX

Author

Pranjal Chanda

Macro Definition Documentation

CID_ESP

#define CID_ESP   CONFIG_CID_ID

MESHX_ERR_PRINT_RET

#define MESHX_ERR_PRINT_RET	(		_e_str,
			_err )

Value:

if (_err != MESHX_SUCCESS)                                    \
{                                                             \
    MESHX_LOGE(MODULE_ID_COMMON, _e_str " (err 0x%x)", _err); \
    return _err;                                              \
}

Print and return error message if an error occurs.

This macro prints an error message and returns the error code if an error occurs.

Parameters

_e_str	Error string to print
_err	Error code to return

Returns

Error code

#define MESHX_ERR_PRINT_RET(_e_str, _err)                         \
    if (_err != MESHX_SUCCESS)                                    \
    {                                                             \
        MESHX_LOGE(MODULE_ID_COMMON, _e_str " (err 0x%x)", _err); \
        return _err;                                              \
    }

Typedef Documentation

element_comp_t

typedef struct element_comp element_comp_t

meshx_config_t

typedef struct meshx_config meshx_config_t

Function Documentation

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

{
    /* 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));
 
    /* Initialise Platform deps */
    err = meshx_platform_init();
    MESHX_ERR_PRINT_RET("Platform init failed", err);
 
    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);
 
    MESHX_LOGI(MODULE_ID_COMMON, "MeshX Logging Initialized successfully");
 
    /* Load Persistent Configuration and apply UUID/Product Info */
    err = meshx_load_persistent_config(config);
    MESHX_ERR_PRINT_RET("Failed to load persistent configuration", err);
 
    /* Initialise Control Task messaging early (required for NVS and OS Timers) */
    err = control_task_init();
    MESHX_ERR_PRINT_RET("Control Task 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);
 
    /* Restore the device state and open NVS (Required before element constructors run) */
    err = meshx_dev_restore(&g_dev, &g_config);
    MESHX_ERR_PRINT_RET("Device restore 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);
 
    /* Initialize Hosted Serial Protocol */
    err = meshx_serial_init();
    MESHX_ERR_PRINT_RET("Serial init failed", err);
 
#if CONFIG_ENABLE_UNIT_TEST
    /* Initialize unit test console (this also registers the 'ut' command) */
    err = init_unit_test_console();
    MESHX_ERR_PRINT_RET("Failed to initialize unit test console", err);
#endif /* CONFIG_ENABLE_UNIT_TEST */
 
    return err;
}