meshx_ble_mesh_config_srv.h File Reference

Header file for MeshX BLE Mesh Configuration Server. More...

#include "../meshx_ble_mesh_cmn.h"
#include "meshx_control_task.h"

Include dependency graph for meshx_ble_mesh_config_srv.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_state_change_cfg_mod_pub_set_t
	Configuration Server model related context. More...
struct	meshx_state_change_cfg_mod_pub_va_set_t
struct	meshx_state_change_cfg_model_sub_add_t
struct	meshx_state_change_cfg_model_sub_delete_t
struct	meshx_state_change_cfg_netkey_add_t
struct	meshx_state_change_cfg_netkey_update_t
struct	meshx_state_change_cfg_netkey_delete_t
struct	meshx_state_change_cfg_appkey_add_t
struct	meshx_state_change_cfg_appkey_update_t
struct	meshx_state_change_cfg_appkey_delete_t
struct	meshx_state_change_cfg_model_app_bind_t
struct	meshx_state_change_cfg_model_app_unbind_t
struct	meshx_state_change_cfg_kr_phase_set_t
union	meshx_cfg_srv_state_change_t
	Configuration Server model state change value union. More...
struct	meshx_config_srv_cb_param

Typedefs
typedef control_task_msg_handle_t	config_srv_cb_t
typedef control_task_msg_evt_config_t	config_evt_t
typedef struct meshx_config_srv_cb_param	meshx_config_srv_cb_param_t

Functions
meshx_err_t	meshx_plat_config_srv_init (void)
	Initializes the MeshX platform configuration server.
meshx_err_t	meshx_plat_get_config_srv_instance (meshx_ptr_t *p_conf_srv)
	Retrieve the instance of the BLE Mesh configuration server.
meshx_err_t	meshx_plat_get_config_srv_model (meshx_ptr_t p_model)
	Retrieves the configuration server model for the BLE Mesh.

Detailed Description

Header file for MeshX BLE Mesh Configuration Server.

Copyright (c) 2024 - 2025 MeshX

This file contains the definitions, data structures, and function declarations for the MeshX BLE Mesh Configuration Server. It provides the necessary APIs and context for managing the configuration server model in a BLE Mesh network.

Author

Pranjal Chanda

Definition in file meshx_ble_mesh_config_srv.h.

Typedef Documentation

config_evt_t

typedef control_task_msg_evt_config_t config_evt_t

Definition at line 21 of file meshx_ble_mesh_config_srv.h.

config_srv_cb_t

typedef control_task_msg_handle_t config_srv_cb_t

Definition at line 20 of file meshx_ble_mesh_config_srv.h.

meshx_config_srv_cb_param_t

typedef struct meshx_config_srv_cb_param meshx_config_srv_cb_param_t

Function Documentation

meshx_plat_config_srv_init()

meshx_err_t meshx_plat_config_srv_init

(

void

)

Initializes the MeshX platform configuration server.

This function sets up the necessary resources and configurations for the MeshX BLE Mesh configuration server. It should be called during the initialization phase of the application to ensure proper operation of the MeshX BLE Mesh stack.

Returns

• MESHX_SUCCESS on successful initialization.
• Appropriate error code from meshx_err_t on failure.

Definition at line 95 of file esp_cfg_srv_model.c.

{
    esp_err_t err = esp_ble_mesh_register_config_server_callback(
        (esp_ble_mesh_cfg_server_cb_t)&meshx_ble_mesh_config_server_cb);
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Error plat registering config server (Err: 0x%x)", err);
        return MESHX_ERR_PLAT;
    }
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_get_config_srv_instance()

meshx_err_t meshx_plat_get_config_srv_instance

(

meshx_ptr_t *

p_conf_srv

)

Retrieve the instance of the BLE Mesh configuration server.

This function provides access to the BLE Mesh configuration server instance.

Parameters

[out]

p_conf_srv

Pointer to a variable where the configuration server instance will be stored. The caller must ensure that the pointer is valid and non-NULL.

Returns

• MESHX_SUCCESS on success.
• Appropriate error code from meshx_err_t on failure.

Definition at line 107 of file esp_cfg_srv_model.c.

{
    if (p_conf_srv == NULL)
    {
        return MESHX_INVALID_ARG;
    }
    /* Return the pointer to the configuration server instance */
    *p_conf_srv = &meshx_config_server_instance;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_plat_get_config_srv_model()

meshx_err_t meshx_plat_get_config_srv_model

(

meshx_ptr_t

p_model

)

Retrieves the configuration server model for the BLE Mesh.

This function provides access to the configuration server model used in the BLE Mesh 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.
• Appropriate error code from meshx_err_t on failure.

Definition at line 119 of file esp_cfg_srv_model.c.

{
    if (p_model == NULL)
    {
        return MESHX_INVALID_ARG;
    }
    /* Return the pointer to the configuration server model */
    memcpy(p_model, &meshx_config_server_model, sizeof(meshx_config_server_model));
    return MESHX_SUCCESS;
}

Here is the caller graph for this function: