meshXBaseGenericClientModel Class Reference

Template specialization of meshXBaseClientModel for Generic BLE mesh models. More...

#include <meshx_base_model_generic.hpp>

Inheritance diagram for meshXBaseGenericClientModel:

Public Member Functions
meshx_err_t	plat_model_init (void) override
	Initialization function for the Generic OnOff Client model.
meshx_err_t	validate_client_model_id (uint32_t model_id) override
	Validates if the given model ID corresponds to a supported Generic Client model.
meshx_err_t	plat_send_msg (meshx_gen_client_send_params_t *params) override
	Send a message using the generic client model.
	meshXBaseGenericClientModel ()=delete
	meshXBaseGenericClientModel (uint32_t model_id, meshx_ptr_t p_plat_model, const control_msg_cb &from_ble_cb)
	Constructor for the meshXBaseGenericClientModel class.
virtual	~meshXBaseGenericClientModel ()=default
Public Member Functions inherited from meshXBaseClientModel< meshXBaseGenericClientModel, meshx_gen_client_send_params_t, meshx_gen_cli_cb_param_t >
	meshXBaseClientModel ()=delete
	~meshXBaseClientModel ()=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_gen_client_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.

Static Public Member Functions
static meshx_err_t	meshx_is_unack_opcode (uint32_t opcode)
	Validates if a given opcode corresponds to an unacknowledged (SET_UNACK) message.
static meshx_err_t	meshx_is_get_req_opcode (uint16_t opcode)
	Checks if a given opcode is a GET request opcode.
static meshx_err_t	meshx_gen_client_txcm_fn_model_send (meshx_gen_client_msg_ctx_t *msg_param, size_t msg_param_len)
	Send a message using the generic client model.

Additional Inherited Members
Static Protected Member Functions inherited from meshXBaseClientModel< meshXBaseGenericClientModel, meshx_gen_client_send_params_t, meshx_gen_cli_cb_param_t >
static constexpr const char *	get_client_type_name ()
static meshx_err_t	base_txcm_handle_ack (uint16_t src_addr)
	Resend an acknowledgement message for the given source address.
static meshx_err_t	base_txcm_handle_resend (uint16_t model_id, const meshx_gen_cli_cb_param_t *param)
	Resend a message for the given model ID and parameter.
static meshx_err_t	base_from_ble_msg_handle (dev_struct_t *pdev, control_task_msg_evt_t evt, meshx_ptr_t params)
	Template-based static message handler for BLE Mesh Generic Client models.
static meshx_err_t	base_handle_txcm_msg (dev_struct_t *pdev, control_task_msg_evt_t evt, base_client_model_resend_ctx_t *param)
	Template-based TXCM (Transmission Control Module) message handler for timeout scenarios.
Protected Attributes inherited from meshXBaseClientModel< meshXBaseGenericClientModel, meshx_gen_client_send_params_t, meshx_gen_cli_cb_param_t >
meshx_ptr_t	p_plat_model
Protected Attributes inherited from meshXBaseModel< meshx_gen_client_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 meshXBaseClientModel< meshXBaseGenericClientModel, meshx_gen_client_send_params_t, meshx_gen_cli_cb_param_t >
static std::once_flag	plat_client_init_flag
static std::forward_list< base_client_model_cb_reg_t >	base_client_model_cb_list

Detailed Description

Template specialization of meshXBaseClientModel for Generic BLE mesh models.

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

Key Features:

• Inherits template-based architecture from meshXBaseClientModel
• Provides Generic-specific opcode validation and message handling
• Implements platform-specific message sending via TXCM integration
• Supports all Generic model types (OnOff, Level, Power, Battery, Location)
• Enhanced error handling and debugging with template type identification
• Static wrapper functions for C-style callback compatibility

Template Parameters:

• baseClientModelDerived_t: meshXBaseGenericClientModel (CRTP pattern)
• ble_mesh_plat_model_cb_params_t: meshx_gen_cli_cb_param_t
• ble_mesh_send_msg_params_t: meshx_gen_client_send_params_t

Supported Operations:

