homebridge-owntone-radio/config.schema.json

A homebridge plugin to play radio web streams using owntone

{
  "pluginAlias": "owntone-radio",
  "pluginType": "accessory",
  "singular": false,
  "headerDisplay": "For more infomation on plugin configuration, please see the <a href='https://github.com/joepool/homebridge-owntone-radio/blob/main/README.md'>readme</a>",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "description": "The name of the switch in HomeKit, this can be anything.",
        "required": true
      },
      "serverip":{
        "title": "Server IP Address",
        "type": "string",
        "description": "The IPv4 address of your OwnTone Server. Leave blank for localhost",
        "format": "ipv4",
        "required": false
      },
      "serverport":{
        "title": "Server Port",
        "type": "string",
        "description": "The port of your OwnTone Server. Leave black if unchanged from default",
        "placeholder": "3689",
        "minLength": 4,
        "maxLength": 4,
        "required": false
      },
      "device_discovery":{
        "title": "Device Discovery",
        "type": "boolean",
        "description": "Device discovery option. <a href='https://github.com/joepool/homebridge-owntone-radio/blob/main/README.md#Initial-Configuration'>See readme for details.</a>",
        "default": false
      },
      "station_discovery":{
        "title": "Station Discovery",
        "type": "boolean",
        "description": "Station discovery option. <a href='https://github.com/joepool/homebridge-owntone-radio/blob/main/README.md#Initial-Configuration'>See readme for details.</a>",
        "default": false
      },
      "id":{
        "title": "Device ID",
        "type": "string",
        "description": "ID of device can be found using device discovery. <a href='https://github.com/joepool/homebridge-owntone-radio/blob/main/README.md#Basic-Configuration'>See readme for details.</a>",
        "minLength": 14,
        "maxLength": 16,
        "required": true,
        "condition": {
          "functionBody": "return model.device_discovery === false && model.station_discovery === false;"
        }
      },
      "stationuri":{
        "title": "Station URI",
        "type": "string",
        "description": "URI of station to be played. <a href='https://github.com/joepool/homebridge-owntone-radio/blob/main/README.md#Basic-Configuration'>See readme for details.</a>",
        "placeholder": "library:track:x",
        "format": "uri",
        "required": true,
        "condition": {
          "functionBody": "return model.device_discovery === false && model.station_discovery === false;"
        }
      }
    }
  },
  "form": null,
  "display": null
}