esp_cfg_srv_model.c File Reference

Implementation of the BLE Mesh Configuration Server for the MeshX platform. This file contains the initialization, callback handling, and utility functions for managing the BLE Mesh Configuration Server model. More...

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

Include dependency graph for esp_cfg_srv_model.c:

Go to the source code of this file.

Functions
static void	meshx_ble_mesh_config_server_cb (esp_ble_mesh_cfg_server_cb_event_t event, const esp_ble_mesh_cfg_server_cb_param_t *param)
	BLE Mesh Configuration Server callback function.
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.

Variables
static MESHX_CFG_SRV	meshx_config_server_instance
static MESHX_MODEL	meshx_config_server_model

Detailed Description

Implementation of the BLE Mesh Configuration Server for the MeshX platform. This file contains the initialization, callback handling, and utility functions for managing the BLE Mesh Configuration Server model.

Copyright (c) 2024 - 2025 MeshX

The Configuration Server is responsible for handling configuration messages such as adding keys, setting publication parameters, and managing subscriptions. It provides an interface for the application to interact with the BLE Mesh stack.

Author

Pranjal Chanda

Definition in file esp_cfg_srv_model.c.

Function Documentation

meshx_ble_mesh_config_server_cb()

static void meshx_ble_mesh_config_server_cb ( esp_ble_mesh_cfg_server_cb_event_t event, const esp_ble_mesh_cfg_server_cb_param_t * param )

static

BLE Mesh Configuration Server callback function.

Handles state change events and dispatches them to the appropriate callbacks registered with the configuration server.

Parameters

[in]	event	Configuration server event type.
[in]	param	Pointer to the BLE Mesh Configuration Server callback parameters.

Definition at line 54 of file esp_cfg_srv_model.c.

{
    if (event != ESP_BLE_MESH_CFG_SERVER_STATE_CHANGE_EVT)
        return;
 
    meshx_config_srv_cb_param_t pub_param =
        {
            .ctx =
                {
                    .net_idx = param->ctx.net_idx,
                    .app_idx = param->ctx.app_idx,
                    .dst_addr = param->ctx.recv_dst,
                    .src_addr = param->ctx.addr,
                    .opcode = param->ctx.recv_op,
                    .p_ctx = (meshx_ptr_t) &param->ctx
                },
            .model =
                {
                    .model_id = param->model->model_id,
                    .el_id = param->model->element_idx,
                    .p_model = param->model
                }
        };
    MESHX_LOGD(MODULE_ID_MODEL_SERVER, "ele: %d", pub_param.model.el_id);
    /* Copy all the status msg from the BLE layer */
    memcpy(&pub_param.state_change,
           &param->value.state_change,
           sizeof(meshx_cfg_srv_state_change_t));
 
    meshx_err_t err = control_task_msg_publish(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        MESHX_MODEL_ID_CONFIG_SRV,
        &pub_param,
        sizeof(pub_param));
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Error publishing control task msg (Err: 0x%x)", err);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

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:

Variable Documentation

meshx_config_server_instance

MESHX_CFG_SRV meshx_config_server_instance

static

Initial value:

= {
    
    .net_transmit = ESP_BLE_MESH_TRANSMIT(2, 20),
    .relay = ESP_BLE_MESH_RELAY_ENABLED,
    .relay_retransmit = ESP_BLE_MESH_TRANSMIT(2, 20),
    .beacon = ESP_BLE_MESH_BEACON_ENABLED,
 
 
 
    .gatt_proxy = ESP_BLE_MESH_GATT_PROXY_NOT_SUPPORTED,
 
 
 
 
    .friend_state = ESP_BLE_MESH_FRIEND_NOT_SUPPORTED,
 
    .default_ttl = 7,
}

Definition at line 19 of file esp_cfg_srv_model.c.

                                                    {
    /* 3 transmissions with 20ms interval */
    .net_transmit = ESP_BLE_MESH_TRANSMIT(2, 20),
    .relay = ESP_BLE_MESH_RELAY_ENABLED,
    .relay_retransmit = ESP_BLE_MESH_TRANSMIT(2, 20),
    .beacon = ESP_BLE_MESH_BEACON_ENABLED,
#if defined(CONFIG_BLE_MESH_GATT_PROXY_SERVER)
    .gatt_proxy = ESP_BLE_MESH_GATT_PROXY_ENABLED,
#else
    .gatt_proxy = ESP_BLE_MESH_GATT_PROXY_NOT_SUPPORTED,
#endif
#if defined(CONFIG_BLE_MESH_FRIEND)
    .friend_state = ESP_BLE_MESH_FRIEND_ENABLED,
#else
    .friend_state = ESP_BLE_MESH_FRIEND_NOT_SUPPORTED,
#endif
    .default_ttl = 7,
};

meshx_config_server_model

MESHX_MODEL meshx_config_server_model

static

Initial value:

= {
    .model_id = MESHX_MODEL_ID_CONFIG_SRV,
    .user_data = &meshx_config_server_instance,
    .keys = ESP_BLE_MESH_MODEL_KEYS_UNUSED,
    .groups = ESP_BLE_MESH_MODEL_GROUPS_UNASSIGNED,
}

Definition at line 38 of file esp_cfg_srv_model.c.

                                               {
    .model_id = MESHX_MODEL_ID_CONFIG_SRV,
    .user_data = &meshx_config_server_instance,
    .keys = ESP_BLE_MESH_MODEL_KEYS_UNUSED,
    .groups = ESP_BLE_MESH_MODEL_GROUPS_UNASSIGNED,
};