meshXLightHSLServerModel Class Reference

A template class for creating Light HSL Server models. More...

#include <meshx_model_hsl.hpp>

Inheritance diagram for meshXLightHSLServerModel:

Public Member Functions
meshx_err_t	model_send (meshx_light_hsl_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
	This function is the callback for the Light HSL Server model.
meshx_err_t	request_status (uint16_t dst_addr=0)
	meshXLightHSLServerModel (meshXElementIF *parent_element=nullptr, meshx_ptr_t parent_element_state=nullptr, uint16_t model_func_id=0)
	Constructor for Light HSL Server Model.
	~meshXLightHSLServerModel ()=default
Public Member Functions inherited from meshXServerModel< meshXBaseLightServerModel, meshx_light_hsl_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< meshXBaseLightServerModel, meshx_light_hsl_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.
meshXBaseLightServerModel *	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.
meshx_err_t	plat_model_delete (void) override
	Deletes the Light HSL Server model and its associated resources.
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
	Handle state change request from element.

Private Attributes
meshx_light_hsl_model_state_t	model_state
meshx_light_hsl_srv_el_msg_t	element_msg
bool	element_msg_prepared

Additional Inherited Members
Protected Member Functions inherited from meshXServerModel< meshXBaseLightServerModel, meshx_light_hsl_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 Light HSL Server models.

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

Constructor & Destructor Documentation

meshXLightHSLServerModel()

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

Constructor for Light HSL 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_LIGHT_HSL_SRV, parent_element, parent_element_state, model_func_id),
      element_msg_prepared(false)
{
}

~meshXLightHSLServerModel()

meshXLightHSLServerModel::~meshXLightHSLServerModel ( )

default

Member Function Documentation

element_state_change_handle()

meshx_err_t meshXLightHSLServerModel::element_state_change_handle ( void )

overrideprivatevirtual

Handle state change request from element.

Pure virtual function that derived classes must implement to handle state change requests from the parent element. The model validates the request, updates its internal state, and returns the result.

Returns

MESHX_SUCCESS on success, error code otherwise

Implements meshXModelIF.

{
    auto *el_state =
        static_cast<meshx_light_hsl_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_light_hsl_model_state_t)) != 0)
    {
        MESHX_LOGI(MODULE_ID_MODEL_SERVER,
            "HSL state change request: hue=%d lightness=%d saturation=%d",
            el_state->hue, el_state->lightness, el_state->saturation);
        // Update the model state
        *el_state = model_state;
    }
    else
    {
        return MESHX_INVALID_STATE;
    }
    return MESHX_SUCCESS;
}

model_from_ble_cb()

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

overridevirtual

This function is the callback for the Light HSL Server model.

This function is triggered whenever a Light HSL message is received from the MeshX stack. It handles the Light HSL state change notifications from the MeshX stack and publishes the state change event to the element layer.

Parameters

[in]	p_dev	A pointer to the device structure.
[in]	model_id	The unique identifier of the BLE mesh model.
[in]	params	A pointer to the callback parameter structure containing the details of the received message.

Returns

• MESHX_SUCCESS: Success
• MESHX_INVALID_ARG: Invalid argument
• MESHX_FAIL: Other failures