• Generic OnOff SET/GET operations
• Generic Level SET/GET operations
• Generic Power Level operations
• Generic Battery status operations
• Generic Location operations
• Property-based operations (Manufacturer, Admin, User)

Note

This class uses private inheritance to maintain encapsulation while providing access to base functionality through friendship.

See also

meshXBaseClientModel for base template functionality.

meshx_gen_cli_cb_param_t for callback parameter structure.

meshx_gen_client_send_params_t for send parameter structure.

Constructor & Destructor Documentation

meshXBaseGenericClientModel() [1/2]

meshXBaseGenericClientModel::meshXBaseGenericClientModel ( )

delete

meshXBaseGenericClientModel() [2/2]

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

Constructor for the meshXBaseGenericClientModel class.

Parameters

[in]	model_id	The model ID associated with the generic client model
[in]	p_plat_model	Pointer to the platform model instance
[in]	from_ble_cb	The control task message handle associated with the generic client model

    : meshXBaseClientModel(model_id, p_plat_model, from_ble_cb)
{
    if (validate_client_model_id(model_id) != MESHX_SUCCESS)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Invalid model_id: %08" PRIx32, model_id);
        set_status(MESHX_INVALID_ARG);
        return;
    }
 
    set_status(meshXBaseGenericClientModel::plat_model_init());
    if (get_status() != MESHX_SUCCESS)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "plat_model_init failed");
        return;
    }
}

~meshXBaseGenericClientModel()

virtual meshXBaseGenericClientModel::~meshXBaseGenericClientModel ( )

virtualdefault

Member Function Documentation

meshx_gen_client_txcm_fn_model_send()

meshx_err_t meshXBaseGenericClientModel::meshx_gen_client_txcm_fn_model_send ( meshx_gen_client_msg_ctx_t * msg_param, size_t msg_param_len )

static

Send a message using the generic client model.

This function sends a message from a Generic Client model to a specified address within the BLE Mesh network, using the provided opcode and parameters.

Parameters

[in]	msg_param	Pointer to the message parameters structure.
[in]	msg_param_len	Length of the message parameters structure in bytes.

Returns

meshx_err_t Result of the operation. Returns MESHX_OK on success or an error code on failure.

{
    if(msg_param == nullptr || msg_param_len != sizeof(meshx_gen_client_msg_ctx_t))
    {
        return MESHX_INVALID_ARG;
    }
 
    return meshx_plat_gen_cli_send_msg(
        msg_param->model,
        &msg_param->state,
        msg_param->opcode,
        msg_param->addr,
        msg_param->net_idx,
        msg_param->app_idx,
        (meshx_is_get_req_opcode(msg_param->opcode) == MESHX_SUCCESS)
    );
}

meshx_is_get_req_opcode()

meshx_err_t meshXBaseGenericClientModel::meshx_is_get_req_opcode ( uint16_t opcode )

static

Checks if a given opcode is a GET request opcode.

This function checks if a given opcode is a GET request opcode for the generic client model.

Parameters

[in]

opcode

Opcode to check.

Returns

MESHX_SUCCESS if the opcode is a GET request opcode, MESHX_FAIL otherwise.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_GEN_ONOFF_GET:
        case MESHX_MODEL_OP_GEN_LEVEL_GET:
        case MESHX_MODEL_OP_GEN_ONPOWERUP_GET:
        case MESHX_MODEL_OP_GEN_POWER_LEVEL_GET:
        case MESHX_MODEL_OP_GEN_BATTERY_GET:
        case MESHX_MODEL_OP_GEN_LOC_GLOBAL_GET:
        case MESHX_MODEL_OP_GEN_LOC_LOCAL_GET:
        case MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTIES_GET:
        case MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTY_GET:
        case MESHX_MODEL_OP_GEN_ADMIN_PROPERTIES_GET:
        case MESHX_MODEL_OP_GEN_ADMIN_PROPERTY_GET:
        case MESHX_MODEL_OP_GEN_USER_PROPERTIES_GET:
        case MESHX_MODEL_OP_GEN_USER_PROPERTY_GET:
        case MESHX_MODEL_OP_GEN_CLIENT_PROPERTIES_GET:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

