meshx_gen_light_cli.c File Reference

#include "stdlib.h"
#include "meshx_txcm.h"
#include "meshx_gen_light_cli.h"

Include dependency graph for meshx_gen_light_cli.c:

Go to the source code of this file.

Data Structures
struct	meshx_gen_light_cli_cb_reg
	Structure containing the model ID and callback function for generic client model registrations. More...
struct	meshx_gen_light_cli_resend_ctx
	Structure containing the model ID and parameter for generic client model message re-sending. More...
struct	meshx_gen_light_client_msg_ctx
	Structure containing the message context for generic client model messages. More...
struct	meshx_gen_light_cli_cb_reg_node
	Structure containing a node in the linked list of registered callbacks. More...

Macros
#define	MESHX_CLIENT_INIT_MAGIC_NO   0x4309

Typedefs
typedef struct meshx_gen_light_cli_cb_reg	meshx_gen_light_cli_cb_reg_t
typedef struct meshx_gen_light_cli_resend_ctx	meshx_gen_light_cli_resend_ctx
typedef struct meshx_gen_light_client_msg_ctx	meshx_gen_light_client_msg_ctx_t
typedef struct meshx_gen_light_cli_cb_reg_node	meshx_gen_light_cli_cb_reg_node_t

Functions
static meshx_err_t	meshx_gen_light_cli_cb_reg_add (meshx_gen_light_cli_cb_reg_t reg)
	Adds a new callback registration to the linked list of registered callbacks.
static meshx_err_t	meshx_is_gen_light_cli_get_opcode (uint32_t opcode)
	Checks if the given model ID corresponds to a Generic Light Client GET opcode.
static meshx_err_t	meshx_is_gen_light_cli_model (uint32_t model_id)
	Checks if the given model ID corresponds to a Generic Light Client model.
static meshx_err_t	meshx_is_unack_opcode (uint32_t opcode)
	Checks if the given opcode corresponds to an unacknowledged (unack) message in the Generic Light Client model.
static meshx_err_t	meshx_gen_client_txcm_fn_model_send (meshx_gen_light_client_msg_ctx_t *params, size_t msg_param_len)
	Send a message using the generic client model.
static meshx_err_t	meshx_handle_txcm_msg (dev_struct_t *pdev, control_task_msg_evt_t evt, meshx_gen_light_cli_resend_ctx *param)
	Handles TXCM message for generic light client.
static meshx_err_t	meshx_gen_light_cli_handle_ack (uint16_t src_addr)
	Handles ack request for generic light client messages.
static meshx_err_t	meshx_gen_light_cli_handle_resend (uint16_t model_id, const meshx_gen_light_cli_cb_param_t *param)
	Handles resend request for generic light client messages.
static meshx_err_t	meshx_handle_gen_light_msg (dev_struct_t *pdev, control_task_msg_evt_t model_id, meshx_gen_light_cli_cb_param_t *param)
	Handle the Generic Light Client messages.
meshx_err_t	meshx_gen_light_cli_init (void)
	Initialize the meshxuction generic client.
meshx_err_t	meshx_gen_light_send_msg (const meshx_gen_light_client_send_params_t *params)
	Send a message using the generic client model.
meshx_err_t	meshx_gen_light_client_from_ble_reg_cb (uint16_t model_id, meshx_gen_light_client_cb_t cb)
	Registers a callback function for getting Generic Light Client messages from BLE.

Variables
struct {
uint16_t   meshx_client_init
meshx_gen_light_cli_cb_reg_node_t *   cli_cb_reg_head
}	g_meshx_gen_light_client_ctrl

Macro Definition Documentation

MESHX_CLIENT_INIT_MAGIC_NO

#define MESHX_CLIENT_INIT_MAGIC_NO   0x4309

Definition at line 19 of file meshx_gen_light_cli.c.

Typedef Documentation

meshx_gen_light_cli_cb_reg_node_t

typedef struct meshx_gen_light_cli_cb_reg_node meshx_gen_light_cli_cb_reg_node_t

meshx_gen_light_cli_cb_reg_t

typedef struct meshx_gen_light_cli_cb_reg meshx_gen_light_cli_cb_reg_t

meshx_gen_light_cli_resend_ctx

typedef struct meshx_gen_light_cli_resend_ctx meshx_gen_light_cli_resend_ctx

meshx_gen_light_client_msg_ctx_t

