config.schema.json

{
  "pluginAlias": "HomebridgeAlexaSmartHome",
  "pluginType": "platform",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "devices": {
        "title": "Include device names",
        "description": "List of smart home device names to add as HomeKit accessories. If no devices are specified, the plugin will attempt to add all supported accessories.",
        "type": "array",
        "uniqueItems": true,
        "required": true,
        "default": [],
        "items": {
          "title": "Device name",
          "type": "string"
        }
      },
      "excludeDevices": {
        "title": "Exclude devices",
        "description": "List of smart home device names to exclude from being added as HomeKit accessories. Exclude devices will only be excluded if 'Include device names' is empty.",
        "type": "array",
        "uniqueItems": true,
        "required": true,
        "default": [],
        "items": {
          "title": "Device name",
          "type": "string"
        }
      },
      "amazonDomain": {
        "title": "Amazon domain",
        "type": "string",
        "description": "The Amazon domain that your devices are registered to.",
        "required": false,
        "default": "amazon.com",
        "oneOf": [
          { "title": "amazon.com", "enum": ["amazon.com"] },
          { "title": "amazon.ca", "enum": ["amazon.ca"] },
          { "title": "amazon.de", "enum": ["amazon.de"] },
          { "title": "amazon.es", "enum": ["amazon.es"] },
          { "title": "amazon.fr", "enum": ["amazon.fr"] },
          { "title": "amazon.it", "enum": ["amazon.it"] },
          { "title": "amazon.in", "enum": ["amazon.in"] },
          { "title": "amazon.nl", "enum": ["amazon.nl"] },
          { "title": "amazon.co.jp", "enum": ["amazon.co.jp"] },
          { "title": "amazon.co.uk", "enum": ["amazon.co.uk"] },
          { "title": "amazon.com.au", "enum": ["amazon.com.au"] },
          { "title": "amazon.com.br", "enum": ["amazon.com.br"] },
          { "title": "amazon.com.mx", "enum": ["amazon.com.mx"] }
        ]
      },
      "language": {
        "title": "Two character language code hyphen two character country code",
        "description": "Language for Alexa authentication.",
        "type": "string",
        "required": false,
        "default": "en-US"
      },
      "auth": {
        "title": "Authorization and authentication settings",
        "type": "object",
        "required": true,
        "properties": {
          "refreshInterval": {
            "title": "Refresh interval",
            "placeholder": "Refresh the session automatically every __ days",
            "description": "How often this plugin should automatically refresh the session with Amazon. Defaults to every 4 days.",
            "type": "number",
            "required": false,
            "default": 4
          },
          "proxy": {
            "title": "Proxy Client Host",
            "type": "object",
            "properties": {
              "clientHost": {
                "title": "Proxy Client Host",
                "placeholder": "e.g., 192.168.1.234, homebridge.local, localhost",
                "description": "A current IP address or hostname of the Homebridge host that is accessible from the web browser where you will authenticate from.",
                "type": "string",
                "required": true
              },
              "port": {
                "title": "Proxy port",
                "placeholder": "e.g., 2345",
                "description": "The port to run the authentication proxy on.",
                "type": "integer",
                "required": true,
                "minimum": 7000,
                "maximum": 9999,
                "default": 9000
              }
            }
          }
        }
      },
      "performance": {
        "title": "Performance",
        "type": "object",
        "required": false,
        "properties": {
          "cacheTTL": {
            "title": "Device state cache lifetime",
            "description": "Refresh Alexa device states every __ seconds. Higher values will allow this plugin to work faster if you are noticing 'This plugin slows down Homebridge' messages in the Homebridge logs. However, higher values also means device states may be less accurate.",
            "type": "integer",
            "required": false,
            "minimum": 15,
            "maximum": 600,
            "default": 30
          },
          "backgroundRefresh": {
            "title": "Refresh device states automatically in the background.",
            "description": "By default, device states are only updated when requested. For example, when the Home app is opened. If you notice 'This plugin slows down Homebridge' messages in the Homebridge logs, it is recommended to enable background refresh and set the 'Device state cache lifetime' to a value of 300 or more.",
            "type": "boolean",
            "required": false,
            "default": false
          }
        }
      },
      "debug": {
        "title": "Debug logging",
        "description": "Whether to enable debug logging for troubleshooting issues and support.",
        "type": "boolean",
        "required": false,
        "default": false
      }
    }
  }
}