meshx_is_unack_opcode()

meshx_err_t meshXBaseGenericClientModel::meshx_is_unack_opcode ( uint32_t opcode )

static

Validates if a given opcode corresponds to an unacknowledged (SET_UNACK) message.

This function performs opcode validation to determine if the specified opcode represents a SET_UNACK operation for Generic BLE mesh models. Unacknowledged messages do not require a response from the server, making them suitable for broadcast operations and scenarios where reliability is less critical than performance.

Supported Unacknowledged Opcodes:

• MESHX_MODEL_OP_GEN_ONOFF_SET_UNACK: Generic OnOff Set Unacknowledged
• MESHX_MODEL_OP_GEN_LEVEL_SET_UNACK: Generic Level Set Unacknowledged
• MESHX_MODEL_OP_GEN_ONPOWERUP_SET_UNACK: Generic OnPowerUp Set Unacknowledged
• MESHX_MODEL_OP_GEN_POWER_LEVEL_SET_UNACK: Generic Power Level Set Unacknowledged
• MESHX_MODEL_OP_GEN_LOC_GLOBAL_SET_UNACK: Generic Location Global Set Unacknowledged
• MESHX_MODEL_OP_GEN_LOC_LOCAL_SET_UNACK: Generic Location Local Set Unacknowledged
• MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTY_SET_UNACK: Manufacturer Property Set Unacknowledged
• MESHX_MODEL_OP_GEN_ADMIN_PROPERTY_SET_UNACK: Admin Property Set Unacknowledged
• MESHX_MODEL_OP_GEN_USER_PROPERTY_SET_UNACK: User Property Set Unacknowledged

Parameters

[in]

opcode

The 32-bit BLE mesh model opcode to validate.

Return values

MESHX_SUCCESS	The opcode is a valid unacknowledged SET operation.
MESHX_FAIL	The opcode is not an unacknowledged SET operation.

Note

This function is used internally for transmission control and reliability decisions.

Unacknowledged messages are typically used for broadcast/multicast scenarios.

See also

meshx_is_get_req_opcode() for GET request validation.

