homebridge-arlo-v2/config.schema.json

Arlo plugin for homebridge

{
  "pluginAlias": "Arlo v2",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "The **Homebridge Arlo** plugin allows you to control your Arlo base station.",
  "footerDisplay": "Please raise any issues on our [project page](https://github.com/wo-d/homebridge-arlo/issues).",
  "schema": {
    "type": "object",
    "properties": {
      "arloUser": {
        "type": "string",
        "title": "Arlo User",
        "placeholder": "Arlo user",
        "required": true
      },
      "arloPassword": {
        "type": "string",
        "title": "Arlo Password",
        "placeholder": "Arlo password",
        "required": true
      },
      "emailUser": {
        "type": "string",
        "title": "MFA Email Address",
        "placeholder": "Email address registered to receive MFA",
        "required": true
      },
      "emailPassword": {
        "type": "string",
        "title": "Email Password",
        "placeholder": "Email password",
        "required": true
      },
      "emailServer": {
        "type": "string",
        "title": "Email IMAP Server",
        "placeholder": "Email IMAP server. E.g. `imap.gmail.com`",
        "required": true
      },
      "emailImapPort": {
        "type": "number",
        "title": "Email IMAP Port",
        "placeholder": "Email IMAP server port, E.g. 993",
        "required": true
      },
      "enableRetry": {
        "title": "Enable Retry",
        "type": "boolean",
        "required": true,
        "default": true,
        "description": "Enable retries. If a stream is closed for any reason will retry to establish connection."
      },
      "retryInterval": {
        "title": "Retry Interval",
        "type": "number",
        "required": true,
        "default": 5,
        "description": "Define the time in minutes between retry attempts."
      },
      "debug": {
        "title": "Debug Logging",
        "type": "boolean",
        "required": false,
        "default": false,
        "description": "Logging verbosity for debugging."
      }
    }
  },
  "layout": [
    {
      "type": "section",
      "title": "General Options",
      "expandable": true,
      "expanded": true,
      "items": [
        {
          "description": "Enter your credentials below.",
          "items": [
            "arloUser",
            "arloPassword",
            "emailUser",
            "emailPassword",
            "emailServer",
            "emailImapPort"
          ]
        }
      ]
    },
    {
      "type": "section",
      "title": "Recovery",
      "expandable": true,
      "expanded": true,
      "items": [
        {
          "description": "Enter recovery options below.",
          "items": ["enableRetry", "retryInterval"]
        }
      ]
    },
    {
      "type": "section",
      "title": "Advanced Settings (Optional)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "description": "These settings should not be necessary for most installations.",
          "items": ["debug"]
        }
      ]
    }
  ]
}