@homebridge-plugins/homebridge-plugin-update-check/config.schema.json

A Homebridge plugin for checking for updates to Homebridge and plugins

{
  "pluginAlias": "PluginUpdate",
  "pluginType": "platform",
  "singular": true,
  "customUi": true,
  "customUiPath": "./dist/homebridge-ui",
  "headerDisplay": "A Homebridge plugin for checking for updates to Homebridge and plugins.",
  "footerDisplay": "Raise [Issues](https://github.com/Sunoo/homebridge-plugin-update-check/issues) or submit [Pull Requests](https://github.com/Sunoo/homebridge-plugin-update-check/pulls) on [Project Page](https://github.com/Sunoo/homebridge-plugin-update-check).",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "default": "Plugin Update",
        "description": "A unique name for the accessory. It will be used as the accessory name in HomeKit. Can only contain letters, numbers, spaces, hyphens, and underscores. Periods and other special characters are not allowed as they can cause HomeKit pairing issues.",
        "pattern": "^[a-zA-Z0-9\\s_-]+$",
        "minLength": 1,
        "maxLength": 64
      },
      "sensorType": {
        "title": "Sensor Type",
        "type": "string",
        "default": "motion",
        "description": "What type of sensor will be exposed to HomeKit.",
        "oneOf": [
          {
            "title": "Motion Sensor",
            "enum": ["motion"]
          },
          {
            "title": "Contact Sensor",
            "enum": ["contact"]
          },
          {
            "title": "Occupancy Sensor",
            "enum": ["occupancy"]
          },
          {
            "title": "Humidity Sensor",
            "enum": ["humidity"]
          },
          {
            "title": "Light Sensor",
            "enum": ["light"]
          },
          {
            "title": "Air Quality Sensor",
            "enum": ["air"]
          },
          {
            "title": "Leak Sensor",
            "enum": ["leak"]
          },
          {
            "title": "Smoke Sensor",
            "enum": ["smoke"]
          },
          {
            "title": "Carbon Dioxide Sensor",
            "enum": ["dioxide"]
          },
          {
            "title": "Carbon Monoxide Sensor",
            "enum": ["monoxide"]
          }
        ]
      },
      "checkHomebridgeUpdates": {
        "title": "Check for Homebridge updates",
        "type": "boolean",
        "description": "Check if an update is available for the Homebridge server",
        "default": true
      },
      "checkHomebridgeUIUpdates": {
        "title": "Check for Homebridge Config UI updates",
        "type": "boolean",
        "description": "Check if an update is available for the Homebridge UI",
        "default": true
      },
      "checkPluginUpdates": {
        "title": "Check for plugin updates",
        "type": "boolean",
        "description": "Check if updates are available for any installed plugins",
        "default": true
      },
      "checkDockerUpdates": {
        "title": "Check for Docker image updates",
        "type": "boolean",
        "description": "Check if Docker image updates are available (ignored if not running in Docker container)"
      },
      "initialCheckDelay": {
        "title": "Initial Check Delay (seconds)",
        "type": "integer",
        "description": "Delay in seconds before performing the initial update check after startup",
        "default": 10,
        "minimum": 0,
        "maximum": 300
      },
      "autoUpdateHomebridge": {
        "title": "Auto-update Homebridge",
        "type": "boolean",
        "description": "Automatically install Homebridge updates when available (requires homebridge-config-ui-x and sufficient npm privileges)",
        "default": false
      },
      "autoUpdateHomebridgeUI": {
        "title": "Auto-update Homebridge Config UI",
        "type": "boolean",
        "description": "Automatically install Homebridge Config UI updates when available (requires homebridge-config-ui-x and sufficient npm privileges)",
        "default": false
      },
      "autoUpdatePlugins": {
        "title": "Auto-update plugins",
        "type": "boolean",
        "description": "Automatically install plugin updates when available (requires homebridge-config-ui-x and sufficient npm privileges)",
        "default": false
      },
      "allowDirectNpmUpdates": {
        "title": "Allow direct npm updates",
        "type": "boolean",
        "description": "Allow automatic updates using direct npm commands even when homebridge-config-ui-x is not available (requires sufficient npm privileges)",
        "default": false
      },
      "autoRestartAfterUpdates": {
        "title": "Auto-restart after updates",
        "type": "boolean",
        "description": "Automatically restart Homebridge after successful automatic updates to apply changes",
        "default": false
      },
      "failureSensorType": {
        "title": "Failure Sensor Type",
        "type": "string",
        "default": "motion",
        "description": "What type of sensor will be used for update/restart failure notifications (only shown when auto-updates are enabled).",
        "oneOf": [
          {
            "title": "Motion Sensor",
            "enum": ["motion"]
          },
          {
            "title": "Contact Sensor",
            "enum": ["contact"]
          },
          {
            "title": "Occupancy Sensor",
            "enum": ["occupancy"]
          },
          {
            "title": "Humidity Sensor",
            "enum": ["humidity"]
          },
          {
            "title": "Light Sensor",
            "enum": ["light"]
          },
          {
            "title": "Air Quality Sensor",
            "enum": ["air"]
          },
          {
            "title": "Leak Sensor",
            "enum": ["leak"]
          },
          {
            "title": "Smoke Sensor",
            "enum": ["smoke"]
          },
          {
            "title": "Carbon Dioxide Sensor",
            "enum": ["dioxide"]
          },
          {
            "title": "Carbon Monoxide Sensor",
            "enum": ["monoxide"]
          }
        ]
      },
      "respectDisabledPlugins": {
        "title": "Respect disabled plugin update notifications",
        "type": "boolean",
        "description": "When enabled, respects the 'Hide update notifications for this plugin' setting from homebridge-config-ui-x. Plugins marked to hide updates will not trigger notifications.",
        "default": true
      },
      "": {
        "title": "",
        "description": "Note: This feature may require updating Homebridge UI to a newer varsion. It is recommended to update to the latest version.",
        "type": "object",
        "properties": {}
      }
    },
    "required": ["name", "sensorType"]
  }
}