meshXGenericPowerLevelSetupServerModel Class Reference

A template class for creating Generic Power Level Setup Server models. More...

#include <meshx_model_power_level.hpp>

Inheritance diagram for meshXGenericPowerLevelSetupServerModel:

Public Member Functions
meshx_err_t	model_send (meshx_gen_power_level_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 Generic Power Level Setup Server Model.
meshx_err_t	prepare_element_msg (meshx_ptr_t *msg_ptr, size_t *msg_size) override
	Prepare message for element notification.
	meshXGenericPowerLevelSetupServerModel (meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Constructor for Generic Power Level Setup Server Model.
	~meshXGenericPowerLevelSetupServerModel ()=default
Public Member Functions inherited from meshXServerModel< meshXBaseGenericServerModel, meshx_gen_power_level_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_power_level_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
virtual meshx_err_t	plat_model_create (MESHX_MODEL *p_plat_model_ptr=nullptr)=0
	Create logical model instance.
virtual meshx_err_t	plat_model_delete (void)=0
	Delete logical model instance.
virtual meshx_err_t	element_state_change_handle (void)=0
	Handle state change request from element.
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 Attributes
meshx_power_level_srv_el_msg_t	element_msg
bool	element_msg_prepared = false

Additional Inherited Members
Protected Member Functions inherited from meshXServerModel< meshXBaseGenericServerModel, meshx_gen_power_level_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 Power Level Setup Server models.

This class is derived from meshXServerModel and provides a convenient interface for creating Generic Power Level Setup Server models. It handles the Generic Power Level setup operations from the MeshX stack.

Constructor & Destructor Documentation

meshXGenericPowerLevelSetupServerModel()

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

Constructor for Generic Power Level Setup 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_POWER_LEVEL_SETUP_SRV, parent_element, parent_element_state, model_func_id)
{}

~meshXGenericPowerLevelSetupServerModel()

meshXGenericPowerLevelSetupServerModel::~meshXGenericPowerLevelSetupServerModel ( )

default

Member Function Documentation

model_from_ble_cb()

meshx_err_t meshXGenericPowerLevelSetupServerModel::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 Generic Power Level Setup 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_power_level_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_POWER_LEVEL_SETUP_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 = {
            .present_power  = 0,
            .target_power   = 0,
            .remain_time    = 0,
            .power_default  = param->state_change.power_default_set.power,
            .range = {
                .range_min = param->state_change.power_range_set.range_min,
                .range_max = param->state_change.power_range_set.range_max
            }
        }
    };
 
    element_msg_prepared = true;
    return MESHX_SUCCESS;
}

model_send()

meshx_err_t meshXGenericPowerLevelSetupServerModel::model_send ( meshx_gen_power_level_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_power_level_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_power_level_send_params_t structure containing the parameters

Returns

MESHX_SUCCESS on success, or an error code on failure

Implements meshXModel< meshXBaseGenericServerModel, meshx_gen_power_level_send_params_t >.

{
if (!params|| !params->model || !params->ctx)
    {
        return MESHX_INVALID_ARG;
    }
    params->ctx->opcode = MESHX_MODEL_OP_GEN_POWER_LEVEL_STATUS;
    meshx_gen_srv_state_change_t state_change = {
        .power_level_set = {
            .power = params->power_level
        }
    };
    meshx_gen_server_send_params_t send_params = {
        .p_model        = params->model,
        .p_ctx          = params->ctx,
        .state_change   = state_change,
        .data_len       = sizeof(meshx_state_change_gen_power_level_set_t)
    };
    return this->get_base_model()->plat_send_msg(&send_params);
}

prepare_element_msg()

meshx_err_t meshXGenericPowerLevelSetupServerModel::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_power_level_srv_el_msg_t meshXGenericPowerLevelSetupServerModel::element_msg

private

element_msg_prepared

bool meshXGenericPowerLevelSetupServerModel::element_msg_prepared = false

private

---

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

• meshx_model_power_level.hpp
• meshx_model_power_level.cpp