SDK-based Driver Development

This article mainly introduces how to develop a new driver plugin based on the SDK package and apply it to Neuron.

Step 1 Download and install the SDK

Download link: https://github.com/emqx/neuron/releases

According to different development systems, download the corresponding sdk tar.gz package, e.g. neuron-sdk-2.1.3-linux-amd64.tar.gz to the corresponding development system and decompress it to obtain neuron-sdk-x.x.x, where x.x.x represents the version number, execute the following command.

  1. # take version 2.3.0 as an example
  2. $ cd neuron-sdk-2.3.0
  3. # install sdk
  4. $ sudo ./sdk-install.sh

After the script is executed, you need to pay attention to the usage of the following paths.

Path Description
/usr/local/include/neuron Stores Neuron header files and apply to include_directories in the CMakeLists.txt compilation file
/usr/local/lib/neuron Stores Neuron dependent library files, which are applied to link_directories in the CMakeLists.txt compilation file
/usr/local/bin/neuron Holds files needed to run Neuron

Step 2 Driver development

Create a new directory file in the development environment to store the files required for the development driver, create a compilation configuration file CMakeLists.txt under the directory file, a build directory file to store the compiled files and a plugins directory file for To store all the driver files that need to be developed, each driver needs to have an independent directory to store the required files for driver development. Taking the development of modbus-tcp driver plug-in as an example, the directory level is shown in the figure below.

driver-tree

CMakeLists.txt example

The main thing is that include_directories, link_directories and add_subdirectory should be configured correctly.

  1. cmake_minimum_required(VERSION 3.12)
  2. project(modbus_tcp)
  3. enable_language(C)
  4. set(CMAKE_C_STANDARD 99)
  6. find_package(Threads)
  8. # add the path to the neuron header
  9. include_directories(/usr/local/include /usr/local/include/neuron)
  10. # add the path to the neuron library
  11. link_directories(/usr/local/lib /usr/local/lib/neuron)
  13. # add driver submodule
  14. add_subdirectory(plugins/modbus-tcp)

plugins/modbus

The driver development file mainly includes the compilation configuration file CMakeLists.txt, the driver configuration json file and the driver code file.

CMakeLists.txt example

  1. set(LIBRARY_OUTPUT_PATH "${CMAKE_BINARY_DIR}/plugins")
  3. set(CMAKE_BUILD_RPATH ./)
  4. # set plugin name
  5. set(MODBUS_TCP_PLUGIN plugin-modbus-tcp)
  6. # set the driver development code file
  7. set(MODBUS_TCP_PLUGIN_SOURCES  modbus_tcp.c)
  8. add_library(${MODBUS_TCP_PLUGIN} SHARED)
  9. target_sources(${MODBUS_TCP_PLUGIN} PRIVATE ${MODBUS_TCP_PLUGIN_SOURCES})
  10. target_link_libraries(${MODBUS_TCP_PLUGIN} neuron-base)

modbus_tcp.c

The interface file of the driver plugin, for the specific driver development example, please refer to modbus plugin development example.

static const neu_plugin_intf_funs_t plugin_intf_funs structure description.

Parameters Description
.open The first function called by neuron when creating a node based on the plugin, create a struct neu_plugin defined by the plugin itself
.close The last function called by neuron when a node is removed to release the neu_plugin_t created by open
.init When creating a node, after neuron calls open, the function called immediately after that. This function is mainly used for some resources that need to be initialized in the plugin
.uninit The function that neuron calls first when deleting a node. This function mainly releases some resources applied and initialized in init
.start On the node page, set the job status to start, neuron will call this function to notify the plugin to start running, and start connecting to the device
.stop On the node page, set the working status to stop, neuron will call this function to notify the plugin to stop running, close the connection with the device, and driver.group_timer will no longer trigger
.setting On the node page, when the plugin is set, the parameters will be set in json format, and neuron will notify the plugin to set through this function
.request This function has not been used in the development of southbound driver
.driver.validate_tag When a node adds or updates a tag, neuron will use this function to notify the plug-in of the relevant parameters of the tag. The plug-in checks whether the tag meets the requirements of the plug-in according to its own implementation. The function returns 0, which means success
.driver.group_timer When a group is added to a node and the node status is running, this function will be called periodically to read device data with the interval parameter of the group
.driver.write_tag When using the write API, neuron calls this function to notify the plugin to write a specific value to the point tag

