@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",
        "required": true,
        "default": "Plugin Update",
        "description": "A unique name for the accessory. It will be used as the accessory name in HomeKit."
      },
      "sensorType": {
        "title": "Sensor Type",
        "type": "string",
        "required": true,
        "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)"
      },
      "forceNcu": {
        "title": "Force npm-check-updates",
        "type": "boolean",
        "description": "Force use of node-check-updates instead of homebridge-config-ui-x"
      }
    }
  }
}