meshx_base_model_generic.hpp File Reference

Header file for MeshX Generic Client and Server model declarations. More...

#include <meshx_base_model_class.hpp>

Go to the source code of this file.

Data Structures
class	meshXBaseGenericClientModel
	Template specialization of meshXBaseClientModel for Generic BLE mesh models. More...
class	meshXBaseGenericServerModel
	Template specialization of meshXBaseServerModel for Generic BLE mesh models. More...

Macros
#define	MESHX_BASE_GENERIC_SERVER_TEMPLATE_PROTO
#define	MESHX_BASE_GENERIC_SERVER_TEMPLATE_PARAMS
#define	MESHX_BASE_GENERIC_CLIENT_TEMPLATE_PROTO
#define	MESHX_BASE_GENERIC_CLIENT_TEMPLATE_PARAMS

Typedefs
using	meshx_gen_cli_resend_ctx
using	meshx_gen_client_msg_ctx_t
using	meshx_gen_server_send_params_t
using	meshx_gen_server_restore_params_t

Detailed Description

Header file for MeshX Generic Client and Server model declarations.

This header file contains the declarations for Generic BLE mesh model classes that extend the template-based meshXBaseClientModel and meshXBaseServerModel. It defines the specific implementation for Generic models including message contexts, callback structures, and the main Generic Client model class.

Key Components:

• Generic Client message context structures for TXCM integration
• Resend context for timeout and retry mechanisms
• meshXBaseGenericClientModel class with Generic-specific functionality
• Platform-specific message sending and handling interfaces
• Opcode validation for Generic model operations

Template Specialization: This file provides concrete implementations of the template-based base classes specifically tailored for Generic BLE mesh models, ensuring type safety and optimal performance for Generic OnOff, Level, Power, Battery, and Location models.

Author

Pranjal Chanda

Date

2024-2025

Copyright

Copyright © 2024 - 2025 MeshX

Macro Definition Documentation

MESHX_BASE_GENERIC_CLIENT_TEMPLATE_PARAMS

#define MESHX_BASE_GENERIC_CLIENT_TEMPLATE_PARAMS

MESHX_BASE_GENERIC_CLIENT_TEMPLATE_PROTO

#define MESHX_BASE_GENERIC_CLIENT_TEMPLATE_PROTO

MESHX_BASE_GENERIC_SERVER_TEMPLATE_PARAMS

#define MESHX_BASE_GENERIC_SERVER_TEMPLATE_PARAMS

MESHX_BASE_GENERIC_SERVER_TEMPLATE_PROTO

#define MESHX_BASE_GENERIC_SERVER_TEMPLATE_PROTO

Typedef Documentation

meshx_gen_cli_resend_ctx

using meshx_gen_cli_resend_ctx

Initial value:

 struct meshx_gen_cli_resend_ctx
{
    uint16_t model_id;              
    meshx_gen_cli_cb_param_t param; 
}

{
    uint16_t model_id;              /**< Model ID associated with the re-sending. */
    meshx_gen_cli_cb_param_t param; /**< Parameter associated with the re-sending. */
};

meshx_gen_client_msg_ctx_t

using meshx_gen_client_msg_ctx_t

Initial value:

 struct meshx_gen_client_msg_ctx
{
    meshx_ptr_t model;         
    uint16_t opcode;           
    uint16_t addr;             
    uint16_t net_idx;          
    uint16_t app_idx;          
    meshx_gen_cli_set_t state; 
}

{
    meshx_ptr_t model;         /**< Model context associated with the message. */
    uint16_t opcode;           /**< Opcode associated with the message. */
    uint16_t addr;             /**< Destination address associated with the message. */
    uint16_t net_idx;          /**< Network index associated with the message. */
    uint16_t app_idx;          /**< Application key index associated with the message. */
    meshx_gen_cli_set_t state; /**< State parameters associated with the message. */
};

meshx_gen_server_restore_params_t

using meshx_gen_server_restore_params_t

Initial value:

 struct meshx_gen_server_restore_params
{
    meshx_model_t *p_model;                     
    meshx_gen_server_state_t state_change;      
}

{
    meshx_model_t *p_model;                     /**< Pointer to the server model. */
    meshx_gen_server_state_t state_change;      /**< State change information. Platform Interface. */
};

meshx_gen_server_send_params_t

using meshx_gen_server_send_params_t

Initial value:

 struct meshx_gen_server_send_params
{
    meshx_model_t *p_model;                     
    meshx_ctx_t *p_ctx;                         
    meshx_gen_srv_state_change_t state_change;  
    size_t data_len;                            
}

{
    meshx_model_t *p_model;                     /**< Pointer to the server model. */
    meshx_ctx_t *p_ctx;                         /**< Pointer to the context. */
    meshx_gen_srv_state_change_t state_change;  /**< State change information. Platform Interface. */
    size_t data_len;                            /**< Length of the data. */
};