esp_gen_cli_model.c File Reference

Implementation of the Generic OnOff Client model for BLE Mesh. This file contains the initialization, resource management, and message handling logic for the Generic OnOff Client model in the MeshX platform. More...

#include "meshx_control_task.h"
#include "interface/ble_mesh/client/meshx_ble_mesh_gen_cli.h"

Include dependency graph for esp_gen_cli_model.c:

Go to the source code of this file.

Macros
#define	MESHX_CLIENT_INIT_MAGIC_NO   0x8709

Functions
static void	esp_ble_mesh_generic_client_cb (MESHX_GEN_CLI_CB_EVT event, MESHX_GEN_CLI_CB_PARAM *param)
	Callback function for handling BLE Mesh Generic Client events.
meshx_err_t	meshx_plat_gen_cli_init (void)
	Initialize the meshxuction generic client.
meshx_err_t	meshx_plat_on_off_gen_cli_create (meshx_ptr_t p_model, meshx_ptr_t *p_pub, meshx_ptr_t *p_onoff_cli)
	Creates a Generic OnOff client model and its publication context.
meshx_err_t	meshx_plat_gen_cli_delete (meshx_ptr_t *p_pub, meshx_ptr_t *p_cli)
	Deletes the Generic OnOff Client model and its associated resources.
meshx_err_t	meshx_plat_gen_cli_send_msg (meshx_ptr_t p_model, meshx_gen_cli_set_t *p_set, uint16_t opcode, uint16_t addr, uint16_t net_idx, uint16_t app_idx, bool is_get_opcode)
	Sends a Generic Client message over BLE Mesh.

Variables
static uint16_t	meshx_client_init = 0
static const char *	client_state_str []
	Mapping of BLE Mesh client state events to string representations.

Detailed Description

Implementation of the Generic OnOff Client model for BLE Mesh. This file contains the initialization, resource management, and message handling logic for the Generic OnOff Client model in the MeshX platform.

Copyright (c) 2024 - 2025 MeshX

The Generic OnOff Client model is responsible for sending requests and receiving responses related to the on/off state of devices in a BLE Mesh network. It manages the client instance, publication context, and interacts with the MeshX BLE Mesh stack.

Author

Pranjal Chanda

Definition in file esp_gen_cli_model.c.

Macro Definition Documentation

MESHX_CLIENT_INIT_MAGIC_NO

#define MESHX_CLIENT_INIT_MAGIC_NO   0x8709

Definition at line 27 of file esp_gen_cli_model.c.

Function Documentation

esp_ble_mesh_generic_client_cb()

static void esp_ble_mesh_generic_client_cb ( MESHX_GEN_CLI_CB_EVT event, MESHX_GEN_CLI_CB_PARAM * param )

static

Callback function for handling BLE Mesh Generic Client events.

This function is invoked when a BLE Mesh Generic Client event occurs. It logs the event details, prepares a parameter structure for the MeshX layer, copies relevant status data, and publishes the event to the control task message queue.

Parameters

[in]	event	The type of Generic Client callback event (MESHX_GEN_CLI_CB_EVT).
[in]	param	Pointer to the callback parameter structure containing event-specific data (MESHX_GEN_CLI_CB_PARAM).

The function performs the following steps:

• Logs the event and associated error code, operation code, source, and destination addresses.
• Populates a meshx_gen_cli_cb_param_t structure with context and model information.
• Copies status callback data from the BLE layer to the MeshX layer.
• Publishes the event to the control task using control_task_msg_publish().
• Logs an error if publishing fails.

Definition at line 71 of file esp_gen_cli_model.c.

