meshx_model_battery.hpp File Reference

Implementation of Generic Battery Model for MeshX. More...

#include <meshx_model_class.hpp>
#include <meshx_base_model_generic.hpp>

Go to the source code of this file.

Data Structures
struct	meshx_gen_battery_model_state
	Structure to hold the Battery model state. More...
struct	meshx_gen_battery_send_params
	Structure to hold the parameters for sending a Generic Battery message. More...
struct	meshx_battery_cli_el_msg
	Structure to hold the Battery Server to parent element message. The structure is used by the on_model_cb function to send the Battery state change notification to the parent element. More...
class	meshXGenericBatteryClientModel
	A template class for creating Generic Battery Client models. More...
class	meshXGenericBatteryServerModel
	A template class for creating Generic Battery Server models. More...

Macros
#define	MESHX_GEN_BATTERY_CLIENT_MODEL_TEMPLATE_PROTO
#define	MESHX_GEN_BATTERY_CLIENT_MODEL_TEMPLATE_PARAMS
#define	MESHX_GEN_BATTERY_SERVER_MODEL_TEMPLATE_PROTO
#define	MESHX_GEN_BATTERY_SERVER_MODEL_TEMPLATE_PARAMS

Typedefs
using	meshx_gen_battery_model_state_t = struct meshx_gen_battery_model_state
using	meshx_gen_battery_send_params_t = struct meshx_gen_battery_send_params
using	meshx_battery_cli_el_msg_t = struct meshx_battery_cli_el_msg
using	meshx_battery_srv_el_msg_t

Detailed Description

Implementation of Generic Battery Model for MeshX.

This file contains the implementation of the Generic Battery model, which provides standard Battery model functionality in the MeshX BLE mesh framework.

Key Features:

• Implements Bluetooth SIG-defined Generic Battery model
• Inherits from meshXClientModel and meshXServerModel templates
• Provides standard Battery status operations
• Integrates with MeshX transmission control

Author

Pranjal Chanda

Date

2024-2025

Copyright

Copyright 2024 - 2025 MeshX

Macro Definition Documentation

MESHX_GEN_BATTERY_CLIENT_MODEL_TEMPLATE_PARAMS

#define MESHX_GEN_BATTERY_CLIENT_MODEL_TEMPLATE_PARAMS

MESHX_GEN_BATTERY_CLIENT_MODEL_TEMPLATE_PROTO

#define MESHX_GEN_BATTERY_CLIENT_MODEL_TEMPLATE_PROTO

MESHX_GEN_BATTERY_SERVER_MODEL_TEMPLATE_PARAMS

#define MESHX_GEN_BATTERY_SERVER_MODEL_TEMPLATE_PARAMS

MESHX_GEN_BATTERY_SERVER_MODEL_TEMPLATE_PROTO

#define MESHX_GEN_BATTERY_SERVER_MODEL_TEMPLATE_PROTO

Typedef Documentation

meshx_battery_cli_el_msg_t

using meshx_battery_cli_el_msg_t = struct meshx_battery_cli_el_msg

meshx_battery_srv_el_msg_t

using meshx_battery_srv_el_msg_t

Initial value:

 struct meshx_battery_srv_el_msg
{
    meshx_srv_model_send_param_header_t header; 
    meshx_gen_battery_model_state_t       state;  
}

{
    meshx_srv_model_send_param_header_t header; /**< Server model send param header */
    meshx_gen_battery_model_state_t       state;  /**< The state of the message. */
};

meshx_gen_battery_model_state_t

using meshx_gen_battery_model_state_t = struct meshx_gen_battery_model_state

meshx_gen_battery_send_params_t

using meshx_gen_battery_send_params_t = struct meshx_gen_battery_send_params