meshx_relay_client_element.h File Reference

Header file for the Relay Client Model in BLE Mesh. More...

#include "meshx_common.h"
#include "meshx_onoff_client.h"

Include dependency graph for meshx_relay_client_element.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_on_off_cli_msg
	Structure to hold the relay client message. More...
struct	meshx_relay_client_model_ctx
	Structure to hold the context of the relay client. More...
struct	relay_client_element
	Structure to hold the context and configuration for the relay client element. More...
struct	relay_client_element_ctrl

Macros
#define	RELAY_CLI_MODEL_SIG_CNT   RELAY_CLI_SIG_MAX_ID
	Number of SIG models in a relay model element.
#define	RELAY_CLI_MODEL_VEN_CNT   0
	Number of Vendor models in a relay model element.

Typedefs
typedef struct meshx_gen_on_off_cli_msg	meshx_gen_on_off_cli_msg_t
	Structure to hold the relay client message.
typedef struct meshx_relay_client_model_ctx	meshx_relay_client_model_ctx_t
	Structure to hold the context of the relay client.
typedef struct relay_client_element	relay_client_elements_t
	Structure to hold the context and configuration for the relay client element.
typedef struct relay_client_element_ctrl	relay_client_element_ctrl_t

Enumerations
enum	relay_cli_sig_id_t {   RELAY_CLI_SIG_ONOFF_MODEL_ID ,   RELAY_CLI_SIG_MAX_ID }

Functions
meshx_err_t	meshx_relay_el_get_state (uint16_t el_id)
	Retrieves the current state of the relay element.
meshx_err_t	meshx_relay_el_set_state (uint16_t el_id, bool ack)
	Set the On/Off state for a specific element in the BLE mesh network.
meshx_err_t	create_relay_client_elements (dev_struct_t *pdev, uint16_t element_cnt)
	Create Dynamic Relay Model Elements.

Detailed Description

Header file for the Relay Client Model in BLE Mesh.

Copyright © 2024 - 2025 MeshX

This file contains the definitions and function declarations for the Relay Client Model used in BLE Mesh applications. The Relay Client Model is responsible for managing relay client elements, sending messages to relay nodes or groups, and handling the state and context of relay clients.

The file defines constants, data structures, and function prototypes for creating and managing relay client elements. It includes the following key components:

• Definitions for the number of relay client elements, SIG models, and message types.
• Data structures for relay client context, messages, and elements.
• Function prototypes for creating relay client elements and sending messages.

Author

Pranjal Chanda

Definition in file meshx_relay_client_element.h.

Macro Definition Documentation

RELAY_CLI_MODEL_SIG_CNT

#define RELAY_CLI_MODEL_SIG_CNT   RELAY_CLI_SIG_MAX_ID

Number of SIG models in a relay model element.

Definition at line 34 of file meshx_relay_client_element.h.

RELAY_CLI_MODEL_VEN_CNT

#define RELAY_CLI_MODEL_VEN_CNT   0

Number of Vendor models in a relay model element.

Definition at line 39 of file meshx_relay_client_element.h.

Typedef Documentation

meshx_gen_on_off_cli_msg_t

typedef struct meshx_gen_on_off_cli_msg meshx_gen_on_off_cli_msg_t

Structure to hold the relay client message.

meshx_relay_client_model_ctx_t

typedef struct meshx_relay_client_model_ctx meshx_relay_client_model_ctx_t

Structure to hold the context of the relay client.

relay_client_element_ctrl_t

typedef struct relay_client_element_ctrl relay_client_element_ctrl_t

relay_client_elements_t

typedef struct relay_client_element relay_client_elements_t

Structure to hold the context and configuration for the relay client element.

Enumeration Type Documentation

relay_cli_sig_id_t

enum relay_cli_sig_id_t

Enumerator
RELAY_CLI_SIG_ONOFF_MODEL_ID	On/Off model ID
RELAY_CLI_SIG_MAX_ID	Maximum model ID

Definition at line 41 of file meshx_relay_client_element.h.

{
    RELAY_CLI_SIG_ONOFF_MODEL_ID,   
    RELAY_CLI_SIG_MAX_ID,           
} relay_cli_sig_id_t;

Function Documentation

create_relay_client_elements()

