meshx_gen_client.h File Reference

Implementation of the MeshX generic client model for BLE mesh nodes. This file contains functions for registering, deregistering, and initializing the generic client model. More...

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

Include dependency graph for meshx_gen_client.h:

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

Go to the source code of this file.

Data Structures
struct	meshx_gen_client_send_params
	Generic Client Model send parameters. This structure is used to pass parameters to the Generic Client Model for sending messages. It includes the element ID, model pointer, state parameters, opcode, destination address, network index, and application index. More...

Typedefs
typedef struct meshx_gen_client_send_params	meshx_gen_client_send_params_t
	Generic Client Model send parameters. This structure is used to pass parameters to the Generic Client Model for sending messages. It includes the element ID, model pointer, state parameters, opcode, destination address, network index, and application index.

Functions
meshx_err_t	meshx_gen_client_from_ble_reg_cb (uint32_t model_id, meshx_gen_client_cb_t cb)
	Registers a callback function for a specific generic server model.
meshx_err_t	meshx_gen_client_init (void)
	Initialize the meshxuction generic client.
meshx_err_t	meshx_gen_cli_send_msg (meshx_gen_client_send_params_t *params)
	Sends a Generic Client message over BLE Mesh.

Detailed Description

Implementation of the MeshX generic client model for BLE mesh nodes. This file contains functions for registering, deregistering, and initializing the generic client model.

Copyright (c) 2024 - 2025 MeshX

The MeshX generic client model provides an interface for handling BLE mesh client operations, including callback registration and initialization.

Author

Pranjal Chanda

Definition in file meshx_gen_client.h.

Typedef Documentation

meshx_gen_client_send_params_t

typedef struct meshx_gen_client_send_params meshx_gen_client_send_params_t

Generic Client Model send parameters. This structure is used to pass parameters to the Generic Client Model for sending messages. It includes the element ID, model pointer, state parameters, opcode, destination address, network index, and application index.

Function Documentation

meshx_gen_cli_send_msg()

meshx_err_t meshx_gen_cli_send_msg

(

meshx_gen_client_send_params_t *

params

)

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]

params

Pointer to the structure containing the message parameters to set.

Returns

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

Definition at line 426 of file meshx_gen_client.c.

{
    if (!params || !params->model || !params->state)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_err_t err = MESHX_SUCCESS;
    bool is_unack = meshx_is_unack_opcode(params->opcode) == MESHX_SUCCESS;
    /* Broadcast / Multicast will not be sending an ACK. Hence, it is not required to queue */
    meshx_txcm_sig_t req_type = (is_unack || (MESHX_ADDR_IS_UNICAST(params->addr) == false)) ?
                                MESHX_TXCM_SIG_DIRECT_SEND : MESHX_TXCM_SIG_ENQ_SEND;
 
    meshx_gen_client_msg_ctx_t send_msg =
    {
        .addr    = params->addr,
        .model   = params->model,
        .opcode  = params->opcode,
        .app_idx = params->app_idx,
        .net_idx = params->net_idx,
    };
    memcpy(&send_msg.state, params->state, sizeof(send_msg.state));
 
    err = meshx_txcm_request_send(
        req_type,
        send_msg.addr,
        &send_msg,
        sizeof(send_msg),
        (meshx_txcm_fn_model_send_t) &meshx_gen_client_txcm_fn_model_send
    );
    if(err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Failed to send message: %p", (meshx_ptr_t) err);
    }
    return err;
}

Here is the call graph for this function:

meshx_gen_client_from_ble_reg_cb()

meshx_err_t meshx_gen_client_from_ble_reg_cb	(	uint32_t	model_id,
		meshx_gen_client_cb_t	cb )

Registers a callback function for a specific generic server model.

This function associates a callback with the given model ID, allowing the server to handle events or messages related to that model.

Parameters

[in]	model_id	The unique identifier of the generic server model.
[in]	cb	The callback function to be registered for the model.

Returns

meshx_err_t Returns an error code indicating the result of the registration. Possible values include success or specific error codes.

Definition at line 475 of file meshx_gen_client.c.

{
    if (!cb || meshx_is_gen_cli_model(model_id) != MESHX_SUCCESS)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_err_t err = MESHX_SUCCESS;
    meshx_gen_cli_cb_reg_t reg = { .model_id = (uint16_t)model_id, .cb = cb };
 
    err = meshx_gen_cli_cb_reg_add(reg);
    if (err != MESHX_SUCCESS)
    {
        return err;
    }
 
    return control_task_msg_subscribe(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        model_id,
        (control_task_msg_handle_t) &meshx_handle_gen_onoff_msg
    );
}

Here is the call graph for this function:

meshx_gen_client_init()

meshx_err_t meshx_gen_client_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

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 404 of file meshx_gen_client.c.

{
    if (g_meshx_client_control.client_init == MESHX_CLIENT_INIT_MAGIC_NO)
        return MESHX_SUCCESS;
    g_meshx_client_control.client_init = MESHX_CLIENT_INIT_MAGIC_NO;
 
    meshx_err_t err = meshx_txcm_event_cb_reg((meshx_txcm_cb_t) &meshx_handle_txcm_msg);
    if(err != MESHX_SUCCESS)
        return err;
    return meshx_plat_gen_cli_init();
}

Here is the call graph for this function: