meshXGenericBatteryServerModel Class Reference

A template class for creating Generic Battery Server models. More...

#include <meshx_model_battery.hpp>

Inheritance diagram for meshXGenericBatteryServerModel:

Public Member Functions
meshx_err_t	model_send (meshx_gen_battery_send_params_t *params) override
	Send a packet to the MeshX stack based on the given parameters.
meshx_err_t	model_from_ble_cb (dev_struct_t *, control_task_msg_evt_t, meshx_ptr_t) override
	Callback function for handling BLE mesh events for the Generic Battery Server Model.
meshx_err_t	prepare_element_msg (meshx_ptr_t *msg_ptr, size_t *msg_size) override
	Prepare message for element notification.
meshx_err_t	element_state_change_handle (void) override
	Handle state change request from element.
	meshXGenericBatteryServerModel (meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Constructor for the Generic Battery Server Model.
	~meshXGenericBatteryServerModel ()=default
Public Member Functions inherited from meshXServerModel< meshXBaseGenericServerModel, meshx_gen_battery_send_params_t >
	meshXServerModel (MESHX_MODEL *p_plat_model, uint32_t model_id, meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Construct a new Server Model.
Public Member Functions inherited from meshXModel< meshXBaseGenericServerModel, meshx_gen_battery_send_params_t >
void	set_plat_model (MESHX_MODEL *p_model) override
	Set the platform-specific model instance.
meshx_err_t	model_handle_from_ble_cb (dev_struct_t *p_dev, evt_model_id_t evt_model_id, meshx_ptr_t params)
	Handle upstream BLE Mesh events.
void	on_baked (void) override
	Called when the model's parent element is baked.
virtual	~meshXModel ()
	Destructor for meshXModel.
meshx_err_t	send_to_parent_element (meshx_ptr_t msg_ptr, size_t msg_size)
	Send message to parent element.
uint16_t	get_model_func_id (void) const
	Get the model function identifier.
void	set_model_func_id (uint16_t func_id)
	Set the model function identifier.
uint16_t	get_model_id (void) const override
	Get the model identifier.
bool	is_initialized (void) const override
	Check if the model is successfully initialized.
void	set_model_id (uint16_t id)
	Set the model identifier.
meshx_err_t	get_init_status (void) const
	Get the model initialization status.
meshXBaseGenericServerModel *	get_base_model (void) const
	Get the base model instance.
	meshXModel (MESHX_MODEL *p_plat_model, uint32_t model_id, meshXElementIF *parent_element=nullptr, uint16_t model_func_id=0)
	Constructs a new meshXModel instance.
Public Member Functions inherited from meshXModelIF
	meshXModelIF ()
	meshXModelIF (MESHX_MODEL *p_plat_model)
virtual	~meshXModelIF ()=default
MESHX_MODEL *	get_plat_model (void) const
	Get the platform-specific model instance.
meshx_ptr_t	get_pub_struct (void) const
	Get the publication structures.
meshx_ptr_t	get_gen_struct (void) const
	Get the generic structures.
void	set_pub_struct (meshx_ptr_t pub)
	Set the publication structures.
void	set_gen_struct (meshx_ptr_t gen)
	Set the generic structures.
void	set_parent_element (meshXElementIF *parent)
	Set the parent element for this model.
meshXElementIF *	get_parent_element (void) const
	Get the parent element of this model.
void	set_parent_element_state (meshx_ptr_t state)
	Set the parent element state pointer.
meshx_ptr_t	get_parent_element_state (void) const
	Get the parent element state pointer.

Private Member Functions
meshx_err_t	plat_model_create (MESHX_MODEL *p_plat_model_ptr=nullptr) override
	Creates and initializes a server model instance for the Generic Battery Server.
meshx_err_t	plat_model_delete (void) override
	Deletes the Generic Battery Server model and its associated resources.

Private Attributes
meshx_gen_battery_model_state_t	model_state
meshx_battery_srv_el_msg_t	element_msg
bool	element_msg_prepared = false

Additional Inherited Members
Protected Member Functions inherited from meshXServerModel< meshXBaseGenericServerModel, meshx_gen_battery_send_params_t >
void	update_element_state_change_header (meshx_err_t element_state_change, meshx_ptr_t msg_ptr) override
	Update element_state_change field in server message header.

Detailed Description

A template class for creating Generic Battery Server models.

This class is derived from meshXServerModel and provides a convenient interface for creating Generic Battery Server models. It handles the Generic Battery state change notifications from the MeshX stack and publishes the state change event to the element layer.

Constructor & Destructor Documentation

meshXGenericBatteryServerModel()

meshXGenericBatteryServerModel::meshXGenericBatteryServerModel	(	meshXElementIF *	parent_element = nullptr,
		meshx_ptr_t	parent_element_state = nullptr,
		uint16_t	model_func_id = 0 )

Constructor for the Generic Battery Server Model.

Parameters

[in]	parent_element	Pointer to the parent element (meshXElementIF)
[in]	parent_element_state	Pointer to the parent element's state structure.
[in]	model_func_id	Functional ID for the model instance.

    : meshXServerModel(nullptr, MESHX_MODEL_ID_GEN_BATTERY_SRV, parent_element, parent_element_state, model_func_id)
{
    /* Note: plat_model_create() is now called explicitly during composition bake */
}

~meshXGenericBatteryServerModel()

meshXGenericBatteryServerModel::~meshXGenericBatteryServerModel ( )

default

Member Function Documentation

element_state_change_handle()

meshx_err_t meshXGenericBatteryServerModel::element_state_change_handle ( void )

overridevirtual

Handle state change request from element.

This function is called by the parent element when a state change request is received. It validates the request and returns a result to the element. Note: The actual state is maintained in the element layer, not the model layer.

Returns

• MESHX_SUCCESS: State change handled successfully
• MESHX_INVALID_ARG: Invalid parameter
• MESHX_INVALID_STATE: No state change detected

Implements meshXModelIF.

{
    auto *el_state =
        static_cast<meshx_gen_battery_model_state_t*>(this->get_parent_element_state());
 
    if (!el_state) {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Invalid parameter in element_state_change_handle");
        return MESHX_INVALID_ARG;
    }
 
    if(memcmp(&model_state, el_state, sizeof(meshx_gen_battery_model_state_t)) != 0)
    {
        MESHX_LOGI(MODULE_ID_MODEL_SERVER,
            "Battery state change request: level=%d discharge=%d charge=%d",
            el_state->battery_level, el_state->time_to_discharge, el_state->time_to_charge);
        // Update the model state
        *el_state = model_state;
    }
    else
    {
        return MESHX_INVALID_STATE;
    }
    return MESHX_SUCCESS;
}

model_from_ble_cb()

meshx_err_t meshXGenericBatteryServerModel::model_from_ble_cb ( dev_struct_t * p_dev, control_task_msg_evt_t model_id, meshx_ptr_t params )

overridevirtual

Callback function for handling BLE mesh events for the Generic Battery Server Model.

Parameters

[in]	p_dev	Pointer to the device structure
[in]	model_id	Model ID associated with the event
[in]	params	Pointer to the event parameters

Returns

MESHX_SUCCESS if successful, error code otherwise

Implements meshXModel< meshXBaseGenericServerModel, meshx_gen_battery_send_params_t >.

{
    if(!params || !p_dev)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Invalid parameters");
        return MESHX_INVALID_ARG;
    }
    if(model_id != MESHX_MODEL_ID_GEN_BATTERY_SRV)
    {
        /* Callback triggered not for this model */
        return MESHX_SUCCESS;
    }
 
    auto *param = static_cast<meshx_gen_srv_cb_param_t *>(params);
 
    // Store the message in member variable for later use by prepare_element_msg
    element_msg = {
        .header = {
            .model                  = param->model,
            .element_state_change   = MESHX_SUCCESS,
        },
        .state = {
            .battery_level       = param->state_change.battery_status.battery_level,
            .time_to_discharge   = param->state_change.battery_status.time_to_discharge,
            .time_to_charge      = param->state_change.battery_status.time_to_charge,
            .presence            = param->state_change.battery_status.presence,
            .charge_level        = param->state_change.battery_status.charge_level,
            .charge_type         = param->state_change.battery_status.charge_type,
        }
    };
 
    element_msg_prepared = true;
    return MESHX_SUCCESS;
}

model_send()

meshx_err_t meshXGenericBatteryServerModel::model_send ( meshx_gen_battery_send_params_t * params )

overridevirtual

Send a packet to the MeshX stack based on the given parameters.

This function takes a pointer to a meshx_gen_battery_send_params_t structure as input and sends the corresponding packet to the MeshX stack for processing.

Parameters

[in]

params

Pointer to the meshx_gen_battery_send_params_t structure containing the parameters

Returns

MESHX_SUCCESS on success, or an error code on failure

Implements meshXModel< meshXBaseGenericServerModel, meshx_gen_battery_send_params_t >.

{
    if (!params|| !params->model || !params->ctx)
    {
        return MESHX_INVALID_ARG;
    }
    params->ctx->opcode = MESHX_MODEL_OP_GEN_BATTERY_STATUS;
    // Battery server doesn't modify state directly - just responds with current status
    meshx_gen_srv_state_change_t state_change = {0}; // Empty state change for battery status
    meshx_gen_server_send_params_t send_params = {
        .p_model = params->model,
        .p_ctx = params->ctx,
        .state_change = state_change,
        .data_len = 0  // No state data for battery status response
    };
    return this->get_base_model()->plat_send_msg(&send_params);
}

plat_model_create()

meshx_err_t meshXGenericBatteryServerModel::plat_model_create ( MESHX_MODEL * p_plat_model_ptr = nullptr )

overrideprivatevirtual

Creates and initializes a server model instance for the Generic Battery Server.

This function handles the platform-specific model creation process for the Generic Battery Server models. It initializes server-specific features and cannot be overridden by derived classes.

Parameters

[in]

p_plat_model_ptr

Optional pointer to a pre-allocated platform model structure.

Returns

meshx_err_t Returns an error code indicating the result of the operation.

• MESHX_SUCCESS on successful model creation and initialization
• MESHX_ERR_NO_MEM if memory allocation fails
• Other error codes for platform-specific failures

Note

This is a final function and cannot be overridden by derived classes.

Implements meshXModelIF.

{
    if (p_plat_model_ptr) {
        this->set_plat_model(p_plat_model_ptr);
    }
 
    meshx_ptr_t p_pub = this->get_pub_struct();
    meshx_ptr_t p_gen = this->get_gen_struct();
    meshx_err_t err = MESHX_SUCCESS;
 
    // If already created, skip platform creation to avoid memory leaks
    if (p_pub != nullptr || p_gen != nullptr)
    {
        MESHX_MODEL* p_use = this->get_plat_model();
        if (p_use) {
            uint16_t model_id = MESHX_MODEL_ID_GEN_BATTERY_SRV;
            memcpy((void*)&p_use->model_id, &model_id, sizeof(model_id));
            memcpy((void*)&p_use->pub, &p_pub, sizeof(p_pub));
            memcpy((void*)&p_use->user_data, &p_gen, sizeof(p_gen));
        }
        return MESHX_SUCCESS;
    }
 
    err = meshx_plat_battery_gen_srv_create(this->get_plat_model(), &p_pub, &p_gen);
    if(err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to create Generic Battery Server Model");
    }
    else
    {
        /* Set the publication and generic structures */
        this->set_pub_struct(p_pub);
        this->set_gen_struct(p_gen);
    }
    return err;
}

plat_model_delete()

meshx_err_t meshXGenericBatteryServerModel::plat_model_delete ( void )

overrideprivatevirtual

Deletes the Generic Battery Server model and its associated resources.

This function frees the memory allocated for the Generic Battery Server and sets the pointer to NULL. It also deletes the model publication resources associated with the server.

Returns

• MESHX_SUCCESS: Model and publication deleted successfully.
• MESHX_FAIL: Failed to delete the model or publication.

Implements meshXModelIF.

{
    meshx_ptr_t p_pub = this->get_pub_struct();
    meshx_ptr_t p_gen = this->get_gen_struct();
 
    meshx_err_t err = meshx_plat_gen_srv_delete(&p_pub, &p_gen);
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to delete Generic Battery Server Model");
    }
    else
    {
        this->set_pub_struct(nullptr);
        this->set_gen_struct(nullptr);
    }
    return err;
}

