meshx_relay_element.hpp

Go to the documentation of this file.

/**
 * @file meshx_relay_element.hpp
 * @brief MeshX Relay Element class definition
 * This file contains the meshXRelayServerElement class which represents a relay element
 * in the MeshX BLE mesh network.
 *
 * @author Pranjal Chanda
 * @date 2024-2025
 * @copyright Copyright 2024 - 2025 MeshX
 */
 
#ifndef __MESHX_RELAY_ELEMENT_HPP__
#define __MESHX_RELAY_ELEMENT_HPP__
 
#include <meshx_element_class.hpp>
#include <generic_model/meshx_model_onoff.hpp>
 
#define MESHX_RELAY_SERVER_ELEMENT_TEMPLATE_PROTO
#define MESHX_RELAY_SERVER_ELEMENT_TEMPLATE_PARAMS
 
#define MESHX_RELAY_CLIENT_ELEMENT_TEMPLATE_PROTO
#define MESHX_RELAY_CLIENT_ELEMENT_TEMPLATE_PARAMS
 
/**
 * @brief Relay server element context structure
 * @details This structure contains the state context for the relay server element,
 *          including the OnOff state and publication/app binding information.
 *          This matches the C implementation pattern where state is maintained
 *          in the element layer for NVS persistence.
 */
struct meshx_relay_srv_el_ctx_t
{
    uint16_t                        app_id;             /**< Application key ID for publication */
    uint16_t                        pub_addr;           /**< Publication address */
    meshx_gen_onoff_model_state_t   gen_on_off_state;   /**< Current OnOff state (0=OFF, 1=ON) */
};
 
using meshx_relay_srv_el_ctx_t = struct meshx_relay_srv_el_ctx_t;
 
/*********************************************************************************
 * meshXRelayServerElement
 *********************************************************************************/
 
enum class meshxRelayServerElementComposition : uint8_t
{
    MESHX_RELAY_SERVER_ELEMENT_COMP_GENERIC_ONOFF_SERVER = 0,
    MESHX_RELAY_SERVER_ELEMENT_COMP_MAX,
};
 
MESHX_RELAY_SERVER_ELEMENT_TEMPLATE_PROTO
class meshXRelayServerElement : public meshXElementServer MESHX_RELAY_SERVER_ELEMENT_TEMPLATE_PARAMS
{
private:
    meshx_relay_srv_el_ctx_t element_ctx;
 
    uint8_t list_sig_models (void) override;
    uint8_t list_ven_models (void) override;
    const char* get_element_name(void) const override;
 
    /**
     * @brief Notify element of state change from child model.
     * @details Overrides base class stub. Updates element_ctx, saves to NVS,
     *          and dispatches app notification via meshx_send_msg_to_app().
     */
    meshx_err_t element_state_change_notify(meshx_ptr_t param, size_t param_size) override;
 
    /**
     * @brief Synchronize element state (Status broadcast)
     */
    void sync(control_task_msg_evt_t evt) override;
 
    /**
     * @brief Handle configuration server events
     */
    void handle_config(control_task_msg_evt_t evt, const meshx_config_srv_cb_param_t *params) override;
 
    static meshx_err_t s_to_ble_cb(
        const dev_struct_t      *pdev,
        control_task_msg_evt_t   evt,
        const void              *params);
 
public:
    /**
     * @brief Constructs a new meshXRelayServerElement instance.
     * The meshXRelayServerElement represents a relay element in the MeshX BLE mesh network.
     * It automatically initializes and configures all required SIG models for the relay element.
     *
     * @param element_idx The index of the element within the node.
     */
    explicit meshXRelayServerElement (uint16_t element_idx);
 
    meshXRelayServerElement (void) = delete;
 
    /**
     * @brief Get the current OnOff state of the relay server.
     * @return uint8_t 0 for OFF, 1 for ON.
     */
    uint8_t get_state() const { return element_ctx.gen_on_off_state.on_off; }
};
 
/*********************************************************************************
 * meshXRelayClientElement
 *********************************************************************************/
enum class meshxRelayClientElementComposition : uint8_t
{
    MESHX_RELAY_CLIENT_ELEMENT_COMP_GENERIC_ONOFF_CLIENT = 0,
    MESHX_RELAY_CLIENT_ELEMENT_COMP_MAX,
};
 
/**
 * @brief Relay client element context structure
 * @details This structure contains state context for relay client element,
 *          including OnOff state and publication/app binding information.
 *          This matches to C implementation pattern where state is maintained
 *          in element layer for NVS persistence.
 */
struct meshx_relay_cli_el_ctx_t
{
    uint16_t                        app_id;             /**< Application key ID for publication */
    uint16_t                        pub_addr;           /**< Publication address */
    meshx_gen_onoff_model_state_t   gen_on_off_state;   /**< Current OnOff state (0=OFF, 1=ON) */
};
 
using meshx_relay_cli_el_ctx_t = struct meshx_relay_cli_el_ctx_t;
 
 
MESHX_RELAY_CLIENT_ELEMENT_TEMPLATE_PROTO
class meshXRelayClientElement : public meshXElementClient MESHX_RELAY_CLIENT_ELEMENT_TEMPLATE_PARAMS
{
private:
    meshx_relay_cli_el_ctx_t element_ctx;
 
    uint8_t list_sig_models (void) override;
    uint8_t list_ven_models (void) override;
 
    const char* get_element_name(void) const override;
 
    /**
     * @brief Notify element of state change from child model.
     * @details Overrides base class stub. Updates element_ctx, saves to NVS,
     *          and dispatches app notification via meshx_send_msg_to_app().
     */
    meshx_err_t element_state_change_notify(meshx_ptr_t param, size_t param_size) override;
 
    /**
     * @brief Synchronize element state (GET request)
     */
    void sync(control_task_msg_evt_t evt) override;
 
    /**
     * @brief Handle configuration server events
     */
    void handle_config(control_task_msg_evt_t evt, const meshx_config_srv_cb_param_t *params) override;
 
    static meshx_err_t s_to_ble_cb(
        const dev_struct_t      *pdev,
        control_task_msg_evt_t   evt,
        const void              *params);
 
public:
    /**
     * @brief Constructs a new meshXRelayClientElement instance.
     * The meshXRelayClientElement represents a relay client element in the MeshX BLE mesh network.
     * It automatically initializes and configures all required SIG models for the relay client element.
     *
     * @param element_idx The index of the element within the node.
     */
    explicit meshXRelayClientElement (uint16_t element_idx);
 
    meshXRelayClientElement (void) = delete;
 
    /**
     * @brief Get the current OnOff state of the relay client.
     * @return uint8_t 0 for OFF, 1 for ON.
     */
    uint8_t get_state() const { return element_ctx.gen_on_off_state.on_off; }
 
    /**
     * @brief Set the target OnOff state for the next publication.
     * @param on_off 0 for OFF, 1 for ON.
     */
    void set_target_onoff(uint8_t on_off) { element_ctx.gen_on_off_state.next_on_off = on_off; }
 
    /**
     * @brief Get the element context (Internal use).
     */
    meshx_relay_cli_el_ctx_t& get_ctx() { return element_ctx; }
};
 
#endif /* __MESHX_RELAY_ELEMENT_HPP__ */