Implements meshXModel< meshXBaseLightServerModel, meshx_light_hsl_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_LIGHT_HSL_SRV)
    {
        /* Callback triggered not for this model */
        return MESHX_SUCCESS;
    }
 
    auto *param = static_cast<meshx_lighting_server_cb_param_t *>(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);
 
    model_state.lightness = param->state_change.hsl_set.lightness;
    model_state.hue = param->state_change.hsl_set.hue;
    model_state.saturation = param->state_change.hsl_set.saturation;
 
    // Initialize flag - message not prepared yet
    element_msg_prepared = false;
 
    bool send_reply = (param->ctx.opcode != MESHX_MODEL_OP_LIGHT_HSL_SET_UNACK &&
                       param->ctx.opcode != MESHX_MODEL_OP_LIGHT_HSL_HUE_SET_UNACK &&
                       param->ctx.opcode != MESHX_MODEL_OP_LIGHT_HSL_SATURATION_SET_UNACK);
 
    switch (param->ctx.opcode)
    {
        case MESHX_MODEL_OP_LIGHT_HSL_GET:
        case MESHX_MODEL_OP_LIGHT_HSL_TARGET_GET:
        case MESHX_MODEL_OP_LIGHT_HSL_DEFAULT_GET:
        case MESHX_MODEL_OP_LIGHT_HSL_RANGE_GET:
        case MESHX_MODEL_OP_LIGHT_HSL_HUE_GET:
        case MESHX_MODEL_OP_LIGHT_HSL_SATURATION_GET:
            break;
        case MESHX_MODEL_OP_LIGHT_HSL_SET:
        case MESHX_MODEL_OP_LIGHT_HSL_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_HSL_HUE_SET:
        case MESHX_MODEL_OP_LIGHT_HSL_HUE_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_HSL_SATURATION_SET:
        case MESHX_MODEL_OP_LIGHT_HSL_SATURATION_SET_UNACK:
        {
            if (MESHX_ADDR_IS_UNICAST(param->ctx.dst_addr)
            || (MESHX_ADDR_BROADCAST(param->ctx.dst_addr))
            || (MESHX_ADDR_IS_GROUP(param->ctx.dst_addr)
            && (MESHX_SUCCESS == meshx_is_group_subscribed(&param->model, param->ctx.dst_addr))))
            {
                // Prepare the message (store in member variable)
                element_msg.header.model = param->model;
                element_msg.header.element_state_change = MESHX_SUCCESS; // Will be set by base layer
                element_msg.state = model_state;
                element_msg_prepared = true;
            }
            break;
        }
        case MESHX_MODEL_OP_LIGHT_HSL_DEFAULT_SET:
        case MESHX_MODEL_OP_LIGHT_HSL_DEFAULT_SET_UNACK:
        case MESHX_MODEL_OP_LIGHT_HSL_RANGE_SET:
        case MESHX_MODEL_OP_LIGHT_HSL_RANGE_SET_UNACK:
            // Handle default and range operations
            break;
        default:
            break;
    }
    if (send_reply
        /* This is meant to notify the respective publish client */
        || param->ctx.src_addr != param->model.pub_addr)
    {
        /* Here the message was received from unregistered source and mention the state to the respective client */
        MESHX_LOGD(MODULE_ID_MODEL_SERVER, "PUB: src|pub %x|%x", param->ctx.src_addr, param->model.pub_addr);
        param->ctx.dst_addr = param->model.pub_addr;
 
        // Create a parameter structure for sending the response
        meshx_light_hsl_send_params_t send_params = {
            .model = &param->model,
            .ctx = &param->ctx,
            .tid = 0,
            .state = {
                .lightness = param->state_change.hsl_set.lightness,
                .hue = param->state_change.hsl_set.hue,
                .saturation = param->state_change.hsl_set.saturation,
                .target_lightness = 0,
                .target_hue = 0,
                .target_saturation = 0,
                .hue_range_min = 0,
                .hue_range_max = 0,
                .sat_range_min = 0,
                .sat_range_max = 0
            }
        };
 
        return this->model_send(&send_params);
    }
 
    // If we reach here, message was not prepared for element notification
    // Return error so base layer doesn't send uninitialized message
    if (!element_msg_prepared)
    {
        MESHX_LOGD(MODULE_ID_MODEL_SERVER, "No element notification needed for opcode: %04x", param->ctx.opcode);
        return MESHX_NOT_SUPPORTED;
    }
 
    return MESHX_SUCCESS;
}

model_send()

meshx_err_t meshXLightHSLServerModel::model_send ( meshx_light_hsl_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_light_hsl_send_params_t structure as input and sends the corresponding packet to the MeshX stack for processing.

Parameters

[in]

params

Pointer to the meshx_light_hsl_send_params_t structure containing the parameters

Returns

MESHX_SUCCESS on success, or an error code on failure

Implements meshXModel< meshXBaseLightServerModel, meshx_light_hsl_send_params_t >.

{
    if (!params || !params->model || !params->ctx)
    {
        return MESHX_INVALID_ARG;
    }
    params->ctx->opcode = MESHX_MODEL_OP_LIGHT_HSL_STATUS;
    meshx_lighting_server_state_change_t state_change = {
        .hsl_set = {
            .lightness = params->state.lightness,
            .hue = params->state.hue,
            .saturation = params->state.saturation
        }
    };
    meshx_light_server_send_params_t send_params = {
        .p_model = params->model,
        .p_ctx = params->ctx,
        .state_change = &state_change
    };
    return this->get_base_model()->plat_send_msg(&send_params);
}

plat_model_create()

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

overrideprivatevirtual

Creates and initializes a server model instance.

This function handles the platform-specific model creation process for 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;
 
    err = meshx_plat_light_hsl_srv_create( this->get_plat_model(), &p_pub, &p_gen );
    if(err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to create Light HSL 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 meshXLightHSLServerModel::plat_model_delete ( void )

overrideprivatevirtual

Deletes the Light HSL Server model and its associated resources.

This function frees the memory allocated for the Light HSL 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_light_srv_delete( &p_pub, &p_gen );
    if (err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Failed to delete Light HSL Server Model");
    }
    else
    {
        /* Set the publication and generic structures to NULL */
        this->set_pub_struct(nullptr);
        this->set_gen_struct(nullptr);
    }
 
    return err;
}

prepare_element_msg()

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

overrideprivatevirtual

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.

{
    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;
}

request_status()

meshx_err_t meshXLightHSLServerModel::request_status

(

uint16_t

dst_addr = 0

)

{
    auto *el_state = static_cast<meshx_light_hsl_model_state_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_LIGHT_HSL_STATUS,
        .src_addr = 0,
        .dst_addr = (dst_addr == 0) ? common_ctx->pub_addr : dst_addr,
        .p_ctx    = nullptr
    };
 
    meshx_light_hsl_send_params_t sp = {
        .model = &model_ref,
        .ctx   = &ctx,
        .tid   = 0,
        .state = *el_state
    };
 
    return this->model_send(&sp);
}

Field Documentation

element_msg

meshx_light_hsl_srv_el_msg_t meshXLightHSLServerModel::element_msg

private

element_msg_prepared

bool meshXLightHSLServerModel::element_msg_prepared

private

model_state

meshx_light_hsl_model_state_t meshXLightHSLServerModel::model_state

private

---

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

• meshx_model_hsl.hpp
• meshx_model_hsl.cpp