mqtt-config-schema.coffee

module.exports = {
  title: "MQTT plugin config options"
  type: "object"
  properties:
    debug:
      description: "Debug mode. Writes debug messages to the pimatic log, if set to true."
      type: "boolean"
      default: false
    brokers:
      description: "List of MQTT brokers"
      type: "array"
      format: "table"
      items:
        type: "object"
        properties:
          brokerId:
            description: "The brokerId of the MQTT broker which can be set for each device. Use 'default' for default Broker"
            type: "string"
            default: "default"
          host:
            description: "The IP or hostname of the MQTT broker (Default: 127.0.0.1)"
            type: "string"
            default: "127.0.0.1"
          port:
            description: "The port of the MQTT broker (Default: 1883)"
            type: "integer"
            default: 1883
          keepalive:
            description: "keepalive in seconds"
            type: "integer"
            default: 180
          clientId:
            description: "Client Id"
            type: "string"
            default: ""
          protocolId:
            description: "MQTT protocol ID"
            type: "string"
            default: "MQTT"
          protocolVer:
            description: "MQTT protocol version"
            type: "integer"
            default: 4
          cleanSession:
            description: "Set to false to receive QoS 1 and 2 messages while offline"
            type: "boolean"
            default: true
          reconnect:
            description: "reconnectPeriod in milliseconds"
            type: "integer"
            default: 10000
          timeout:
            description: "connectTimeout in milliseconds"
            type: "integer"
            default: 30000
          username:
            description: "The login name"
            type: "string"
            default: ""
          password:
            description: "The password"
            type: "string"
            default: ""
          queueQoSZero:
            description: "If connection is broken, queue outgoing QoS zero messages"
            type: "boolean"
            default: true
          certPath:
            description: "Path to the certificate of the client in PEM format, required for TLS connection"
            type: "string"
            default: ""
          keyPath:
            description: "Path to the key of the client in PEM format, required for TLS connection"
            type: "string"
            default: ""
          rejectUnauthorized:
            description: "Whether to reject self signed certificates"
            type: "boolean"
            default: true
          ca:
            description: "Path to the trusted CA list"
            type: "string"
            default: ""
          ssl:
            description: "Force the use of TLS/SSL"
            type: "boolean"
            default: false
}