meshx_config_server.h File Reference

Header file for the meshxuction configuration server model. More...

#include "interface/meshx_platform.h"
#include "interface/ble_mesh/server/meshx_ble_mesh_config_srv.h"
#include "meshx_err.h"

Include dependency graph for meshx_config_server.h:

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

Go to the source code of this file.

Functions
meshx_err_t	meshx_get_config_srv_model (void *p_model)
	Retrieves the configuration server model for the MeshX framework.
meshx_err_t	meshx_init_config_server (void)
	Initialize the meshxuction configuration server.
meshx_err_t	meshx_config_server_cb_reg (config_srv_cb_t cb, uint32_t config_evt_bmap)
	Registers a configuration server callback for specific events.
meshx_err_t	meshx_get_config_srv_instance (void **p_conf_srv)
	Retrieves the instance of the MeshX configuration server.

Detailed Description

Header file for the meshxuction configuration server model.

Copyright © 2024 - 2025 MeshX

This file contains the definitions and function declarations for the meshxuction configuration server model used in the ESP32 BLE Mesh Node.

Author

Pranjal Chanda

Definition in file meshx_config_server.h.

Function Documentation

meshx_config_server_cb_reg()

meshx_err_t meshx_config_server_cb_reg	(	config_srv_cb_t	cb,
		uint32_t	config_evt_bmap )

Registers a configuration server callback for specific events.

Adds a new callback registration to the linked list for dispatching events.

Parameters

[in]	cb	Callback function to register.
[in]	config_evt_bmap	Bitmap of events the callback is interested in.

Returns

MESHX_SUCCESS on success, an error code otherwise.

Definition at line 122 of file meshx_config_server.c.

{
    if (cb == NULL || config_evt_bmap == 0)
    {
        return MESHX_INVALID_ARG; // Invalid arguments
    }
 
    return control_task_msg_subscribe(
        CONTROL_TASK_MSG_CODE_CONFIG,
        config_evt_bmap,
        (control_task_msg_handle_t)cb);
 
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_get_config_srv_instance()

meshx_err_t meshx_get_config_srv_instance

(

void **

p_conf_srv

)

Retrieves the instance of the MeshX configuration server.

This function provides access to the configuration server instance used in the MeshX framework. The configuration server is responsible for managing and storing configuration settings for the mesh network.

Parameters

[out]

p_conf_srv

Pointer to a variable where the configuration server instance will be stored. The pointer must be of type void**.

Returns

• MESHX_SUCCESS on successful retrieval of the configuration server instance.
• An appropriate error code of type meshx_err_t on failure.

Definition at line 151 of file meshx_config_server.c.

{
    return meshx_plat_get_config_srv_instance(p_conf_srv);
}

Here is the call graph for this function:

meshx_get_config_srv_model()

meshx_err_t meshx_get_config_srv_model

(

meshx_ptr_t

p_model

)

Retrieves the configuration server model for the MeshX framework.

This function provides access to the configuration server model used in the MeshX implementation. The retrieved model can be used for configuring and managing the mesh network.

Parameters

[out]

p_model

Pointer to a variable where the address of the configuration server model will be stored. The caller must ensure that the pointer is valid.

Returns

• MESHX_SUCCESS on success.
• An appropriate error code of type meshx_err_t on failure.

Definition at line 171 of file meshx_config_server.c.

{
    return meshx_plat_get_config_srv_model(p_model);
}

Here is the call graph for this function:

meshx_init_config_server()

meshx_err_t meshx_init_config_server

(

void

)

Initialize the meshxuction configuration server.

Returns

MESHX_SUCCESS on success, or an error code on failure.

Initialize the meshxuction configuration server.

Registers the BLE Mesh Configuration Server callback function and prepares the server for use.

Returns

MESHX_SUCCESS on success, an error code otherwise.

Definition at line 97 of file meshx_config_server.c.

{
    if(config_srv_init_flag == CONFIG_SRV_INIT_MAGIC)
        return MESHX_INVALID_ARG;
 
    config_srv_init_flag = CONFIG_SRV_INIT_MAGIC;
 
    control_task_msg_subscribe(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        MESHX_MODEL_ID_CONFIG_SRV,
        (control_task_msg_handle_t)meshx_config_server_control_task_handler);
 
    return meshx_plat_config_srv_init();
}

Here is the call graph for this function:

Here is the caller graph for this function: