config.schema.json

{
  "pluginAlias": "ZP",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "Homebridge plugin for Sonos ZonePlayer",
  "footerDisplay": "",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "description": "Plugin name as displayed in the homebridge log.",
        "type": "string",
        "required": true,
        "default": "Sonos"
      },
      "address": {
        "description": "IPv4 address to use for webserver receiving zone player notifications.  Default: automatically discovered.",
        "type": "string",
        "format": "ipv4"
      },
      "alarms": {
        "description": "Create an additional Switch service for each alarm.",
        "type": "boolean"
      },
      "brightness": {
        "description": "Expose volume as Brightness.",
        "type": "boolean"
      },
      "excludeAirPlay": {
        "title": "Exclude AirPlay 2",
        "description": "Exclude AirPlay 2 zone players that are already exposed to Apple's Home app.",
        "type": "boolean"
      },
      "forceS2": {
        "title": "Expose only S2 players",
        "description": "Set in a Split Sonos System to prevent accidentally exposing the S1 players.",
        "type": "boolean"
      },
      "heartrate": {
        "description": "Interval (in seconds) to poll zone player.  Default: disabled.",
        "type": "integer"
      },
      "leds": {
        "title": "LEDs",
        "description": "Create an additional Lightbulb service for the LED.  Also create an accessory for each slave zone player.",
        "type": "boolean"
      },
      "nameScheme": {
        "description": "Accessory name (use '%' for Zone name).  Default: '% Sonos'.",
        "type": "string"
      },
      "port": {
        "description": "Port to use for webserver receiving ZonePlayer notifications.  Default: random.",
        "type": "integer",
        "maximum": 65535
      },
      "resetTimeout": {
        "description": "Timeout (in milliseconds) to reset input.  Default: 500.",
        "type": "integer"
      },
      "service": {
        "description": "HomeKit service type for Sonos and Switch services.",
        "type": "string",
        "required": true,
        "default": "switch",
        "oneOf": [
          {
            "title": "Switch",
            "enum": [ "switch" ]
          },
          {
            "title": "Lightbulb",
            "enum": [ "light" ]
          },
          {
            "title": "Speaker",
            "enum": [ "speaker" ]
          },
          {
            "title": "Fan",
            "enum": [ "fan" ]
          }
        ]
      },
      "speakers": {
	      "description": "Create an additional Speaker service for each zone.",
        "type": "boolean"
      },
      "subscriptionTimeout": {
        "description": "Duration (in minutes) of subscriptions to ZonePlayer notifications.  Default: 30.",
        "type": "integer"
      },
      "timeout": {
        "description": "Timeout (in seconds) to wait for a response from a Sonos ZonePlayer.  Default: 15.",
        "type": "integer"
      },
      "tv": {
        "title": "TV",
        "description": "Create an additional, non-bridged TV accessory for each zone.",
      	"type": "boolean"
      },
      "tvIdPrefix": {
        "title": "TV ID Prefix",
        "description": "Prefix for serial number of TV accessories.  Default: 'TV'",
        "type": "string"
      }
    }
  },
  "form": [
    "name",
    {
      "type": "fieldset",
      "expandable": true,
      "title": "What",
      "description": "Select what to expose to HomeKit for each zone.",
      "items": [
        "forceS2",
        "speakers",
        "alarms",
        "leds",
        {
          "key": "heartrate",
          "condition": { "functionBody": "return model.leds" }
        },
        "excludeAirPlay"
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "title": "How",
      "description": "Select how to expose a zone to HomeKit.",
      "items": [
        "service",
	      {
          "key": "brightness",
          "condition": { "functionBody": "return model.service === 'switch' || model.service === 'speaker'" }
        },
        "tv",
        "nameScheme"
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "title": "Advanced Settings",
      "description": "Don't change these, unless you understand what you're doing.",
      "items": [
        "resetTimeout",
        "subscriptionTimeout",
        "timeout",
        "host",
        "port",
        "tvIdPrefix"
      ]
    }
  ]
}