meshXBaseLightServerModel Class Reference

Implementation of meshXBaseServerModel for Light BLE mesh models. More...

#include <meshx_base_model_light.hpp>

Inheritance diagram for meshXBaseLightServerModel:

Public Member Functions
meshx_err_t	plat_model_init (void) override
	Initialization function for the Light Server model.
meshx_err_t	validate_server_status_opcode (uint16_t opcode) override
	Validate a light server status opcode.
meshx_err_t	server_state_restore (meshx_light_server_restore_params_t *param) override
	Restores the state of the Light Server model.
meshx_err_t	plat_send_msg (meshx_light_server_send_params_t *params) override
	Sends a status message for the Light Server model.
	meshXBaseLightServerModel (uint32_t model_id, meshx_ptr_t p_plat_model, const control_msg_cb &from_ble_cb)
	Constructor for the meshXBaseLightServerModel class.
	meshXBaseLightServerModel ()=delete
	~meshXBaseLightServerModel () final=default
Public Member Functions inherited from meshXBaseServerModel< meshXBaseLightServerModel, meshx_light_server_send_params_t, meshx_light_server_restore_params_t, meshx_lighting_server_cb_param_t >
	meshXBaseServerModel ()=delete
virtual	~meshXBaseServerModel ()=default
meshx_err_t	from_ble_dereg_cb (void) const override
	Deregister BLE message callback for this model.
void	set_plat_model_ptr (meshx_ptr_t p_model)
	Set the platform model pointer and update the registration list.
Public Member Functions inherited from meshXBaseModel< meshx_light_server_send_params_t >
meshx_err_t	from_ble_reg_cb (void) const
	Register BLE message callback for this model.
meshx_err_t	get_status (void) const
	Get the current status of the model.
uint32_t	get_model_id (void) const
	Get the model identifier.
control_task_msg_handle_t	get_from_ble_cb (void) const
	Get the BLE message callback function.
meshXBaseModelType_t	get_model_type (void) const
	Get the model type (server/client).
void	set_status (meshx_err_t err)
	Set the model status.
void	set_model_id (uint32_t id)
	Set the model identifier.
void	set_from_ble_cb (control_task_msg_handle_t cb)
	Set the BLE message callback function.
void	set_model_type (meshXBaseModelType_t type)
	Set the model type.
	meshXBaseModel (uint32_t model_id, control_task_msg_handle_t from_ble_cb, meshXBaseModelType_t model_type)
	Construct a new meshXBaseModel object.
virtual	~meshXBaseModel ()
	Virtual destructor for meshXBaseModel.

Additional Inherited Members
Static Protected Member Functions inherited from meshXBaseServerModel< meshXBaseLightServerModel, meshx_light_server_send_params_t, meshx_light_server_restore_params_t, meshx_lighting_server_cb_param_t >
static meshx_err_t	base_from_ble_msg_handle (dev_struct_t *pdev, control_task_msg_evt_t evt, meshx_ptr_t params)
	Sends a BLE message from a server model.
Protected Attributes inherited from meshXBaseServerModel< meshXBaseLightServerModel, meshx_light_server_send_params_t, meshx_light_server_restore_params_t, meshx_lighting_server_cb_param_t >
meshx_ptr_t	p_plat_model
Protected Attributes inherited from meshXBaseModel< meshx_light_server_send_params_t >
uint32_t	model_id
meshXBaseModelType_t	model_type
control_task_msg_handle_t	from_ble_cb
meshx_err_t	status
Static Protected Attributes inherited from meshXBaseServerModel< meshXBaseLightServerModel, meshx_light_server_send_params_t, meshx_light_server_restore_params_t, meshx_lighting_server_cb_param_t >
static std::once_flag	plat_server_init_flag
static std::forward_list< base_server_model_cb_reg_t >	base_server_model_cb_list

Detailed Description

Implementation of meshXBaseServerModel for Light BLE mesh models.

This class provides a concrete implementation of the template-based meshXBaseServerModel specifically designed for Light BLE mesh server models. It inherits all the template benefits including type safety, static callback dispatching, and enhanced debugging while providing Light-specific functionality.

Key Features:

