homebridge-denon-heos-audio/config.schema.json

Control your Denon speakers via AVR Control and/or HeosCLI

{
  "pluginAlias": "DenonHeosAudio",
  "pluginType": "platform",
  "singular": true,
  "strictValidation": true,
  "schema": {
    "type": "object",
    "properties": {
      "deviceDiscovery": {
        "title": "Device Discovery",
        "description": "Enable to automatically discover Denon devices on your network. (Found devices will be listed in the homebridge log after the plugin has started. Ensure that your homebridge's log level is at least set to 'info' or enable the debug log below.)",
        "type": "boolean",
        "required": false,
        "default": true
      },
      "devices": {
        "title": "Devices",
        "description": "Add your Denon devices here.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "title": "Name",
              "type": "string",
              "placeholder": "Give your speaker a name",
              "required": true
            },
            "serialNumber": {
              "title": "Serial Number",
              "description": "If you don't know your device's serial number, use 'device discovery' to find it.",
              "type": "string",
              "required": true
            },
            "ip": {
              "title": "IP Address",
              "description": "Please assign a static IP address to your device and enter it here.",
              "type": "string",
              "format": "ipv4",
              "required": true
            },
            "controlProtocol": {
              "title": "Control Protocol",
              "type": "string",
              "oneOf": [
                {
                  "const": "AVRCONTROL",
                  "title": "AVR Control"
                },
                {
                  "const": "HEOSCLI",
                  "title": "Heos CLI"
                },
                {
                  "const": "HYBRID",
                  "title": "Hybrid"
                }
              ],
              "required": true
            },
            "volumeLimitEnabled": {
              "title": "Volume Limit",
              "description": "When you set a volume limit, 100% volume in HomeKit will correspond to this percentage on your device.",
              "type": "boolean",
              "required": false,
              "default": false
            },
            "volumeLimit": {
              "description": "only has an effect if volume limit is enabled above",
              "type": "integer",
              "required": false,
              "minimum": 0,
              "maximum": 99,
              "default": 99
            },
            "volumeStepSize": {
              "title": "Volume Step Size",
              "description": "Determines how many percentage points the volume is increased or descreased when volume up or down is pressed. This is measured in the device's percentage points - not converted for volume limit.",
              "type": "integer",
              "required": false,
              "minimum": 1,
              "maximum": 10,
              "default": 2
            }
          }
        }
      },
      "consoleLogEnabled": {
        "title": "Console Log",
        "description": "Diverts the log messages directly to the console. This is only intended for debugging purposes.",
        "type": "boolean",
        "required": false,
        "default": false
      },
      "consoleLogLevel": {
        "title": "Log Level",
        "description": "If console log is enabled, only log messages at this log level or below it will be displayed in the console.",
        "type": "string",
        "enum": ["error", "warn", "success", "info", "debug"],
        "required": false,
        "default": "debug"
      }
    }
  }
}