prepare_element_msg()

meshx_err_t meshXGenericBatteryServerModel::prepare_element_msg ( meshx_ptr_t * msg_ptr, size_t * msg_size )

overridevirtual

Prepare message for element notification.

Returns pointer to the stored element message if it has been prepared

Parameters

[out]	msg_ptr	Pointer to message structure (output parameter)
[out]	msg_size	Size of the message structure (output parameter)

Returns

MESHX_SUCCESS if message prepared successfully, error code otherwise

Implements meshXModelIF.

{
    if (!msg_ptr || !msg_size)
    {
        return MESHX_INVALID_ARG;
    }
 
    if (!element_msg_prepared)
    {
        return MESHX_NOT_SUPPORTED;
    }
 
    *msg_ptr  = &element_msg;
    *msg_size = sizeof(element_msg);
 
    return MESHX_SUCCESS;
}

Field Documentation

element_msg

meshx_battery_srv_el_msg_t meshXGenericBatteryServerModel::element_msg

private

element_msg_prepared

bool meshXGenericBatteryServerModel::element_msg_prepared = false

private

model_state

meshx_gen_battery_model_state_t meshXGenericBatteryServerModel::model_state

private

---

The documentation for this class was generated from the following files:

• meshx_model_battery.hpp
• meshx_model_battery.cpp