• Inherits template-based architecture from meshXBaseServerModel
• Provides Light-specific opcode validation and message handling
• Implements platform-specific message sending for Light models
• Supports all Light server model types (Lightness, CTL, HSL, XYL, LC)
• Enhanced error handling and debugging with template type identification

Supported Operations:

• Light Lightness status operations
• Light CTL status operations
• Light HSL status operations
• Light XYL status operations
• Light LC (Light Control) status operations

See also

meshXBaseServerModel for base template functionality.

meshx_light_server_send_params_t for send parameter structure.

Constructor & Destructor Documentation

meshXBaseLightServerModel() [1/2]

meshXBaseLightServerModel::meshXBaseLightServerModel	(	uint32_t	model_id,
		meshx_ptr_t	p_plat_model,
		const control_msg_cb &	from_ble_cb )

Constructor for the meshXBaseLightServerModel class.

Parameters

[in]	model_id	The unique identifier for the Light Server model.
[in]	p_plat_model	Pointer to the platform-specific model structure.
[in]	from_ble_cb	Callback function for handling incoming BLE messages.

    : meshXBaseServerModel(model_id, p_plat_model, from_ble_cb)
{
    set_status(meshXBaseLightServerModel::plat_model_init());
    if (get_status() != MESHX_SUCCESS)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "plat_model_init failed");
        return;
    }
}

meshXBaseLightServerModel() [2/2]

meshXBaseLightServerModel::meshXBaseLightServerModel ( )

delete

~meshXBaseLightServerModel()

meshXBaseLightServerModel::~meshXBaseLightServerModel ( )

finaldefault

Member Function Documentation

plat_model_init()

meshx_err_t meshXBaseLightServerModel::plat_model_init ( void )

overridevirtual

Initialization function for the Light Server model.

This function is responsible for initializing the Light Server model. It checks if the model has been initialized before, and if not, it calls the platform specific initialization function.

Returns

meshx_err_t containing the result of the initialization operation.

Implements meshXBaseModel< meshx_light_server_send_params_t >.

{
    meshx_err_t err = MESHX_SUCCESS;
    std::call_once(plat_server_init_flag, [&]() {
        err = meshx_plat_light_srv_init();
    });
    return err;
}

plat_send_msg()

meshx_err_t meshXBaseLightServerModel::plat_send_msg ( meshx_light_server_send_params_t * params )

overridevirtual

Sends a status message for the Light Server model.

This function sends a status message for the Light Server model to the BLE Mesh network. It checks if the provided model and context are valid, and if the opcode is within the range of supported Light Server opcodes.

Parameters

[in]

params

Pointer to the Light Server sending params

Returns

• MESHX_SUCCESS: Successfully sent the status message.
• MESHX_INVALID_ARG: Invalid argument provided.
• MESHX_ERR_PLAT: Platform-specific error occurred.

Implements meshXBaseModel< meshx_light_server_send_params_t >.

{
    if (!params || !params->p_model || !params->p_ctx || params->p_ctx->dst_addr == MESHX_ADDR_UNASSIGNED)
    {
        return MESHX_INVALID_ARG;
    }
    if (validate_server_status_opcode((uint16_t)params->p_ctx->opcode) != MESHX_SUCCESS)
    {
        return MESHX_INVALID_ARG;
    }
 
    return meshx_plat_gen_light_srv_send_status(
        params->p_model,
        params->p_ctx,
        params->state_change
    );
}

server_state_restore()

meshx_err_t meshXBaseLightServerModel::server_state_restore ( meshx_light_server_restore_params_t * param )

overridevirtual

Restores the state of the Light Server model.

This function restores the state of the Light Server model using the provided restore parameters. It validates the model ID and state type before calling the platform-specific function to set the server state.

Parameters

[in]

param

Pointer to the structure containing the restore parameters.

Returns

meshx_err_t containing the result of the restore operation.

• MESHX_SUCCESS: State restored successfully
• MESHX_INVALID_ARG: Invalid parameters provided
• MESHX_NOT_SUPPORTED: Model ID not supported
• MESHX_INVALID_STATE: Invalid or unrecognized state