meshx_err_t create_relay_client_elements	(	dev_struct_t *	pdev,
		uint16_t	element_cnt )

Create Dynamic Relay Model Elements.

Parameters

[in]	pdev	Pointer to device structure
[in]	element_cnt	Maximum number of relay models

Returns

meshx_err_t

Definition at line 635 of file meshx_relay_client.c.

{
    meshx_err_t err;
 
    err = meshx_dev_create_relay_model_space(pdev, element_cnt);
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "Relay Model space create failed: (%d)", err);
        return err;
    }
 
    err = meshx_add_relay_cli_model_to_element_list(pdev, (uint16_t *)&pdev->element_idx, element_cnt);
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "Relay Model add to element create failed: (%d)", err);
        return err;
    }
 
#if CONFIG_ENABLE_CONFIG_SERVER
    err = meshx_config_server_cb_reg(
        (config_srv_cb_t)&relay_client_config_cli_cb,
        CONFIG_SERVER_CB_MASK);
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "Relay Model config client callback reg failed: (%d)", err);
        return err;
    }
#endif /* CONFIG_ENABLE_CONFIG_SERVER */
    err = meshx_relay_cli_reg_app_req_cb();
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "Relay Client app req callback reg failed: (%d)", err);
        return err;
    }
    err = meshx_prov_srv_reg_el_client_cb(
        (prov_srv_cb_t)&relay_cli_prov_srv_msg_handle);
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "Relay Client freshboot callback reg failed: (%d)", err);
        return err;
    }
    err = meshx_relay_cli_el_state_change_reg_cb();
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "Relay Client element state change callback reg failed: (%d)", err);
        return err;
    }
#if CONFIG_ENABLE_UNIT_TEST
    err = register_unit_test(MOD_SRC, &relay_cli_unit_test_cb_handler);
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "unit_test reg failed: (%d)", err);
        return err;
    }
#endif /* CONFIG_ENABLE_UNIT_TEST */
 
    err = meshx_on_off_client_init();
    if (err)
    {
        MESHX_LOGE(MOD_SRC, "meshx_onoff_client_init failed: (%d)", err);
        return err;
    }
 
    return MESHX_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_relay_el_get_state()

meshx_err_t meshx_relay_el_get_state

(

uint16_t

el_id

)

Retrieves the current state of the relay element.

This function constructs a generic On/Off client message to request the current state of a relay element identified by the given element ID. It then publishes this message to the control task for BLE communication.

Parameters

[in]

el_id

The element ID of the relay whose state is to be retrieved.

Returns

meshx_err_t Returns the result of the message publish operation.

Definition at line 613 of file meshx_relay_client.c.

{
    meshx_gen_on_off_cli_msg_t msg = {
        .ack        = MESHX_GEN_ON_OFF_CLI_MSG_ACK,
        .set_get    = MESHX_GEN_ON_OFF_CLI_MSG_GET,
        .element_id = el_id
    };
    return control_task_msg_publish(
            CONTROL_TASK_MSG_CODE_TO_BLE,
            CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF,
            &msg,
            sizeof(msg));
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_relay_el_set_state()

meshx_err_t meshx_relay_el_set_state	(	uint16_t	el_id,
		bool	ack )

Set the On/Off state for a specific element in the BLE mesh network.

This function sets the On/Off state of the specified element, optionally waiting for an acknowledgment.

Parameters

[in]	el_id	The ID of the element for which to set the On/Off state.
[in]	ack	Whether to wait for an acknowledgment (true) or not (false).

Returns

• MESHX_SUCCESS: Successfully set the state.
• MESHX_INVALID_ARG: Invalid element ID or parameters.
• MESHX_FAIL: Failed to set the state.

Definition at line 589 of file meshx_relay_client.c.

{
    meshx_gen_on_off_cli_msg_t msg = {
        .ack        = ack == MESHX_GEN_ON_OFF_CLI_MSG_ACK,
        .set_get    = MESHX_GEN_ON_OFF_CLI_MSG_SET,
        .element_id = el_id
    };
    return control_task_msg_publish(
            CONTROL_TASK_MSG_CODE_TO_BLE,
            CONTROL_TASK_MSG_EVT_TO_BLE_SET_ON_OFF,
            &msg,
            sizeof(msg));
}

Here is the call graph for this function:

Here is the caller graph for this function: