For the complete documentation index, see llms.txt. This page is also available as Markdown.

Device

Learn the specifics of developing a device plugin.

Create the file structure

Set up a directory structure with the following files:

β”œβ”€β”€ src           
β”‚   β”œβ”€β”€ view.xml           
β”œβ”€β”€ LICENSE
β”œβ”€β”€ README.md
β”œβ”€β”€ manifest.toml

manifest.toml

Fill this file with the proper configuration according to the Device section of the Private Plugins page. Based on that, the manifest should look like this:

manifest_version = 2.0

[settings]
version = "0.0.1"
plugin_type = "device"
license_name = "MIT license"
categories = ["End Device"]
filters = {brand = ["Advantech"], connectivity = ["Ethernet"]}

view.xml

At the moment, this file is not fully implemented for Device plugins, so it is not relevant to this plugin type. However, it must contain dummy but valid data so the plugin can be deployed. For this reason, you can use the following view.xml file as a dummy file during Device plugin development:

LICENSE and README.md

Write the contents of the README.md and LICENSE files.

Compressing the files

Compress the files into a ZIP archive from the root of the file structure, not the parent folder.

Last updated

Was this helpful?