Device_Connection.json

{
    "type": "object",
    "title": "Device Connection",
    "required": [
        "connType"
    ],
    "properties": {
        "name": {
            "title": "Connection Name",
            "type": "string"
        },
        "connType": {
            "title": "Connection Type",
            "type": "string",
            "enum": [
                "",
                "Fieldbus",
                "MQTT",
                "OPC UA",
                "REST",
                "S7",
                "UDP",
                "MTConnect",
                "Open Protocol",
                "ASCII TCP"
            ],
            "minLength": 1
        },
        "UDPConnDetails": {
            "type": "object",
            "title": "UDP Server Details",
            "options": {
                "dependencies": {
                    "connType": "UDP"
                },
                "collapsed": false
            },
            "properties": {
                "port": {
                    "title": "Port",
                    "type": "number",
                    "enum": [
                        50205
                    ]
                }
            }
        },
        "MQTTConnDetails": {
            "type": "object",
            "title": "MQTT Server Details",
            "options": {
                "dependencies": {
                    "connType": "MQTT"
                },
                "collapsed": false
            },
            "required": [
                "host",
                "port",
                "protocol"
            ],
            "properties": {
                "host": {
                    "type": "string",
                    "title": "Hostname/IP",
                    "minLength": 1
                },
                "protocol": {
                    "type": "string",
                    "title": "Protocol",
                    "enum": [
                        "mqtt",
                        "mqtts",
                        "tcp",
                        "tls",
                        "ws",
                        "wss"
                    ],
                    "default": "mqtt",
                    "minLength": 1
                },
                "port": {
                    "type": "number",
                    "title": "Port",
                    "minLength": 1,
                    "default": 1883
                },
                "useSSL": {
                    "type": "boolean",
                    "title": "Use SSL?",
                    "format": "checkbox"
                },
                "clientId": {
                    "type": "string",
                    "title": "Client ID",
                    "options": {
                        "inputAttributes": {
                            "placeholder": "Leave blank for auto generation"
                        }
                    }
                },
                "username": {
                    "type": "string",
                    "title": "Username"
                },
                "password": {
                    "type": "string",
                    "title": "Password",
                    "format": "password"
                },
                "cleanSession": {
                    "type": "boolean",
                    "title": "Clean Session",
                    "format": "checkbox",
                    "default": true
                },
                "keepAlive": {
                    "type": "number",
                    "title": "Keep Alive Interval (sec)",
                    "default": 60
                }
            }
        },
        "OpenProtocolConnDetails": {
            "type": "object",
            "title": "Open Protocol Details",
            "options": {
                "dependencies": {
                    "connType": "Open Protocol"
                },
                "collapsed": false
            },
            "required": [
                "host",
                "port"
            ],
            "properties": {
                "host": {
                    "type": "string",
                    "title": "Hostname/IP",
                    "minLength": 1
                },
                "port": {
                    "type": "number",
                    "title": "Port",
                    "minLength": 1,
                    "default": 4545
                }
            }
        },
        "ASCIITCPConnDetails": {
            "type": "object",
            "title": "ASCII TCP Details",
            "options": {
                "dependencies": {
                    "connType": "ASCII TCP"
                },
                "collapsed": false
            },
            "required": [
                "ip",
                "port",
                "encoding",
                "delimiter",
                "keepAlive"

            ],
            "properties": {
                "ip": {
                    "type": "string",
                    "minLength": 3
                },
                "port": {
                    "type": "number",
                    "minLength": 1
                },
                "encoding": {
                    "type": "string",
                    "enum": [
                        "utf8",
                        "ascii",
                        "utf16le",
                        "ucs2",
                        "base64",
                        "latin1",
                        "binary",
                        "hex"
                    ],
                    "default": "utf8",
                    "minLength": 1
                },
                "delimiter": {
                    "type": "string",
                    "minLength": 1
                }
            }
        },
        "OPCUAConnDetails": {
            "type": "object",
            "title": "OPC-UA Server Details",
            "options": {
                "dependencies": {
                    "connType": "OPC UA"
                },
                "collapsed": false
            },
            "required": [
                "endpoint",
                "securityPolicy",
                "securityMode",
                "useCredentials"
            ],
            "properties": {
                "endpoint": {
                    "type": "string",
                    "title": "Endpoint",
                    "pattern": "^opc.tcp://.+:\\d+\/?$",
                    "options": {
                        "inputAttributes": {
                            "placeholder": "e.g. opc.tcp://myserver:1234"
                        },
                        "patternmessage": "This doesn't look like a valid OPC UA address."
                    },
                    "minLength": 1
                },
                "securityPolicy": {
                    "type": "string",
                    "title": "Security Policy",
                    "enum": [
                        "None",
                        "Basic128",
                        "Basic192",
                        "Basic192Rsa15",
                        "Basic256Rsa15",
                        "Basic256Sha256",
                        "Aes128_Sha256",
                        "Aes128_Sha256_RsaOaep",
                        "PubSub_Aes128_CTR",
                        "PubSub_Aes256_CTR",
                        "Basic128Rsa15",
                        "Basic256"
                    ],
                    "default": "None",
                    "minLength": 1
                },
                "securityMode": {
                    "type": "string",
                    "title": "Security Mode",
                    "enum": [
                        "None",
                        "Sign",
                        "SignAndEncrypt"
                    ],
                    "default": "None",
                    "minLength": 1
                },
                "useCredentials": {
                    "title": "Use credentials",
                    "type": "boolean",
                    "format": "checkbox",
                    "minLength": 1
                },
                "username": {
                    "title": "Username",
                    "type": "string",
                    "options": {
                        "dependencies": {
                            "useCredentials": true
                        }
                    },
                    "minLength": 1
                },
                "password": {
                    "type": "string",
                    "title": "Password",
                    "format": "password",
                    "options": {
                        "dependencies": {
                            "useCredentials": true
                        }
                    },
                    "minLength": 1
                }
            }
        },
        "fieldbusConnDetails": {
            "type": "object",
            "title": "Fieldbus Gateway Details",
            "options": {
                "dependencies": {
                    "connType": "Fieldbus"
                }
            },
            "required": [
                "protocol"
            ],
            "properties": {
                "protocol": {
                    "type": "string",
                    "title": "Protocol",
                    "enum": [
                        "",
                        "DMX",
                        "CANOpen",
                        "DeviceNet",
                        "EtherCAT",
                        "Ethernet/IP",
                        "ModbusRTU Gateway",
                        "ModbusTCP Gateway",
                        "Virtual Device 32 Byte",
                        "Virtual Device 32 Byte (Ext.)",
                        "Virtual ModbusTCP Slave",
                        "Virtual ModbusTCP Slave (512)",
                        "Virtual ModbusRTU Slave",
                        "Virtual ModbusRTU Slave (512)",
                        "Virtual ModbusTCP Master",
                        "Virtual ModbusRTU Master",
                        "Virtual ModbusRTU Master 150",
                        "Virtual ModbusTCP Master 150",
                        "Virtual RevPi7",
                        "Virtual RevPiTimer",
                        "Powerlink",
                        "Profibus",
                        "Profinet",
                        "SercosIII",
                        "Serial",
                        "CANopen Master",
                        "Can",
                        "M-Bus",
                        "DIO",
                        "DI",
                        "DO",
                        "AIO"
                    ],
                    "default": "",
                    "minLength": 1
                }
            }
        },
        "RESTConnDetails": {
            "type": "object",
            "title": "REST Connection Details",
            "options": {
                "dependencies": {
                    "connType": "REST"
                },
                "collapsed": false
            },
            "required": [
                "baseURL",
                "authMethod"
            ],
            "properties": {
                "baseURL": {
                    "type": "string",
                    "title": "Base URL",
                    "minLength": 1
                },
                "authMethod": {
                    "type": "string",
                    "title": "Authentication Method",
                    "enum": [
                        "None",
                        "Basic"
                    ],
                    "default": "None",
                    "minLength": 1
                },
                "username": {
                    "type": "string",
                    "title": "Username",
                    "options": {
                        "dependencies": {
                            "authMethod": "Basic"
                        }
                    },
                    "minLength": 1
                },
                "password": {
                    "type": "string",
                    "format": "password",
                    "title": "Password",
                    "options": {
                        "dependencies": {
                            "authMethod": "Basic"
                        }
                    },
                    "minLength": 1
                }
            }
        },
        "MTConnectConnDetails": {
            "type": "object",
            "title": "MTConnect Connection Details",
            "options": {
                "dependencies": {
                    "connType": "MTConnect"
                },
                "collapsed": false
            },
            "required": [
                "baseURL",
                "authMethod"
            ],
            "properties": {
                "baseURL": {
                    "type": "string",
                    "title": "Base URL",
                    "minLength": 1
                },
                "authMethod": {
                    "type": "string",
                    "title": "Authentication Method",
                    "enum": [
                        "None",
                        "Basic"
                    ],
                    "default": "None",
                    "minLength": 1
                },
                "username": {
                    "type": "string",
                    "title": "Username",
                    "options": {
                        "dependencies": {
                            "authMethod": "Basic"
                        }
                    },
                    "minLength": 1
                },
                "password": {
                    "type": "string",
                    "format": "password",
                    "title": "Password",
                    "options": {
                        "dependencies": {
                            "authMethod": "Basic"
                        }
                    },
                    "minLength": 1
                }
            }
        },
        "s7ConnDetails": {
            "type": "object",
            "title": "S7 Connection Details",
            "options": {
                "dependencies": {
                    "connType": "S7"
                },
                "collapsed": false
            },
            "required": [
                "hostname",
                "port",
                "rack",
                "slot",
                "timeout"
            ],
            "properties": {
                "hostname": {
                    "type": "string",
                    "title": "Hostname/IP Address",
                    "minLength": 1
                },
                "port": {
                    "type": "number",
                    "title": "Port",
                    "minLength": 1,
                    "default": 102
                },
                "rack": {
                    "type": "number",
                    "title": "Rack",
                    "minLength": 1
                },
                "slot": {
                    "type": "number",
                    "title": "Slot",
                    "minLength": 1
                },
                "timeout": {
                    "type": "number",
                    "title": "Timeout",
                    "default": 5000,
                    "minLength": 1
                }
            }
        },
        "pollInt": {
            "type": "number",
            "title": "Polling Interval (ms)",
            "default": 1000,
            "minLength": 1,
            "options": {
                "infoText": "Ignored for async devices"
            }
        },
        "payloadFormat": {
            "title": "Payload Format",
            "type": "string",
            "enum": [
                "Defined by Protocol",
                "Delimited String",
                "JSON",
                "XML",
                "Buffer",
                "ASCII HEX"
            ]
        },
        "delimiter": {
            "title": "Delimiter",
            "type": "string",
            "maxLength": 1,
            "options": {
                "dependencies": {
                    "payloadFormat": "Delimited String"
                }
            }
        }
    }
}