config.schema.json

{
  "pluginAlias": "BlinkSecurity",
  "pluginType": "platform",
  "singular": true,
  "strictValidation": true,
  "headerDisplay": "Homebridge plugin for Amazon Blink security cameras",
  "footerDisplay": "For documentation please see [GitHub](https://github.com/BitWise-0x/homebridge-blink-security)",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "default": "Blink Security",
        "type": "string"
      },
      "username": {
        "title": "Email",
        "type": "string",
        "format": "email"
      },
      "password": {
        "title": "Password",
        "type": "string"
      },
      "pin": {
        "title": "2FA Verification Code",
        "description": "Enter the 2FA verification code sent to your email/phone after the first auth attempt, then restart Homebridge",
        "type": "string"
      },
      "hide-alarm": {
        "title": "Hide Alarm (Security System)",
        "placeholder": true,
        "description": "When combined with the arm switch (used for automation), the Security System will have to be controlled by the Blink App.",
        "type": "boolean"
      },
      "hide-manual-arm-switch": {
        "title": "Hide Sync Module Arm Switch",
        "placeholder": true,
        "description": "The Sync Module Arm switch allows for automations to arm / disarm all cameras associated with a sync module.",
        "type": "boolean"
      },
      "hide-temperature-sensor": {
        "title": "Hide Camera Temperature Sensors",
        "placeholder": false,
        "type": "boolean"
      },
      "hide-enabled-switch": {
        "title": "Hide Camera Motion Enabled/Disable Switch",
        "placeholder": false,
        "type": "boolean"
      },
      "hide-privacy-switch": {
        "title": "Hide Camera Privacy-Mode Enable/Disable Switch",
        "placeholder": false,
        "description": "Privacy-Mode prevents thumbnails from refreshing when the Security System is not armed. Disabling this switch will globally disable privacy-mode on all cameras.",
        "type": "boolean"
      },
      "hide-cameras": {
        "title": "Hide Camera Accessories",
        "placeholder": false,
        "description": "Removes cameras from HomeKit. Any associated automations/scenes will have to be recreated if you want them back later.",
        "type": "boolean"
      },
      "hide-doorbells": {
        "title": "Hide Doorbell Accessories",
        "placeholder": false,
        "description": "Removes doorbells from HomeKit. Any associated automations/scenes will have to be recreated if you want them back later.",
        "type": "boolean"
      },
      "enable-liveview": {
        "title": "Enable LiveView when clicking on a camera feed",
        "default": true,
        "description": "When enabled, clicking a camera feed will start a live stream relay. When disabled, only the last recorded thumbnail is shown.",
        "type": "boolean"
      },
      "lv-save": {
        "title": "Save Live View Clips",
        "default": false,
        "description": "When enabled, Blink will save a clip for every live view session. When disabled (default), live view streams are not recorded. This controls the per-network 'Save all Live Views' setting on your Blink account.",
        "type": "boolean"
      },
      "disable-thumbnail-refresh": {
        "title": "Disable thumbnail auto-refresh",
        "default": false,
        "description": "By default, the thumbnails of the cameras will refresh when the camera is enabled, disabling the auto refresh keeps the default thumbnail untouched.",
        "type": "boolean"
      },
      "blink-status-polling-seconds": {
        "title": "Blink Status Polling (seconds)",
        "type": "integer",
        "default": 10,
        "minimum": 1,
        "maximum": 300,
        "placeholder": "10",
        "description": "Interval (seconds) between Blink system refreshes (range 1–300). Default 10. Lower values may trigger Blink rate-limiting; higher values reduce API load but delay arm/disarm state updates."
      },
      "camera-thumbnail-refresh-seconds": {
        "title": "Camera Thumbnail Refresh (seconds)",
        "type": "integer",
        "minimum": 0,
        "placeholder": "3600",
        "description": "Minimum interval (seconds) between Blink cloud thumbnail refreshes per camera. Controls how often the plugin asks a camera to capture a new thumbnail — not how often HomeKit displays them. HomeKit's own snapshot polling (~10s while the Home app is foregrounded, ~60s backgrounded) is served from cache between refreshes. Default 3600. Ignored if auto refresh is disabled."
      },
      "camera-status-polling-seconds": {
        "title": "Camera Status Polling (seconds)",
        "type": "integer",
        "minimum": 1,
        "placeholder": "30",
        "description": "Camera status does not update live and must be fetched periodically. By default this is done every 30 seconds."
      },
      "camera-motion-polling-seconds": {
        "title": "Camera Motion Polling (seconds)",
        "type": "integer",
        "minimum": 0,
        "placeholder": "15",
        "description": "Camera motion detection does not update live and must be fetched periodically. By default this is done every 15 seconds."
      },
      "logging": {
        "title": "Advanced Logging",
        "type": "string",
        "oneOf": [
          { "title": "Quiet (suppress routine chatter)", "enum": ["quiet"] },
          { "title": "Verbose", "enum": ["verbose"] },
          { "title": "Debug", "enum": ["debug"] }
        ]
      },
      "enable-startup-diagnostic": {
        "title": "Enable Diagnostic Logging on startup",
        "default": false,
        "type": "boolean"
      },
      "enable-audio": {
        "title": "Enable Audio in Live View",
        "default": false,
        "description": "Enable one-way audio in HomeKit Live View. Requires Audio Streaming to also be enabled in the Blink app under Device Settings → Privacy.",
        "type": "boolean"
      }
    },
    "required": ["username", "password"]
  },
  "layout": [
    { "key": "name", "title": "Name" },
    {
      "type": "section",
      "title": "Authentication",
      "expandable": true,
      "expanded": true,
      "items": ["username", "password", "pin"]
    },
    {
      "type": "section",
      "title": "Features",
      "expandable": true,
      "expanded": false,
      "items": [
        "hide-alarm",
        "hide-manual-arm-switch",
        "hide-enabled-switch",
        "hide-privacy-switch",
        "hide-cameras",
        "hide-doorbells",
        "disable-thumbnail-refresh",
        "hide-temperature-sensor",
        "enable-liveview",
        "enable-audio",
        "lv-save"
      ]
    },
    {
      "type": "section",
      "title": "Advanced Settings",
      "expandable": true,
      "expanded": false,
      "items": [
        "blink-status-polling-seconds",
        "camera-thumbnail-refresh-seconds",
        "camera-status-polling-seconds",
        "camera-motion-polling-seconds",
        "logging",
        "enable-startup-diagnostic"
      ]
    }
  ]
}