mirror of
https://github.com/emqx/neuron.git
synced 2026-10-22 17:50:36 +08:00
fengzero
174 lines
7.2 KiB
C
174 lines
7.2 KiB
C
/**
|
|
* NEURON IIoT System for Industry 4.0
|
|
* Copyright (C) 2020-2021 EMQ Technologies Co., Ltd All rights reserved.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
**/
|
|
|
|
#ifndef NEURON_PLUGIN_H
|
|
#define NEURON_PLUGIN_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "utils/utarray.h"
|
|
#include "utils/zlog.h"
|
|
|
|
#include "adapter.h"
|
|
#include "type.h"
|
|
|
|
#define NEURON_PLUGIN_VER_1_0 100
|
|
#define NEURON_PLUGIN_VER_2_0 200
|
|
|
|
typedef struct neu_plugin_common {
|
|
uint32_t magic;
|
|
neu_plugin_link_state_e link_state;
|
|
neu_adapter_t * adapter;
|
|
const adapter_callbacks_t *adapter_callbacks;
|
|
uint32_t event_id;
|
|
zlog_category_t * log;
|
|
} neu_plugin_common_t;
|
|
|
|
typedef struct neu_plugin neu_plugin_t;
|
|
|
|
typedef struct neu_plugin_group neu_plugin_group_t;
|
|
typedef void (*neu_plugin_group_free)(neu_plugin_group_t *pgp);
|
|
struct neu_plugin_group {
|
|
char * group_name;
|
|
UT_array *tags;
|
|
|
|
void * user_data;
|
|
neu_plugin_group_free group_free;
|
|
};
|
|
|
|
typedef struct neu_plugin_intf_funs {
|
|
neu_plugin_t *(*open)(neu_adapter_t * adapter,
|
|
const adapter_callbacks_t *callbacks);
|
|
int (*close)(neu_plugin_t *plugin);
|
|
int (*init)(neu_plugin_t *plugin);
|
|
int (*uninit)(neu_plugin_t *plugin);
|
|
int (*start)(neu_plugin_t *plugin);
|
|
int (*stop)(neu_plugin_t *plugin);
|
|
int (*config)(neu_plugin_t *plugin, neu_config_t *configs);
|
|
|
|
int (*request)(neu_plugin_t *plugin, neu_request_t *req);
|
|
int (*event_reply)(neu_plugin_t *plugin, neu_event_reply_t *reply);
|
|
int (*validate_tag)(neu_plugin_t *plugin, neu_datatag_t *tag);
|
|
|
|
union {
|
|
struct {
|
|
int (*validate_tag)(neu_plugin_t *plugin, neu_datatag_t *tag);
|
|
int (*group_timer)(neu_plugin_t *plugin, neu_plugin_group_t *group);
|
|
int (*write_tag)(neu_plugin_t *plugin, void *req,
|
|
neu_datatag_t *tag, neu_value_u value);
|
|
} driver;
|
|
};
|
|
|
|
} neu_plugin_intf_funs_t;
|
|
|
|
typedef struct neu_plugin_module {
|
|
const uint32_t version;
|
|
const char * module_name;
|
|
const char * module_descr;
|
|
const neu_plugin_intf_funs_t *intf_funs;
|
|
neu_node_type_e type;
|
|
neu_plugin_kind_e kind;
|
|
} neu_plugin_module_t;
|
|
|
|
inline static neu_plugin_common_t *
|
|
neu_plugin_to_plugin_common(neu_plugin_t *plugin)
|
|
{
|
|
return (neu_plugin_common_t *) plugin;
|
|
}
|
|
|
|
void neu_plugin_common_init(neu_plugin_common_t *common);
|
|
bool neu_plugin_common_check(neu_plugin_t *plugin);
|
|
|
|
uint32_t neu_plugin_get_event_id(neu_plugin_t *plugin);
|
|
|
|
intptr_t neu_system_add_node(neu_plugin_t *plugin, const char *adapter_name,
|
|
const char *plugin_name);
|
|
intptr_t neu_system_del_node(neu_plugin_t *plugin, const char *name);
|
|
UT_array *neu_system_get_nodes(neu_plugin_t *plugin, neu_node_type_e node_type);
|
|
|
|
intptr_t neu_system_add_group_config(neu_plugin_t *plugin,
|
|
const char *node_name, const char *name,
|
|
uint32_t interval);
|
|
intptr_t neu_system_del_group_config(neu_plugin_t *plugin,
|
|
const char *node_name, const char *name);
|
|
intptr_t neu_system_update_group_config(neu_plugin_t *plugin,
|
|
const char *node_name, const char *name,
|
|
uint32_t interval);
|
|
int neu_system_get_group_configs(neu_plugin_t *plugin, const char *node_name,
|
|
UT_array **groups);
|
|
|
|
int neu_plugin_send_unsubscribe_cmd(neu_plugin_t *plugin, const char *app_name,
|
|
const char *driver_name, const char *group);
|
|
int neu_plugin_send_subscribe_cmd(neu_plugin_t *plugin, const char *app_name,
|
|
const char *driver_name, const char *group);
|
|
|
|
void neu_plugin_send_read_cmd(neu_plugin_t *plugin, const char *driver,
|
|
const char *group, void *ctx);
|
|
void neu_plugin_send_write_cmd(neu_plugin_t *plugin, const char *node_name,
|
|
const char *group_name, const char *tag,
|
|
neu_dvalue_t value, void *ctx);
|
|
|
|
intptr_t neu_system_add_plugin(neu_plugin_t *plugin,
|
|
const char * plugin_lib_name);
|
|
intptr_t neu_system_del_plugin(neu_plugin_t *plugin, const char *name);
|
|
UT_array *neu_system_get_plugin(neu_plugin_t *plugin);
|
|
|
|
int neu_plugin_notify_event_add_tags(neu_plugin_t *plugin, uint32_t event_id,
|
|
const char *node_name,
|
|
const char *group_name);
|
|
int neu_plugin_notify_event_del_tags(neu_plugin_t *plugin, uint32_t event_id,
|
|
const char *node_name,
|
|
const char *group_name);
|
|
int neu_plugin_notify_event_update_tags(neu_plugin_t *plugin, uint32_t event_id,
|
|
const char *node_name,
|
|
const char *group_name);
|
|
int neu_plugin_notify_event_update_license(neu_plugin_t *plugin,
|
|
uint32_t event_id);
|
|
|
|
intptr_t neu_plugin_set_node_setting(neu_plugin_t *plugin,
|
|
const char * node_name,
|
|
const char * setting);
|
|
int32_t neu_plugin_get_node_setting(neu_plugin_t *plugin, const char *node_name,
|
|
char **setting);
|
|
int32_t neu_plugin_get_node_state(neu_plugin_t *plugin, const char *node_name,
|
|
neu_plugin_state_t *state);
|
|
intptr_t neu_plugin_node_ctl(neu_plugin_t *plugin, const char *node_name,
|
|
neu_adapter_ctl_e ctl);
|
|
UT_array *neu_system_get_sub_group_configs(neu_plugin_t *plugin,
|
|
const char * node_name);
|
|
|
|
int neu_plugin_tag_add(neu_plugin_t *plugin, const char *node,
|
|
const char *group, uint16_t n_tag, neu_datatag_t *tags,
|
|
uint16_t *index);
|
|
int neu_plugin_tag_del(neu_plugin_t *plugin, const char *node,
|
|
const char *group, uint16_t n_tag, char **tags);
|
|
int neu_plugin_tag_update(neu_plugin_t *plugin, const char *node,
|
|
const char *group, uint16_t n_tag,
|
|
neu_datatag_t *tags, uint16_t *index);
|
|
int neu_plugin_tag_get(neu_plugin_t *plugin, const char *node,
|
|
const char *group, UT_array **tags);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|