meshx_light_server.h File Reference

Header file for the production lighting server. More...

#include "meshx_control_task.h"
#include "interface/ble_mesh/server/meshx_ble_mesh_light_srv.h"

Include dependency graph for meshx_light_server.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef control_task_msg_handle_t	meshx_lighting_server_cb

Functions
meshx_err_t	meshx_gen_light_srv_send_msg_to_ble (control_task_msg_evt_to_ble_t evt, const meshx_lighting_server_cb_param_t *params)
	Sends a message to the BLE subsystem via the control task.
meshx_err_t	meshx_lighting_reg_cb (uint32_t model_id, meshx_lighting_server_cb cb)
	Register a callback function for the lighting server model.
meshx_err_t	meshx_lighting_srv_dereg_cb (uint32_t model_id, meshx_lighting_server_cb cb)
	Callback function to deregister a lighting server model.
meshx_err_t	meshx_lighting_srv_init (void)
	Initialize the production lighting server.
meshx_err_t	meshx_gen_light_srv_status_send (meshx_model_t *p_model, meshx_ctx_t *ctx, meshx_lighting_server_state_change_t *state_change)
	Sends a status message for the Lighting Server model.

Detailed Description

Header file for the production lighting server.

Copyright © 2024 - 2025 MeshX

This file contains the declarations and definitions for the production lighting server, including callback registration and initialization functions.

Author

Pranjal Chanda

Definition in file meshx_light_server.h.

Typedef Documentation

meshx_lighting_server_cb

typedef control_task_msg_handle_t meshx_lighting_server_cb

Definition at line 20 of file meshx_light_server.h.

Function Documentation

meshx_gen_light_srv_send_msg_to_ble()

meshx_err_t meshx_gen_light_srv_send_msg_to_ble	(	control_task_msg_evt_to_ble_t	evt,
		const meshx_lighting_server_cb_param_t *	params )

Sends a message to the BLE subsystem via the control task.

This function publishes a message to the BLE layer with the specified event and parameters.

Parameters

[in]	evt	The event to be sent to the BLE layer.
[in]	params	Pointer to the parameters associated with the event.

Returns

• MESHX_SUCCESS: Message sent successfully.
• MESHX_FAIL: Failed to send the message.

Definition at line 62 of file meshx_light_server.c.

{
    if (MESHX_SUCCESS != meshx_is_status_in_gen_light_grp(
            (uint16_t)(params->ctx.opcode)))
    {
        return MESHX_SUCCESS; // No action needed for non-light group opcodes
    }
    return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE,
                                    evt,
                                    params,
                                    sizeof(meshx_lighting_server_cb_param_t));
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_light_srv_status_send()

meshx_err_t meshx_gen_light_srv_status_send	(	meshx_model_t *	p_model,
		meshx_ctx_t *	ctx,
		meshx_lighting_server_state_change_t *	state_change )

Sends a status message for the Lighting Server model.

This function sends a status message for the Lighting Server model with the specified parameters.

Parameters

[in]	p_model	Pointer to the Lighting Server model.
[in]	ctx	Pointer to the context of the received messages.
[in]	state_change	Pointer to the state change data for the Lighting Server.

Returns

MESHX_SUCCESS on success, or an appropriate error code on failure.

Definition at line 143 of file meshx_light_server.c.

{
    if (!p_model || !ctx || !state_change)
        return MESHX_INVALID_ARG;
 
    if (meshx_is_status_in_gen_light_grp((uint16_t)ctx->opcode) != MESHX_SUCCESS)
    {
        return MESHX_NOT_SUPPORTED;
    }
 
    return meshx_plat_gen_light_srv_send_status(
        p_model,
        ctx,
        state_change
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_lighting_reg_cb()

meshx_err_t meshx_lighting_reg_cb	(	uint32_t	model_id,
		meshx_lighting_server_cb	cb )

Register a callback function for the lighting server model.

This function registers a callback function that will be called when certain events occur in the lighting server model.

Parameters

[in]	model_id	The ID of the lighting server model.
[in]	cb	The callback function to register.

Returns

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

Definition at line 108 of file meshx_light_server.c.

{
    return control_task_msg_subscribe(CONTROL_TASK_MSG_CODE_FRM_BLE, model_id, (control_task_msg_handle_t)cb);
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_lighting_srv_dereg_cb()

meshx_err_t meshx_lighting_srv_dereg_cb	(	uint32_t	model_id,
		meshx_lighting_server_cb	cb )

Callback function to deregister a lighting server model.

This function is called to deregister a lighting server model identified by the given model ID.

Parameters

[in]	model_id	The ID of the model to be deregistered.
[in]	cb	The callback function to be deregistered.

Returns

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

Definition at line 90 of file meshx_light_server.c.

{
    return control_task_msg_unsubscribe(CONTROL_TASK_MSG_CODE_FRM_BLE, model_id, (control_task_msg_handle_t)cb);
}

Here is the call graph for this function:

meshx_lighting_srv_init()

meshx_err_t meshx_lighting_srv_init

(

void

)

Initialize the production lighting server.

Returns

MESHX_SUCCESS on success, or an appropriate error code on failure.

Initialize the production lighting server.

This function sets up the necessary configurations and initializes the meshxuction lighting server for the BLE mesh node.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Failed to initialize the lighting server

Definition at line 123 of file meshx_light_server.c.

{
    if (meshx_lighting_server_init == MESHX_SERVER_INIT_MAGIC_NO)
        return MESHX_SUCCESS;
    meshx_lighting_server_init = MESHX_SERVER_INIT_MAGIC_NO;
 
    return meshx_plat_light_srv_init();
}

Here is the call graph for this function:

Here is the caller graph for this function: