config.schema.json

{
  "pluginAlias": "HomebridgeSpotifySpeaker",
  "pluginType": "platform",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "HomebridgeSpotifySpeaker"
      },
      "spotifyClientId": {
        "title": "Spotify Client ID",
        "type": "string",
        "required": true
      },
      "spotifyClientSecret": {
        "title": "Spotify Client Secret",
        "type": "string",
        "required": true
      },
      "spotifyRedirectUri": {
        "title": "Spotify Redirect URI",
        "type": "string",
        "default": "https://example.com/callback",
        "required": true
      },
      "spotifyAuthCode": {
        "title": "Spotify Auth Code",
        "type": "string",
        "required": true
      },
      "spotifyPollInterval": {
        "title": "Status polling interval",
        "type": "integer",
        "default": 20,
        "minimum": 20,
        "maximum": 600,
        "placeholder": "Get speaker status every __ seconds",
        "description": "Speaker status does not update live and must be fetched periodically. This is done every 20 seconds by default"
      },
      "devices": {
        "type": "array",
        "items": {
          "title": "Device",
          "type": "object",
          "properties": {
            "deviceName": {
              "title": "Device Name",
              "description": "Friendly device name that will be displayed in Homekit.",
              "type": "string",
              "required": true
            },
            "deviceType": {
              "title": "Device Type",
              "description": "Only speaker is supported for now. This tells the plugin to either use a lightbulb (speaker) or smart speaker in Homekit.",
              "type": "string",
              "required": false,
              "default": "speaker",
              "enum": ["speaker"]
            },
            "spotifyDeviceId": {
              "title": "Spotify Device ID",
              "description": "The Spotify Device ID. You can find a list of available device in the plugin's logs when it starts or see the README",
              "type": "string",
              "required": true
            },
            "spotifyPlaylistUrl": {
              "title": "Spotify Playlist URL",
              "description": "The URL of the Spotify playlist that you want to play when this device will be set to ON in Homekit.",
              "type": "string",
              "required": false
            },
            "playlistShuffle": {
              "title": "Spotify playlist shuffle",
              "description": "Whether to enable shuffle which randomizes the order tracks in the playlist are played",
              "type": "boolean",
              "required": false,
              "default": true
            },
            "playlistRepeat": {
              "title": "Spotify playlist repeat",
              "description": "Whether to repeat the entire playlist once all tracks have been played.",
              "type": "boolean",
              "required": false,
              "default": false
            }
          }
        }
      }
    }
  }
}