typedef struct meshx_gen_light_client_msg_ctx meshx_gen_light_client_msg_ctx_t

Function Documentation

meshx_gen_client_txcm_fn_model_send()

static meshx_err_t meshx_gen_client_txcm_fn_model_send ( meshx_gen_light_client_msg_ctx_t * params, size_t msg_param_len )

static

Send a message using the generic client model.

This function sends a message using the generic client model, allowing interaction with the BLE mesh network.

Parameters

[in]	params	Pointer to the message parameters structure.
[in]	msg_param_len	Length of the parameters structure in bytes.

Returns

• MESHX_SUCCESS: Message sent successfully.
• MESHX_INVALID_ARG: Invalid argument.
• MESHX_FAIL: Failed to send message.

Definition at line 209 of file meshx_gen_light_cli.c.

{
    if(params == NULL || msg_param_len != sizeof(meshx_gen_light_client_msg_ctx_t))
    {
        return MESHX_INVALID_ARG;
    }
    bool is_get_opcode = (meshx_is_gen_light_cli_get_opcode(params->opcode) == MESHX_SUCCESS);
 
    return meshx_plat_light_client_send_msg(
        params->model,
        &params->state,
        params->opcode,
        params->addr,
        params->net_idx,
        params->app_idx,
        is_get_opcode
    );
}

Here is the call graph for this function:

meshx_gen_light_cli_cb_reg_add()

static meshx_err_t meshx_gen_light_cli_cb_reg_add ( meshx_gen_light_cli_cb_reg_t reg )

static

Adds a new callback registration to the linked list of registered callbacks.

This function allocates a new node in the linked list of registered callbacks and initializes it with the provided registration information.

Parameters

[in]

reg

The structure containing the model ID and callback function to add to the linked list.

Definition at line 94 of file meshx_gen_light_cli.c.

