meshx_api.h

Go to the documentation of this file.

 
#ifndef __MESHX_API_H__
#define __MESHX_API_H__
 
#include <meshx_common.h>
#include <meshx_elements.h>
#include <meshx_control_task.h>
 
#define MESHX_APP_API_MSG_MAX_SIZE  sizeof(meshx_data_payload_t)
 
/* MeshX Function ID Relay Server */
#define MESHX_ELEMENT_FUNC_ID_RELAY_SERVER_ONN_OFF          0x00
 
/* MeshX Function ID Light CWWW Server */
#define MESHX_ELEMENT_FUNC_ID_LIGHT_CWWW_SERVER_ONN_OFF     0x00
#define MESHX_ELEMENT_FUNC_ID_LIGHT_CWWW_SERVER_CTL         0x01
 
/* MeshX Function ID Light CWWW Server */
#define MESHX_ELEMENT_FUNC_ID_LIGHT_CWWW_CLIENT_ONN_OFF     0x00
#define MESHX_ELEMENT_FUNC_ID_LIGHT_CWWW_CLIENT_CTL         0x01
typedef enum meshx_api_type
{
    MESHX_API_TYPE_DATA = CONTROL_TASK_MSG_EVT_DATA,        
    MESHX_API_TYPE_CTRL = CONTROL_TASK_MSG_EVT_CTRL,        
} meshx_api_type_t;

typedef enum meshx_element_type
{
    MESHX_ELEMENT_TYPE_RELAY_SERVER,
    MESHX_ELEMENT_TYPE_RELAY_CLIENT,
    MESHX_ELEMENT_TYPE_LIGHT_CWWW_SERVER,
    MESHX_ELEMENT_TYPE_LIGHT_CWWW_CLIENT,
    MESHX_ELEMENT_TYPE_MAX
}meshx_element_type_t;

typedef struct meshx_api_relay_server_evt
{
   uint8_t on_off;
}meshx_api_relay_server_evt_t;

typedef struct meshx_api_light_cwww_server_evt
{
    union
    {
        struct
        {
            uint8_t state;
        }on_off;
        struct
        {
            uint16_t lightness;
            uint16_t temperature;
            uint16_t delta_uv;
            uint16_t temp_range_min;
            uint16_t temp_range_max;
        }ctl;
    }state_change;
}meshx_api_light_cwww_server_evt_t;

typedef struct meshx_api_relay_client_state
{
   uint8_t err_code;
   uint8_t on_off;
}meshx_api_relay_client_evt_t;

typedef struct meshx_api_light_cwww_client_evt
{
   uint8_t err_code;
   union
    {
        struct
        {
            uint8_t state;
        }on_off;
        struct
        {
            uint16_t lightness;
            uint16_t temperature;
            uint16_t delta_uv;
            uint16_t temp_range_min;
            uint16_t temp_range_max;
        }ctl;
    }state_change;
}meshx_api_light_cwww_client_evt_t;

typedef union meshx_data_payload
{
    meshx_api_relay_client_evt_t relay_client_evt;
    meshx_api_relay_server_evt_t relay_server_evt;
    meshx_api_light_cwww_client_evt_t light_cwww_client_evt;
    meshx_api_light_cwww_server_evt_t light_cwww_server_evt;
} meshx_data_payload_t;

typedef union meshx_ctrl_payload
{
    uint32_t reserved;
} meshx_ctrl_payload_t;

typedef struct meshx_app_element_msg_header
{
    uint16_t element_id;               /* Element ID */
    uint16_t element_type;             /* meshx_element_type_t */
    uint16_t func_id;                  /* Functionality number */
    uint16_t msg_len;                  /* Length of the message */
}meshx_app_element_msg_header_t;

typedef struct meshx_ctrl_msg_header
{
    uint16_t evt;                   /* Event */
    uint16_t reserved;              /* Reserved */
}meshx_ctrl_msg_header_t;

typedef struct meshx_app_api_msg
{
    union
    {
        meshx_ctrl_msg_header_t ctrl_msg;
        meshx_app_element_msg_header_t element_msg;
    }msg_type_u;
 
    uint8_t data[MESHX_APP_API_MSG_MAX_SIZE];
}meshx_app_api_msg_t;

typedef meshx_err_t (*meshx_app_data_cb_t)(const meshx_app_element_msg_header_t *msg_hdr, const meshx_data_payload_t *msg);

typedef meshx_err_t (*meshx_app_ctrl_cb_t)(const meshx_ctrl_msg_header_t *msg_hdr, const meshx_ctrl_payload_t *msg);

meshx_err_t meshx_send_msg_to_app(uint16_t element_id, uint16_t element_type, uint16_t func_id, uint16_t msg_len, const void *msg);

meshx_err_t meshx_send_msg_to_element(uint16_t element_id, uint16_t element_type, uint16_t func_id, uint16_t msg_len, const void *msg);

meshx_err_t meshx_app_reg_element_callback(meshx_app_data_cb_t cb);

meshx_err_t meshx_app_reg_system_events_callback(meshx_app_ctrl_cb_t cb);
 
#endif /* __MESHX_API_H__ */