manifest.json

{
  "author": "WebThingsIO",
  "description": "Hands-free voice addon with personalized keyword and local voice processing.",
  "gateway_specific_settings": {
    "webthings": {
      "exec": "{nodeLoader} {path}",
      "primary_type": "adapter",
      "strict_max_version": "*",
      "strict_min_version": "0.10.0"
    }
  },
  "homepage_url": "https://github.com/WebThingsIO/voice-addon",
  "id": "voice-addon",
  "license": "MPL-2.0",
  "manifest_version": 1,
  "name": "Voice Control",
  "options": {
    "default": {
      "keyword": "hey webthings",
      "speaker": "Default",
      "microphone": "Default",
      "debug": false
    },
    "schema": {
      "type": "object",
      "description": "Configuration for your voice addon",
      "properties": {
        "token": {
          "title": "Authorization Token",
          "description": "Navigate to Settings -> Developer -> Create local authorization -> Allow. Then, copy the generated JSON Web Token into this field.",
          "type": "string"
        },
        "keyword": {
          "title": "Wake Word",
          "description": "Keyword used to trigger the command.",
          "type": "string"
        },
        "speaker": {
          "title": "Speaker",
          "description": "Speaker to play audio from.",
          "type": "string",
          "enum": [
            "Default",
            "USB",
            "Custom"
          ]
        },
        "customSpeakerId": {
          "title": "Custom Speaker ID",
          "description": "(Linux) If you want to use a custom speaker, rather than one of the default choices, select 'Custom' for 'Speaker' and put the device ID here. Device IDs can be retrieved on the command line with `aplay -L | egrep '(plug)?hw:CARD='`.",
          "type": "string"
        },
        "microphone": {
          "title": "Microphone",
          "description": "Microphone to listen on.",
          "type": "string",
          "enum": [
            "Default",
            "MATRIX",
            "USB",
            "Custom"
          ]
        },
        "customMicrophoneId": {
          "title": "Custom Microphone ID",
          "description": "(Linux) If you want to use a custom microphone, rather than one of the default choices, select 'Custom' for 'Microphone' and put the device ID here. Device IDs can be retrieved on the command line with `arecord -L | egrep '(plug)?hw:CARD='`.",
          "type": "string"
        },
        "debug": {
          "title": "Enable Debugging",
          "description": "Enable additional debug logging",
          "type": "boolean"
        }
      },
      "required": [
        "token",
        "keyword",
        "speaker",
        "microphone"
      ]
    }
  },
  "short_name": "Voice",
  "version": "2.2.0"
}