neuron/plugin_param_schema.json

{
	"plugins": [
		"mqtt-plugin",
		"modbus-tcp-plugin",
		"opcua-plugin"
	],
	"mqtt-plugin": {
		"client-id": {
			"name": "client-id",
			"description": "Neuron MQTT client ID",
			"type": "string",
			"attribute": "required",
			"default": "",
			"valid": {
				"length": 100
			}
		},
		"ssl": {
			"name": "ssl",
			"description": "Enable SSL connection",
			"attribute": "required",
			"type": "bool",
			"default": false,
			"valid": {}
		},
		"host": {
			"name": "host",
			"description": "MQTT broker host",
			"attribute": "required",
			"type": "string",
			"default": "broker.emqx.io",
			"valid": {
				"length": 30
			}
		},
		"port": {
			"name": "port",
			"description": "MQTT broker port",
			"attribute": "required",
			"type": "int",
			"default": 1883,
			"valid": {
				"min": 1024,
				"max": 65535
			}
		},
		"username": {
			"name": "username",
			"description": "User name",
			"attribute": "optional",
			"type": "string",
			"default": "",
			"valid": {
				"length": 30
			}
		},
		"password": {
			"name": "password",
			"description": "Password",
			"attribute": "optional",
			"type": "string",
			"default": "",
			"valid": {
				"length": 30
			}
		},
		"ca-path": {
			"name": "ca-path",
			"description": "",
			"attribute": "required",
			"type": "string",
			"default": "",
			"condition": {
				"field": "ssl",
				"value": true
			},
			"valid": {
				"length": 100
			}
		},
		"ca-file": {
			"name": "ca-file",
			"description": "",
			"attribute": "required",
			"type": "string",
			"condition": {
				"field": "ssl",
				"value": true
			},
			"default": "",
			"valid": {
				"length": 100
			}
		},
		"ca": {
			"name": "ca",
			"description": "",
			"attribute": "optional",
			"type": "file",
			"condition": {
				"field": "ssl",
				"value": true
			},
			"valid": {
				"length": 1024
			}
		}
	},
	"neuron-opcua-plugin": {
		"tag_type": [
			2,
			3,
			4,
			5,
			6,
			7,
			8,
			9,
			10,
			11,
			12,
			13,
			14,
			15
		],
		"host": {
			"name": "host",
			"description": "OPCUA server host",
			"attribute": "required",
			"type": "string",
			"valid": {
				"length": 30
			}
		},
		"port": {
			"name": "port",
			"description": "OPCUA server port",
			"attribute": "required",
			"type": "int",
			"default": 4840,
			"valid": {
				"min": 1024,
				"max": 65535
			}
		},
		"username": {
			"name": "username",
			"description": "User name",
			"attribute": "optional",
			"type": "string",
			"default": "",
			"valid": {
				"length": 30
			}
		},
		"password": {
			"name": "password",
			"description": "Password",
			"attribute": "optional",
			"type": "string",
			"default": "",
			"valid": {
				"length": 30
			}
		}
	},
	"modbus-tcp-plugin": {
		"tag_type": [
			4,
			5,
			8,
			9,
			11,
			14
		],
		"host": {
			"name": "host",
			"description": "local ip in server mode, remote device ip in client mode",
			"attribute": "required",
			"type": "string",
			"valid": {
				"length": 30
			}
		},
		"port": {
			"name": "port",
			"description": "local port in server mode, remote device port in client mode",
			"attribute": "required",
			"type": "int",
			"default": 502,
			"valid": {
				"min": 1,
				"max": 65535
			}
		},
		"connection_mode": {
			"name": "connection mode",
			"description": "neuron as the client, or as the server",
			"attribute": "required",
			"type": "map",
			"default": 0,
			"valid": {
				"map": [
					{
						"key": "client",
						"value": 0
					},
					{
						"key": "server",
						"value": 1
					}
				]
			}
		}
	}
}