interface.json

For nodes the interface.json file will contain information about configuration parameters:

Configurations
Examples

Edit

Field	Type	Required	Description
configuration	object	–	Describes parameters of a plugin configuration script.

Edit

Field	Type	Required	Description
type	string	+	Type of configuration, one of static, none (default)
script	string, path	–	Path to a file through which configuration is provided. Like: HUB:plugin_name/path/to/configuration/script.lua
inputs	array of objects	–	Each object in the array provides a description of a parameter for the configuration script.

Edit

Field	Type	Required	Description
name	string	+	Human-readable name of a field, for UI
description	string	+	Description of a field
field	string	+	Name of a field to use in parameters of a configuration script
required	boolean	+	Default is true
type	string	+	Type of a field
format	string	–	Format of a string (like ip for IPv4 IP addresses; will be provided by cloud later)

Edit

				
					{
    "configuration":{
        "type":"none",
        "script":"HUB:plugin_name/path/to/configuration/script.lua" ,
        "inputs":[
                    {
                        "name":"temperature",
                        "description":"thermostat measure value",
                        "field":"temperature_field",
                        "required":true,
                        "type":"float",
                        "format":"degrees"
                    }
        ]
    }
}