meshXSensorServerModel Class Reference

A template class for creating Sensor Server models. More...

#include <meshx_model_sensor.hpp>

Inheritance diagram for meshXSensorServerModel:

Public Member Functions
meshx_err_t	model_send (meshx_sensor_server_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 for the Sensor Server model.
meshx_err_t	request_status (void)
	meshXSensorServerModel (meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Constructor for Sensor Server Model.
	~meshXSensorServerModel () override=default
meshx_sensor_server_state_change_t *	get_state_ptr ()
Public Member Functions inherited from meshXServerModel< meshXBaseSensorServerModel, meshx_sensor_server_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< meshXBaseSensorServerModel, meshx_sensor_server_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.
meshXBaseSensorServerModel *	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
	Create platform-specific sensor model instance.CONFIG_ENABLE_SENSOR_SERVER.
meshx_err_t	plat_model_delete (void) override
	Delete platform-specific sensor model instance.
meshx_err_t	element_state_change_handle (void) override
	Handle state change request from element.
meshx_err_t	prepare_element_msg (meshx_ptr_t *msg_ptr, size_t *msg_size) override
	Prepare element message for sensor server.

Private Attributes
meshx_sensor_server_state_change_t	model_state
meshx_sensor_srv_el_msg_t	element_msg

Additional Inherited Members
Protected Member Functions inherited from meshXServerModel< meshXBaseSensorServerModel, meshx_sensor_server_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 Sensor Server models.

Constructor & Destructor Documentation

meshXSensorServerModel()

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

Constructor for Sensor 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_SENSOR_SRV, parent_element, parent_element_state, model_func_id)
{
}

~meshXSensorServerModel()

meshXSensorServerModel::~meshXSensorServerModel ( )

overridedefault

Member Function Documentation

element_state_change_handle()

meshx_err_t meshXSensorServerModel::element_state_change_handle ( void )

overrideprivatevirtual

Handle state change request from element.

Implements meshXModelIF.

{
    // For sensor server, state change from element might mean "new data available to publish"
    return MESHX_SUCCESS;
}

get_state_ptr()

meshx_sensor_server_state_change_t * meshXSensorServerModel::get_state_ptr ( )

inline

{ return &model_state; }

model_from_ble_cb()

meshx_err_t meshXSensorServerModel::model_from_ble_cb ( dev_struct_t * p_dev, control_task_msg_evt_t evt, meshx_ptr_t p_params )

overridevirtual

Callback for the Sensor Server model.

Implements meshXModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t >.

{
    if(!p_params || !p_dev)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Invalid parameters");
        return MESHX_INVALID_ARG;
    }
    if (evt != CONTROL_TASK_MSG_EVT_TO_BLE_SENSOR_SRV &&
        evt != MESHX_MODEL_ID_SENSOR_SRV)
    {
        /* Callback triggered not for this model */
        return MESHX_SUCCESS;
    }
 
    auto *param = static_cast<meshx_sensor_server_cb_param_t *>(p_params);
 
    MESHX_LOGD(MODULE_ID_MODEL_SERVER, "op|src|dst:%04" PRIx32 "|%04x|%04x",
               param->ctx.opcode, param->ctx.src_addr, param->ctx.dst_addr);
 
    /* Update element message */
    element_msg = {
        .header = {
            .model = param->model,
            .element_state_change = MESHX_SUCCESS,
        },
        .state = param->state
    };
 
    if (this->get_parent_element())
    {
        return this->get_parent_element()->on_model_cb(&element_msg, sizeof(element_msg));
    }
 
    return MESHX_SUCCESS;
}

model_send()

meshx_err_t meshXSensorServerModel::model_send ( meshx_sensor_server_send_params_t * params )

overridevirtual

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

Implements meshXModel< meshXBaseSensorServerModel, meshx_sensor_server_send_params_t >.

{
    if (!params || !params->model || !params->ctx)
    {
        return MESHX_INVALID_ARG;
    }
    params->ctx->opcode = MESHX_MODEL_OP_SENSOR_STATUS;
 
    return this->get_base_model()->plat_send_msg(params);
}

plat_model_create()

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

overrideprivatevirtual

Create platform-specific sensor model instance.CONFIG_ENABLE_SENSOR_SERVER.

Implements meshXModelIF.

{
    meshx_ptr_t p_pub = nullptr;
    meshx_ptr_t p_srv = nullptr;
 
    if (p_plat_model_ptr) {
        this->set_plat_model(p_plat_model_ptr);
    }
 
    meshx_err_t err = meshx_plat_sensor_srv_create((meshx_model_t*)this->get_plat_model(), &p_pub, &p_srv);
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to create Sensor Server Model");
        return err;
    }
 
    this->set_pub_struct(p_pub);
    return MESHX_SUCCESS;
}

plat_model_delete()

meshx_err_t meshXSensorServerModel::plat_model_delete ( void )

overrideprivatevirtual

Delete platform-specific sensor model instance.

Implements meshXModelIF.

{
    meshx_ptr_t p_pub = this->get_pub_struct();
 
    meshx_err_t err = meshx_plat_sensor_srv_delete(&p_pub);
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to delete Sensor Server Model");
    }
    else
    {
        this->set_pub_struct(nullptr);
    }
 
    return err;
}

prepare_element_msg()

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

overrideprivatevirtual

Prepare element message for sensor server.

Implements meshXModelIF.

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

request_status()

meshx_err_t meshXSensorServerModel::request_status

(

void

)

{
    auto *el_state = static_cast<meshx_sensor_srv_status_t*>(this->get_parent_element_state());
    auto *el = this->get_parent_element();
    if (!el || !el_state) return MESHX_INVALID_STATE;
 
    auto *common_ctx = static_cast<meshx_element_common_ctx_t*>(el->get_element_ctx());
    if (!common_ctx) return MESHX_INVALID_STATE;
 
    meshx_model_t model_ref = {
        .el_id    = el->get_element_idx(),
        .model_id = (uint16_t)this->get_model_id(),
        .pub_addr = common_ctx->pub_addr,
        .p_model  = (MESHX_MODEL*)this->get_plat_model()
    };
 
    meshx_ctx_t ctx = {
        .app_idx  = common_ctx->app_id,
        .net_idx  = meshx_get_net_key_id(),
        .opcode   = MESHX_MODEL_OP_SENSOR_STATUS,
        .src_addr = 0,
        .dst_addr = common_ctx->pub_addr,
        .p_ctx    = nullptr
    };
 
    meshx_sensor_server_send_params_t sp = {
        .model = &model_ref,
        .ctx   = &ctx,
        .state = {
            .sensor_status = *el_state
        }
    };
 
    return this->model_send(&sp);
}

Field Documentation

element_msg

meshx_sensor_srv_el_msg_t meshXSensorServerModel::element_msg

private

model_state

meshx_sensor_server_state_change_t meshXSensorServerModel::model_state

private

---

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

• meshx_model_sensor.hpp
• meshx_model_sensor.cpp