Implements meshXBaseServerModel< meshXBaseLightServerModel, meshx_light_server_send_params_t, meshx_light_server_restore_params_t, meshx_lighting_server_cb_param_t >.

{
    if (!param || !param->p_model)
    {
        return MESHX_INVALID_ARG;
    }
 
    uint16_t state_len = 0;
 
    // Determine the model ID and handle each state type
    switch (this->get_model_id())
    {
        // Light Lightness Server Model (0x1300)
        case MESHX_MODEL_ID_LIGHT_LIGHTNESS_SRV:
            state_len = sizeof(meshx_light_lightness_state_t);
            break;
        case MESHX_MODEL_ID_LIGHT_CTL_SRV:
        case MESHX_MODEL_ID_LIGHT_CTL_SETUP_SRV:
            state_len = sizeof(meshx_light_ctl_state_t);
            break;
        case MESHX_MODEL_ID_LIGHT_HSL_SRV:
        case MESHX_MODEL_ID_LIGHT_HSL_SETUP_SRV:
            state_len = sizeof(meshx_light_hsl_state_t);
            break;
        case MESHX_MODEL_ID_LIGHT_XYL_SRV:
        case MESHX_MODEL_ID_LIGHT_XYL_SETUP_SRV:
            state_len = sizeof(meshx_light_xyl_state_t);
            break;
        case MESHX_MODEL_ID_LIGHT_LC_SRV:
            state_len = sizeof(meshx_light_lc_state_t);
            break;
        default:
            return MESHX_NOT_SUPPORTED;
    }
 
    if (state_len == 0)
    {
        return MESHX_INVALID_STATE;
    }
 
    return meshx_plat_light_srv_restore(param->p_model, &param->state_change, state_len);
}

validate_server_status_opcode()

meshx_err_t meshXBaseLightServerModel::validate_server_status_opcode ( uint16_t opcode )

overridevirtual

Validate a light server status opcode.

This function determines whether the provided opcode corresponds to a status message in the Light Server group in the MeshX protocol.

Parameters

[in]

opcode

The opcode to validate.

Returns

meshx_err_t containing the result of the validation operation. Returns MESHX_SUCCESS if the opcode is valid, or an error code otherwise.

Implements meshXBaseServerModel< meshXBaseLightServerModel, meshx_light_server_send_params_t, meshx_light_server_restore_params_t, meshx_lighting_server_cb_param_t >.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_STATUS:
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_LINEAR_STATUS:
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_LAST_STATUS:
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_DEFAULT_STATUS:
        case MESHX_MODEL_OP_LIGHT_LIGHTNESS_RANGE_STATUS:
        case MESHX_MODEL_OP_LIGHT_CTL_STATUS:
        case MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_STATUS:
        case MESHX_MODEL_OP_LIGHT_CTL_TEMPERATURE_RANGE_STATUS:
        case MESHX_MODEL_OP_LIGHT_CTL_DEFAULT_STATUS:
        case MESHX_MODEL_OP_LIGHT_HSL_STATUS:
        case MESHX_MODEL_OP_LIGHT_HSL_HUE_STATUS:
        case MESHX_MODEL_OP_LIGHT_HSL_SATURATION_STATUS:
        case MESHX_MODEL_OP_LIGHT_HSL_DEFAULT_STATUS:
        case MESHX_MODEL_OP_LIGHT_HSL_RANGE_STATUS:
        case MESHX_MODEL_OP_LIGHT_XYL_STATUS:
        case MESHX_MODEL_OP_LIGHT_XYL_TARGET_STATUS:
        case MESHX_MODEL_OP_LIGHT_XYL_DEFAULT_STATUS:
        case MESHX_MODEL_OP_LIGHT_XYL_RANGE_STATUS:
        case MESHX_MODEL_OP_LIGHT_LC_MODE_STATUS:
        case MESHX_MODEL_OP_LIGHT_LC_OM_STATUS:
        case MESHX_MODEL_OP_LIGHT_LC_LIGHT_ONOFF_STATUS:
        case MESHX_MODEL_OP_LIGHT_LC_PROPERTY_STATUS:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

---

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

• meshx_base_model_light.hpp
• meshx_base_model_light.cpp