{
    MESHX_UNUSED(client_state_str);
    MESHX_LOGD(MODULE_ID_MODEL_CLIENT, "%s, err|op|src|dst: %d|%04" PRIx32 "|%04x|%04x",
               client_state_str[event], param->error_code,
               param->params->ctx.recv_op, param->params->ctx.addr, param->params->ctx.recv_dst);
 
    meshx_gen_cli_cb_param_t pub_param = {
        .ctx = {
            .net_idx    = param->params->ctx.net_idx,
            .app_idx    = param->params->ctx.app_idx,
            .dst_addr   = param->params->ctx.recv_dst,
            .src_addr   = param->params->ctx.addr,
            .opcode     = param->params->ctx.recv_op,
            .p_ctx      = &param->params->ctx
        },
        .model = {
            .pub_addr   = param->params->model->pub->publish_addr,
            .model_id   = param->params->model->model_id,
            .el_id      = param->params->model->element_idx,
            .p_model    = param->params->model
        },
        .evt = MESHX_BIT(event),
        .err_code = param->error_code,
    };
 
    /* Copy the msg data from BLE Layer to MeshX Layer */
    memcpy(&pub_param.status, &param->status_cb, sizeof(meshx_gen_client_status_cb_t));
 
    meshx_err_t err = control_task_msg_publish(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        pub_param.model.model_id,
        &pub_param,
        sizeof(meshx_gen_cli_cb_param_t));
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Failed to publish to control task");
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_gen_cli_delete()

meshx_err_t meshx_plat_gen_cli_delete	(	meshx_ptr_t *	p_pub,
		meshx_ptr_t *	p_cli )

Deletes the Generic OnOff Client model and its associated resources.

This function frees the memory allocated for the Generic OnOff Client and sets the pointer to NULL. It also deletes the model publication resources associated with the client.

Parameters

[in,out]	p_pub	Pointer to the publication structure to be deleted.
[in,out]	p_cli	Pointer to the OnOff Client structure to be freed.

Returns

• MESHX_SUCCESS: Model and publication deleted successfully.
• MESHX_FAIL: Failed to delete the model or publication.

Definition at line 187 of file esp_gen_cli_model.c.

{
    if (p_cli)
    {
        MESHX_FREE(*p_cli);
        *p_cli = NULL;
    }
 
    return meshx_plat_del_model_pub(p_pub);
}

Here is the call graph for this function:

meshx_plat_gen_cli_init()

meshx_err_t meshx_plat_gen_cli_init

(

void

)

Initialize the meshxuction generic client.

This function sets up the necessary configurations and initializes the meshxuction generic client for the BLE mesh node.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Failed to initialize the client

Definition at line 125 of file esp_gen_cli_model.c.

{
 
    meshx_err_t err = MESHX_SUCCESS;
    if (meshx_client_init == MESHX_CLIENT_INIT_MAGIC_NO)
    {
        return MESHX_SUCCESS; // Already initialized
    }
    meshx_client_init = MESHX_CLIENT_INIT_MAGIC_NO;
 
    // Register the callback for handling messages sent to the BLE layer
    esp_err_t esp_err = esp_ble_mesh_register_generic_client_callback(
        (MESHX_GEN_CLI_CB)&esp_ble_mesh_generic_client_cb);
    if (esp_err != ESP_OK)
        err = MESHX_ERR_PLAT;
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_plat_gen_cli_send_msg()

meshx_err_t meshx_plat_gen_cli_send_msg	(	meshx_ptr_t	p_model,
		meshx_gen_cli_set_t *	p_set,
		uint16_t	opcode,
		uint16_t	addr,
		uint16_t	net_idx,
		uint16_t	app_idx,
		bool	is_get_opcode )

Sends a Generic Client message over BLE Mesh.

This function sends a message from a Generic Client model to a specified address within the BLE Mesh network, using the provided opcode and parameters.

Parameters

[in]	p_model	Pointer to the Generic Client model instance.
[in]	p_set	Pointer to the structure containing the message parameters to set.
[in]	opcode	Operation code specifying the type of message to send.
[in]	addr	Destination address within the BLE Mesh network.
[in]	net_idx	Network index identifying the subnet to use.
[in]	app_idx	Application key index to encrypt the message.
[in]	is_get_opcode	Flag indicating if the opcode is a GET request.

Returns

meshx_err_t Result of the operation. Returns MESHX_OK on success or an error code on failure.

Definition at line 214 of file esp_gen_cli_model.c.

{
    if (!p_model || !p_set)
    {
        return MESHX_INVALID_ARG; // Invalid arguments
    }
 
    esp_ble_mesh_client_common_param_t common = {0};
    common.model        = p_model;
    common.opcode       = opcode;
    common.ctx.addr     = addr;
    common.ctx.net_idx  = net_idx;
    common.ctx.app_idx  = app_idx;
    common.ctx.send_ttl = BLE_MESH_TTL_DEFAULT;
    common.msg_timeout  = 0; /* 0 indicates that timeout value from menuconfig will be used */
 
    esp_err_t err = ESP_OK;
    if(!is_get_opcode)
    {
        p_set->onoff_set.trans_time = 0;
        if(!(p_set->onoff_set.onoff == 0 || p_set->onoff_set.onoff == 1))
        {
            MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid OnOff value %d", p_set->onoff_set.onoff);
            return MESHX_INVALID_ARG;
        }
        err = esp_ble_mesh_generic_client_set_state(
            &common,
            (esp_ble_mesh_generic_client_set_state_t *)p_set
        );
        if (err != ESP_OK)
        {
            MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Send Generic OnOff failed: %d", err);
            return MESHX_FAIL;
        }
    }
    else
    {
        err = esp_ble_mesh_generic_client_get_state(
            &common,
            (esp_ble_mesh_generic_client_get_state_t *)p_set
        );
        if (err != ESP_OK)
        {
            MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Send Generic OnOff Get failed: %d", err);
            return MESHX_FAIL;
        }
    }
    if (!err)
    {
        MESHX_LOGD(MODULE_ID_MODEL_CLIENT, "Client Send Success");
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_plat_on_off_gen_cli_create()

meshx_err_t meshx_plat_on_off_gen_cli_create	(	meshx_ptr_t	p_model,
		meshx_ptr_t *	p_pub,
		meshx_ptr_t *	p_onoff_cli )

Creates a Generic OnOff client model and its publication context.

This function initializes the Generic OnOff client model, its publication context, and allocates memory for the client instance. It checks for invalid arguments and handles memory allocation failures.

Parameters

[out]	p_model	Pointer to the model structure to be created.
[out]	p_pub	Pointer to the publication context to be created.
[out]	p_onoff_cli	Pointer to the OnOff client instance to be allocated.

Returns

• MESHX_SUCCESS: Successfully created the model and publication context.
• MESHX_INVALID_ARG: One or more arguments are invalid.
• MESHX_NO_MEM: Memory allocation failed.

Definition at line 160 of file esp_gen_cli_model.c.

{
    if (!p_model || !p_pub || !p_onoff_cli)
    {
        return MESHX_INVALID_ARG; // Invalid arguments
    }
    /* SIG On OFF Init */
    uint16_t model_id = ESP_BLE_MESH_MODEL_ID_GEN_ONOFF_CLI;
    memcpy((meshx_ptr_t)&(((MESHX_MODEL *)p_model)->model_id), &model_id, sizeof(model_id));
 
    return meshx_plat_client_create(p_model, p_pub, p_onoff_cli);
}

Here is the call graph for this function:

Variable Documentation

client_state_str

const char* client_state_str[]

static

Initial value:

=
{
    [ESP_BLE_MESH_GENERIC_CLIENT_PUBLISH_EVT] = "PUBLISH_EVT",
    [ESP_BLE_MESH_GENERIC_CLIENT_TIMEOUT_EVT] = "TIMEOUT_EVT",
    [ESP_BLE_MESH_GENERIC_CLIENT_GET_STATE_EVT] = "GET_STATE_EVT",
    [ESP_BLE_MESH_GENERIC_CLIENT_SET_STATE_EVT] = "SET_STATE_EVT",
}

Mapping of BLE Mesh client state events to string representations.

Definition at line 37 of file esp_gen_cli_model.c.

{
    [ESP_BLE_MESH_GENERIC_CLIENT_PUBLISH_EVT] = "PUBLISH_EVT",
    [ESP_BLE_MESH_GENERIC_CLIENT_TIMEOUT_EVT] = "TIMEOUT_EVT",
    [ESP_BLE_MESH_GENERIC_CLIENT_GET_STATE_EVT] = "GET_STATE_EVT",
    [ESP_BLE_MESH_GENERIC_CLIENT_SET_STATE_EVT] = "SET_STATE_EVT",
};

meshx_client_init

uint16_t meshx_client_init = 0

static

Definition at line 32 of file esp_gen_cli_model.c.