Dynamic library export data structure definition const neu_plugin_module_t neu_plugin_module Description.

Parameters Description
version Plugin version number
module_name module name
module_descr Module description
intf_funs Plugin interface function
kind Plugin type
type The type of node when the plugin is instantiated as node

The struct neu_plugin structure is the pre-name of the plugin. Each plugin needs to provide the specific definition of the structure, and the first member must be common, and other members are added according to the driver’s configuration.

  1. #include <stdlib.h>
  3. #include <neuron.h>
  5. static neu_plugin_t *driver_open(void);
  7. static int driver_close(neu_plugin_t *plugin);
  8. static int driver_init(neu_plugin_t *plugin);
  9. static int driver_uninit(neu_plugin_t *plugin);
  10. static int driver_start(neu_plugin_t *plugin);
  11. static int driver_stop(neu_plugin_t *plugin);
  12. static int driver_config(neu_plugin_t *plugin, const char *config);
  13. static int driver_request(neu_plugin_t *plugin, neu_reqresp_head_t *head,
  14.                           void *data);
  16. static int driver_validate_tag(neu_plugin_t *plugin, neu_datatag_t *tag);
  17. static int driver_group_timer(neu_plugin_t *plugin, neu_plugin_group_t *group);
  18. static int driver_write(neu_plugin_t *plugin, void *req, neu_datatag_t *tag,
  19.                         neu_value_u value);
  21. static const neu_plugin_intf_funs_t plugin_intf_funs = {
  22.     .open    = driver_open,
  23.     .close   = driver_close,
  24.     .init    = driver_init,
  25.     .uninit  = driver_uninit,
  26.     .start   = driver_start,
  27.     .stop    = driver_stop,
  28.     .setting = driver_config,
  29.     .request = driver_request,
  31.     .driver.validate_tag = driver_validate_tag,
  32.     .driver.group_timer  = driver_group_timer,
  33.     .driver.write_tag    = driver_write,
  34. };
  36. const neu_plugin_module_t neu_plugin_module = {
  37.     .version      = NEURON_PLUGIN_VER_1_0,
  38.     .module_name  = "modbus-tcp",
  39.     .module_descr = "modbus tcp",
  40.     .intf_funs    = &plugin_intf_funs,
  41.     .kind         = NEU_PLUGIN_KIND_SYSTEM,
  42.     .type         = NEU_NA_TYPE_DRIVER,
  43. };
  45. struct neu_plugin {
  46.         neu_plugin_common_t common;
  47. };
  49. static neu_plugin_t *driver_open(void)
  50. {
  51.     neu_plugin_t *plugin = calloc(1, sizeof(neu_plugin_t));
  53.     neu_plugin_common_init(&plugin->common);
  55.     return plugin;
  56. }
  58. static int driver_close(neu_plugin_t *plugin)
  59. {
  60.     free(plugin);
  62.     return 0;
  63. }
  65. static int driver_init(neu_plugin_t *plugin)
  66. {
  67.     plog_info(plugin, "node: modbus init");
  69.     return 0;
  70. }
  72. static int driver_uninit(neu_plugin_t *plugin)
  73. {
  75.     plog_info(plugin, "node: modbus uninit");
  77.     return 0;
  78. }
  80. static int driver_start(neu_plugin_t *plugin)
  81. {
  82.     plog_info(plugin, "node: modbus start");
  84.     return 0;
  85. }
  87. static int driver_stop(neu_plugin_t *plugin)
  88. {
  89.     plog_info(plugin, "node: modbus stop");
  90.     return 0;
  91. }
  93. static int driver_config(neu_plugin_t *plugin, const char *config)
  94. {
  95.     plog_info(plugin, "config: %s", config);
  97.     return 0;
  98. }
  100. static int driver_request(neu_plugin_t *plugin, neu_reqresp_head_t *head,
  101.                           void *data)
  102. {
  103.     (void) data;
  104.     (void) plugin;
  105.     (void) head;
  107.     return 0;
  108. }
  110. static int driver_validate_tag(neu_plugin_t *plugin, neu_datatag_t *tag)
  111. {
  112.     plog_info(plugin, "validate tag: %s", tag->name);
  114.     return 0;
  115. }
  117. static int driver_group_timer(neu_plugin_t *plugin, neu_plugin_group_t *group)
  118. {
  119.     (void) plugin;
  120.     (void) group;
  122.     plog_info(plugin, "timer....");
  124.     return 0;
  125. }
  127. static int driver_write(neu_plugin_t *plugin, void *req, neu_datatag_t *tag,
  128.                         neu_value_u value)
  129. {
  130.     (void) plugin;
  131.     (void) req;
  132.     (void) tag;
  133.     (void) value;
  135.     return 0;
  136. }