{
    switch(opcode)
    {
        case MESHX_MODEL_OP_GEN_ONOFF_SET_UNACK:
        case MESHX_MODEL_OP_GEN_LEVEL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_ONPOWERUP_SET_UNACK:
        case MESHX_MODEL_OP_GEN_POWER_LEVEL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_LOC_GLOBAL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_LOC_LOCAL_SET_UNACK:
        case MESHX_MODEL_OP_GEN_MANUFACTURER_PROPERTY_SET_UNACK:
        case MESHX_MODEL_OP_GEN_ADMIN_PROPERTY_SET_UNACK:
        case MESHX_MODEL_OP_GEN_USER_PROPERTY_SET_UNACK:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

plat_model_init()

meshx_err_t meshXBaseGenericClientModel::plat_model_init ( void )

overridevirtual

Initialization function for the Generic OnOff Client model.

This function is responsible for initializing the Generic OnOff Client model. It checks if the model has been initialized before, and if not, it registers the callback function for transaction control messages and calls the platform specific initialization function.

Returns

meshx_err_t containing the result of the initialization operation.

Implements meshXBaseModel< meshx_gen_client_send_params_t >.

{
    meshx_err_t err = MESHX_SUCCESS;
    std::call_once(plat_client_init_flag, [&]() {
        err = meshx_txcm_event_cb_reg((meshx_txcm_cb_t) &base_handle_txcm_msg);
        if (err == MESHX_SUCCESS) {
            err = meshx_plat_gen_cli_init();
        }
    });
 
    return err;
}

plat_send_msg()

meshx_err_t meshXBaseGenericClientModel::plat_send_msg ( meshx_gen_client_send_params_t * params )

overridevirtual

Send a message using the generic client model.

This function sends a message from a generic client model to a specified address within the BLE Mesh network, using the provided opcode and parameters.

Parameters

[in]

params

Pointer to the structure containing the message parameters to set.

Returns

meshx_err_t containing the result of the send operation. Returns MESHX_OK on success or an error code on failure.

Implements meshXBaseModel< meshx_gen_client_send_params_t >.

{
    if (!params || !params->model || !params->state)
    {
        return MESHX_INVALID_ARG;
    }
 
    meshx_err_t err = MESHX_SUCCESS;
    bool is_unack = meshx_is_unack_opcode(params->opcode) == MESHX_SUCCESS;
    /* Broadcast / Multicast will not be sending an ACK. Hence, it is not required to queue */
    meshx_txcm_sig_t req_type = (is_unack || (MESHX_ADDR_IS_UNICAST(params->addr) == false)) ?
                                MESHX_TXCM_SIG_DIRECT_SEND : MESHX_TXCM_SIG_ENQ_SEND;
 
    meshx_gen_client_msg_ctx_t send_msg;
 
    send_msg.model   = params->model;
    send_msg.opcode  = params->opcode;
    send_msg.addr    = params->addr;
    send_msg.net_idx = params->net_idx;
    send_msg.app_idx = params->app_idx;
 
    memcpy(&send_msg.state, params->state, sizeof(send_msg.state));
 
    err = meshx_txcm_request_send(
        req_type,
        send_msg.addr,
        &send_msg,
        sizeof(send_msg),
        (meshx_txcm_fn_model_send_t) &meshXBaseGenericClientModel::meshx_gen_client_txcm_fn_model_send
    );
    if(err)
    {
        MESHX_LOGE(MODULE_ID_MODEL_CLIENT, "Failed to send message: %p", (meshx_ptr_t) err);
    }
    return err;
}

validate_client_model_id()

meshx_err_t meshXBaseGenericClientModel::validate_client_model_id ( uint32_t model_id )

overridevirtual

Validates if the given model ID corresponds to a supported Generic Client model.

This function performs validation of model IDs to ensure they correspond to supported Generic Client models in the MeshX BLE mesh framework. This is the Generic-specific implementation of the virtual validate_client_model_id function.

Supported Generic Client Model IDs:

• MESHX_MODEL_ID_GEN_ONOFF_CLI: Generic OnOff Client
• MESHX_MODEL_ID_GEN_LEVEL_CLI: Generic Level Client
• MESHX_MODEL_ID_GEN_BATTERY_CLI: Generic Battery Client
• MESHX_MODEL_ID_GEN_LOCATION_CLI: Generic Location Client
• MESHX_MODEL_ID_GEN_POWER_ONOFF_CLI: Generic Power OnOff Client
• MESHX_MODEL_ID_GEN_POWER_LEVEL_CLI: Generic Power Level Client

Parameters

[in]

model_id

The 32-bit model ID to validate against supported Generic client models.

Return values

MESHX_SUCCESS	The model ID is valid and supported.
MESHX_FAIL	The model ID is not supported or invalid.

Note

This function is specific to Generic models. Other client types (Lighting, Sensor, etc.) will have their own implementations with different supported model IDs.

Implements meshXBaseClientModel< meshXBaseGenericClientModel, meshx_gen_client_send_params_t, meshx_gen_cli_cb_param_t >.

{
    switch (model_id)
    {
        case MESHX_MODEL_ID_GEN_ONOFF_CLI:
        case MESHX_MODEL_ID_GEN_LEVEL_CLI:
        case MESHX_MODEL_ID_GEN_POWER_ONOFF_CLI:
        case MESHX_MODEL_ID_GEN_POWER_LEVEL_CLI:
        case MESHX_MODEL_ID_GEN_BATTERY_CLI:
        case MESHX_MODEL_ID_GEN_LOCATION_CLI:
        // Add more Generic client model IDs as needed
            return MESHX_SUCCESS;
        default:
            MESHX_LOGW(MODULE_ID_MODEL_CLIENT, "Invalid Generic client model ID: %08" PRIx32, model_id);
            return MESHX_FAIL;
    }
}

---

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

• meshx_base_model_generic.hpp
• meshx_base_model_generic.cpp