{
    meshx_gen_light_cli_cb_reg_node_t *node = (meshx_gen_light_cli_cb_reg_node_t*) MESHX_MALLOC(sizeof(meshx_gen_light_cli_cb_reg_node_t));
    if (!node)
        return MESHX_NO_MEM;
 
    node->reg = reg;
    node->next = g_meshx_gen_light_client_ctrl.cli_cb_reg_head;
    g_meshx_gen_light_client_ctrl.cli_cb_reg_head = node;
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

meshx_gen_light_cli_handle_ack()

static meshx_err_t meshx_gen_light_cli_handle_ack ( uint16_t src_addr )

static

Handles ack request for generic light client messages.

This function requests the TXCM module to clear the last message by sending a ACK signal with null parameters.

Parameters

[in]

src_addr

The Source address of the message.

Returns

meshx_err_t Returns the error code from meshx_txcm_request_send().

Definition at line 285 of file meshx_gen_light_cli.c.

{
    meshx_err_t err = MESHX_SUCCESS;
    err = meshx_txcm_request_send(MESHX_TXCM_SIG_ACK, src_addr, NULL, 0, NULL);
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_light_cli_handle_resend()

static meshx_err_t meshx_gen_light_cli_handle_resend ( uint16_t model_id, const meshx_gen_light_cli_cb_param_t * param )

static

Handles resend request for generic light client messages.

This function requests the TXCM module to resend the last message by sending a RESEND signal with null parameters.

Returns

meshx_err_t Returns the error code from meshx_txcm_request_send().

Definition at line 300 of file meshx_gen_light_cli.c.

{
    meshx_gen_light_cli_resend_ctx ctx = {
        .model_id = model_id
    };
 
    memcpy(&ctx.param, param, sizeof(meshx_gen_light_cli_cb_param_t));
 
    return meshx_txcm_request_send(
        MESHX_TXCM_SIG_RESEND,
        MESHX_ADDR_UNASSIGNED,
        &ctx,
        sizeof(meshx_gen_light_cli_resend_ctx),
        NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_light_cli_init()

meshx_err_t meshx_gen_light_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 397 of file meshx_gen_light_cli.c.

{
    if (g_meshx_gen_light_client_ctrl.meshx_client_init == MESHX_CLIENT_INIT_MAGIC_NO)
        return MESHX_SUCCESS;
    g_meshx_gen_light_client_ctrl.meshx_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_light_client_init();
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_light_client_from_ble_reg_cb()

meshx_err_t meshx_gen_light_client_from_ble_reg_cb	(	uint16_t	model_id,
		meshx_gen_light_client_cb_t	cb )

Registers a callback function for getting Generic Light Client messages from BLE.

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 472 of file meshx_gen_light_cli.c.

{
    if (!cb || meshx_is_gen_light_cli_model(model_id) != MESHX_SUCCESS)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_err_t err = MESHX_SUCCESS;
    meshx_gen_light_cli_cb_reg_t reg = { .model_id = model_id, .cb = cb };
 
    err = meshx_gen_light_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_light_msg
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_light_send_msg()

meshx_err_t meshx_gen_light_send_msg

(

const meshx_gen_light_client_send_params_t *

params

)

Send a message using the generic client model.

This function sends a message using the generic client model, allowing interaction with the BLE mesh network.

Parameters

[in]

params

Pointer to the message parameters.

Returns

• MESHX_SUCCESS: Message sent successfully.
• Appropriate error code on failure.

Definition at line 423 of file meshx_gen_light_cli.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_light_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:

Here is the caller graph for this function:

meshx_handle_gen_light_msg()

static meshx_err_t meshx_handle_gen_light_msg ( dev_struct_t * pdev, control_task_msg_evt_t model_id, meshx_gen_light_cli_cb_param_t * param )

static

Handle the Generic Light Client messages.

This function processes the incoming messages for the Generic Light Client and performs the necessary actions based on the message event and parameters.

Parameters

[in]	pdev	Pointer to the device structure containing device-specific information.
[in]	model_id	The model ID of the received message.
[in]	param	Pointer to the Generic Client callback parameter structure.

Returns

MESHX_SUCCESS on success, or an error code on failure.

Definition at line 328 of file meshx_gen_light_cli.c.

{
    if(!param || !pdev)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid parameters");
        return MESHX_INVALID_ARG;
    }
    meshx_gen_light_cli_cb_reg_t const * reg_cb = NULL;
    meshx_err_t err = MESHX_SUCCESS;
 
    meshx_gen_light_cli_cb_reg_node_t *node = g_meshx_gen_light_client_ctrl.cli_cb_reg_head;
 
    while (node)
    {
        if (model_id == node->reg.model_id)
        {
            MESHX_LOGD(MODULE_ID_MODEL_CLIENT, "op|src|dst:%04" PRIx32 "|%04x|%04x",
                       param->ctx.opcode, param->ctx.src_addr, param->ctx.dst_addr);
            reg_cb = &node->reg;
            if (param->evt == MESHX_GEN_LIGHT_CLI_TIMEOUT || param->err_code != MESHX_SUCCESS)
            {
                MESHX_LOGD(MODULE_ID_MODEL_CLIENT, "Retrying to send the message");
                err = meshx_gen_light_cli_handle_resend((uint16_t)model_id, param);
                if(err != MESHX_SUCCESS)
                {
                    MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Resend failed: %d", err);
                }
                else
                {
                    /* As the retry would callback shall be triggered by the TXCM */
                    MESHX_DO_NOTHING;
                }
            }
            else
            {
                /* We need to notify if the ack is from the same source as that of dest */
                err = meshx_gen_light_cli_handle_ack(param->ctx.src_addr);
                if(err != MESHX_SUCCESS)
                {
                    MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Ack failed: %d", err);
                }
                err = reg_cb->cb(pdev, model_id, param);
            }
        }
        node = node->next;
    }
 
    if(reg_cb == NULL)
    {
        return MESHX_SUCCESS;
    }
 
    return err;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_handle_txcm_msg()

static meshx_err_t meshx_handle_txcm_msg ( dev_struct_t * pdev, control_task_msg_evt_t evt, meshx_gen_light_cli_resend_ctx * param )

static

Handles TXCM message for generic light client.

This function is called by the TXCM module to handle a message for the generic client model. It is responsible for processing the message and taking appropriate actions. The function also handles resend requests for generic client messages.

Parameters

[in]	pdev	Pointer to the device structure.
[in]	evt	Pointer to the control task message structure.
[in]	param	Pointer to the message context structure.

Returns

meshx_err_t Returns the error code from the message processing.

Definition at line 242 of file meshx_gen_light_cli.c.

{
    MESHX_UNUSED(evt);
    meshx_err_t err = MESHX_SUCCESS;
    meshx_gen_light_cli_cb_reg_t const * reg_cb = NULL;
    const meshx_gen_light_cli_cb_reg_node_t *node = g_meshx_gen_light_client_ctrl.cli_cb_reg_head;
 
    MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "TXCM Timeout for model 0x%x", param->model_id);
 
    while (node)
    {
        if (param->model_id == node->reg.model_id)
        {
            reg_cb                  = &node->reg;
            param->param.err_code   = MESHX_TIMEOUT;
            param->param.evt        = MESHX_GEN_LIGHT_CLI_TIMEOUT;
            err = reg_cb->cb(pdev, param->model_id, &param->param);
        }
        node = node->next;
    }
 
    if(reg_cb == NULL)
    {
        return MESHX_SUCCESS;
    }
 
    return err;
}

meshx_is_gen_light_cli_get_opcode()

static meshx_err_t meshx_is_gen_light_cli_get_opcode ( uint32_t opcode )

static

Checks if the given model ID corresponds to a Generic Light Client GET opcode.

This function determines whether the specified opcode is part of the set of GET

Parameters

opcode

The opcode to check.

Returns

meshx_err_t Returns an error code indicating whether the opcode is a GET opcode for the Generic Light Client model.

Definition at line 116 of file meshx_gen_light_cli.c.

{
    switch (opcode)
    {
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_GET:
        case MESHX_MODEL_OP_LIGHT_CTL_GET:
        case MESHX_MODEL_OP_LIGHT_HSL_GET:
        case MESHX_MODEL_OP_LIGHT_XYL_GET:
        case MESHX_MODEL_OP_LIGHT_LC_MODE_GET:
        case MESHX_MODEL_OP_LIGHT_LC_OM_GET:
        case MESHX_MODEL_OP_LIGHT_LC_LIGHT_ONOFF_GET:
        case MESHX_MODEL_OP_LIGHT_LC_PROPERTY_GET:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

Here is the caller graph for this function:

meshx_is_gen_light_cli_model()

static meshx_err_t meshx_is_gen_light_cli_model ( uint32_t model_id )

static

Checks if the given model ID corresponds to a Generic Light Client model.

This function determines whether the specified model ID matches the Generic Light Client model supported by MeshX.

Parameters

model_id

The model ID to check.

Returns

meshx_err_t Returns an error code indicating whether the model ID is a Generic Light Client model.

Definition at line 143 of file meshx_gen_light_cli.c.

{
    switch (model_id)
    {
        case MESHX_MODEL_ID_LIGHT_LIGHTNESS_CLI:
        case MESHX_MODEL_ID_LIGHT_CTL_CLI:
        case MESHX_MODEL_ID_LIGHT_HSL_CLI:
        case MESHX_MODEL_ID_LIGHT_XYL_CLI:
        case MESHX_MODEL_ID_LIGHT_LC_CLI:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

Here is the caller graph for this function:

meshx_is_unack_opcode()

static meshx_err_t meshx_is_unack_opcode ( uint32_t opcode )

static

Checks if the given opcode corresponds to an unacknowledged (unack) message in the Generic Light Client model.

This function determines whether the provided opcode represents a SET_UNACK operation for various Generic models in the BLE Mesh specification. It returns success if the opcode matches one of the defined unacknowledged set opcodes.

Parameters

[in]

opcode

The mesh model opcode to check (uint32_t).

Returns

MESHX_SUCCESS if the opcode is a recognized unacknowledged set opcode (e.g., Generic Light Lightness Set Unack, Generic CTL Set Unack, etc.).

MESHX_FAIL if the opcode does not match any unacknowledged set opcode.

Note

This utility function is used internally for handling reliable vs. non-reliable messaging in Generic Client models. Unacknowledged messages do not expect a response from the server.

Aligns with Bluetooth SIG Mesh Generic models opcodes (e.g., 0x8201 for Generic Light Lightness Set Unacknowledged).

Definition at line 177 of file meshx_gen_light_cli.c.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_CTL_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_HSL_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_XYL_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_LC_MODE_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_LC_OM_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_LC_LIGHT_ONOFF_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_LC_PROPERTY_SET_UNACK:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

Here is the caller graph for this function:

Variable Documentation

cli_cb_reg_head

meshx_gen_light_cli_cb_reg_node_t* cli_cb_reg_head

Pointer to the head of the linked list of registered callbacks.

Definition at line 83 of file meshx_gen_light_cli.c.

[struct]

struct { ... } g_meshx_gen_light_client_ctrl

meshx_client_init

uint16_t meshx_client_init

Flag indicating whether the mesh client has been initialized.

Definition at line 82 of file meshx_gen_light_cli.c.