modbus-tcp.json

The driver configuration file.

Field Description
tag_regex Regex for address configuration for drivers that support different data types
description A detailed description of the field
attribute The attribute of the field, there are only two optional and required options, namely required and optional
type The type of the field, currently int and string are commonly used
default The default value to fill in
valid The range that this field can be filled in

The name of the json file should be the same as the module name module_name.

  1. {
  2.     "tag_regex": [
  3.         {
  4.             "type": 3,
  5.             "regex": "[1-9]+![3-4][0-9]+(#B|#L|)$"
  6.         },
  7.         {
  8.             "type": 4,
  9.             "regex": "[1-9]+![3-4][0-9]+(#B|#L|)$"
  10.         },
  11.         {
  12.             "type": 5,
  13.             "regex": "[1-9]+![3-4][0-9]+(#BB|#BL|#LL|#LB|)$"
  14.         },
  15.         {
  16.             "type": 6,
  17.             "regex": "[1-9]+![3-4][0-9]+(#BB|#BL|#LL|#LB|)$"
  18.             },
  19.         {
  20.             "type": 9,
  21.             "regex": "[1-9]+![3-4][0-9]+(#BB|#BL|#LL|#LB|)$"
  22.         },
  23.         {
  24.             "type": 11,
  25.             "regex": "[1-9]+!([0-1][0-9]+|[3-4][0-9]+.([0-9]|[0-1][0-5]))$"
  26.         }
  27.     ],
  28.     "host": {
  29.         "name": "host",
  30.         "description": "local ip in server mode, remote device ip in client mode",
  31.         "attribute": "required",
  32.         "type": "string",
  33.         "valid": {
  34.             "regex": "/^((2[0-4]\\d|25[0-5]|[01]?\\d\\d?)\\.){3}(2[0-4]\\d|25[0-5]|[01]?\\d\\d?)$/",
  35.             "length": 30
  36.         }
  37.     },
  38.     "port": {
  39.         "name": "port",
  40.         "description": "local port in server mode, remote device port in client mode",
  41.         "attribute": "required",
  42.         "type": "int",
  43.         "default": 502,
  44.         "valid": {
  45.         "min": 1,
  46.         "max": 65535
  47.         }
  48.     },
  49.     "timeout": {
  50.         "name": "timeout",
  51.         "description": "recv msg timeout(ms)",
  52.         "attribute": "required",
  53.         "type": "int",
  54.         "default": 3000,
  55.         "valid": {
  56.             "min": 1000,
  57.             "max": 65535
  58.         }
  59.     }
  60. }

build

After the driver development code is completed, execute compilation in this directory.

  1. $ cmake ..
  2. $ make

Step 3 The plugin is applied to Neuron

Copy the driver .so file

After compiling, go to modbus/build/plugins and copy the generated driver .so file (for example, libplugin-modbus-tcp.so ) to the /usr/local/bin/neuron/plugins directory.

Copy the driver configuration .json file

Copy the modbus/modbus-tcp.json file to the /usr/local/bin/neuron/plugins/schema directory.

Modify plugins.json file

Open the plugins.json file in the /usr/local/bin/neuron/persistence directory and add the name of the newly added driver .so file to it.

Start Neuron verification driver

Go back to the /usr/local/bin/neuron directory and execute the following command to run Neuron.

  1. $ sudo ./neuron --log

Open Neuron on the web page to view the added plugins and their usage.