meshx_base_model_light.hpp File Reference

Header file for MeshX Light Client model declarations. More...

#include <meshx_base_model_class.hpp>

Go to the source code of this file.

Data Structures
class	meshXBaseLightClientModel
	Template specialization of meshXBaseClientModel for Light BLE mesh models. More...
class	meshXBaseLightServerModel
	Implementation of meshXBaseServerModel for Light BLE mesh models. More...

Macros
#define	MESHX_BASE_LIGHT_SERVER_TEMPLATE_PROTO
#define	MESHX_BASE_LIGHT_SERVER_TEMPLATE_PARAMS
#define	MESHX_BASE_LIGHT_CLIENT_TEMPLATE_PROTO
#define	MESHX_BASE_LIGHT_CLIENT_TEMPLATE_PARAMS

Typedefs
using	meshx_light_cli_resend_ctx_t
using	meshx_light_client_msg_ctx_t
using	meshx_light_server_restore_params_t

Detailed Description

Header file for MeshX Light Client model declarations.

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

Key Components:

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

Template Specialization: This file provides concrete implementations of the template-based base classes specifically tailored for Light BLE mesh models, ensuring type safety and optimal performance for Light Lightness, CTL, HSL, XYL, and LC models.

Author

Pranjal Chanda

Date

2024-2025

Copyright

Copyright © 2024 - 2025 MeshX

Macro Definition Documentation

MESHX_BASE_LIGHT_CLIENT_TEMPLATE_PARAMS

#define MESHX_BASE_LIGHT_CLIENT_TEMPLATE_PARAMS

MESHX_BASE_LIGHT_CLIENT_TEMPLATE_PROTO

#define MESHX_BASE_LIGHT_CLIENT_TEMPLATE_PROTO

MESHX_BASE_LIGHT_SERVER_TEMPLATE_PARAMS

#define MESHX_BASE_LIGHT_SERVER_TEMPLATE_PARAMS

MESHX_BASE_LIGHT_SERVER_TEMPLATE_PROTO

#define MESHX_BASE_LIGHT_SERVER_TEMPLATE_PROTO

Typedef Documentation

meshx_light_cli_resend_ctx_t

using meshx_light_cli_resend_ctx_t

Initial value:

 struct meshx_light_cli_resend_ctx
{
    uint16_t model_id;                    
    meshx_gen_light_cli_cb_param_t param; 
}

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

meshx_light_client_msg_ctx_t

using meshx_light_client_msg_ctx_t

Initial value:

 struct meshx_light_client_msg_ctx
{
    meshx_ptr_t model;                         
    uint16_t opcode;                           
    uint16_t addr;                             
    uint16_t net_idx;                          
    uint16_t app_idx;                          
    meshx_light_client_set_state_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_light_client_set_state_t state;      /**< State parameters associated with the message. */
};

meshx_light_server_restore_params_t

using meshx_light_server_restore_params_t

Initial value:

 struct meshx_light_server_restore_params
{
    meshx_model_t *p_model;                     
    meshx_lighting_server_state_t state_change; 
}

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