config.schema.json

{
  "pluginAlias": "myQ",
  "pluginType": "platform",
  "singular": true,
  "customUi": true,
  "headerDisplay": "[homebridge-myq](https://github.com/hjdhjd/homebridge-myq) provides HomeKit support to myQ-enabled smart garage door openers and other devices.",
  "footerDisplay": "See the [homebridge-myq developer page](https://github.com/hjdhjd/homebridge-myq) for detailed documentation, including [feature options](https://github.com/hjdhjd/homebridge-myq#feature-options).",
  "schema": {
    "type": "object",
    "properties": {

      "email": {
        "title": "myQ Email",
        "type": "string",
        "required": true,
        "placeholder": "user@example.com",
        "description": "Email address used for your myQ account.",
        "x-schema-form": {
           "type": "email"
         }
      },

      "password": {
        "title": "myQ Password",
        "type": "string",
        "required": true,
        "placeholder": "mypassword",
        "description": "Password used for your myQ account.",
        "x-schema-form": {
           "type": "password"
         }
      },

      "name": {
        "title": "Plugin Name",
        "type": "string",
        "required": true,
        "default": "myQ",
        "description": "Name to use for Homebridge logging purposes. Default: myQ."
      },

      "options": {
        "title": "Feature Options",
        "type": "array",

        "items": {
          "type": "string",
          "title": "Feature Option",
          "required": false,
          "description": "Enter only one option per entry. See the plugin documentation for the complete list of available options or use the feature options webUI tab above.",
          "placeholder": "e.g. Disable.Device.SerialNumber"
        }
      },

      "mqttTopic": {
        "type": "string",
        "title": "MQTT Base Topic",
        "required": false,
        "placeholder": "e.g. myq",
        "description": "The base MQTT topic to publish to. Default: myq."
      },

      "mqttUrl": {
        "type": "string",
        "title": "MQTT Broker URL",
        "required": false,
        "format": "uri",
        "placeholder": "e.g. mqtt://1.2.3.4",
        "description": "URL for the MQTT broker you'd like to publish event messages to. Default: None."
      },

      "refreshInterval": {
        "title": "Refresh Interval",
        "type": "integer",
        "minimum": 5,
        "maximum": 60,
        "required": false,
        "description": "Normal myQ status refresh interval, in seconds. Default: 12."
      },

      "activeRefreshInterval": {
        "title": "Active Refresh Interval",
        "type": "integer",
        "minimum": 2,
        "maximum": 10,
        "required": false,
        "description": "Refresh interval in seconds to use once device state changes are detected. Default: 3."
      },

      "activeRefreshDuration": {
        "title": "Active Refresh Duration",
        "minimum": 5,
        "maximum": 900,
        "type": "integer",
        "required": false,
        "description": "Duration in seconds to use the Active Refresh Interval to query for additional device state changes. Default: 300."
      },

      "debug": {
        "title": "Debug Logging",
        "type": "boolean",
        "required": false,
        "description": "Logging verbosity for debugging. Default: false."
      }

    }
  },

  "layout": [
    {
      "type": "section",
      "title": "myQ Login Credentials",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "description": "Enter your myQ email and password below.",
          "items": [
            "email",
            "password"
          ]
        }
      ]
    },

    {
      "type": "section",
      "title": "Plugin Feature Options (Optional)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "key": "options",
          "type": "array",
          "orderable": true,
          "title": " ",
          "description": "Use the feature options webUI tab above instead of manually configuring feature options here.",
          "buttonText": "Add Feature Option",
          "items": [
            "options[]"
          ]
        }
      ]
    },

    {
      "type": "section",
      "title": "MQTT Settings (Optional)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "description": "MQTT support will only be enabled if an MQTT broker URL is specified below.",
          "items": [
            "mqttUrl",
            "mqttTopic"
          ]
        }
      ]
    },

    {
      "type": "section",
      "title": "Advanced Settings (Optional)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "description": "These settings should be rarely used or needed by most people. Use these with caution.",
          "items": [
            "name",
            "refreshInterval",
            "activeRefreshInterval",
            "activeRefreshDuration",
            "debug"
          ]
        }
      ]
    }

  ]
}