homebridge-oppo-udp/config.schema.json

Homebridge Plugin to control your Oppo 203/205.

{
  "pluginAlias": "oppoPlugin",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "This plugin is provided by [carlosgamezvillegas](https://github.com/carlosgamezvillegas/). The device must be [added manually](https://github.com/carlosgamezvillegas/homebridge-plugin-oppo#adding-the-oppo-to-the-home-app) in the Home app.",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "Oppo 203"
      },
      "ip": {
        "title": "IP Address",
        "type": "string",
        "placeholders": "192.168.1.1",
        "format": "ipv4",
        "required": true
      },
      "pollingInterval": {
        "title": "Polling Interval (milliseconds)",
        "type": "integer",
        "placeholders": "5000",
        "default": 5000,
        "minimum": 5000,
        "maximum": 60000,
        "required": false
      },
      "modelName": {
        "title": "Model",
        "type": "string",
        "placeholders": "UDP-203",
        "required": false
      },
      "manufacture": {
        "title": "Manufacturer",
        "type": "string",
        "placeholders": "Oppo",
        "required": false
      },
      "serialN": {
        "title": "Serial Number",
        "type": "string",
        "placeholders": "EB1234213F",
        "required": false
      },
      "newPlatformUUID": {
        "title": "New Platform UUID",
        "type": "boolean",
        "required": false
      },
      "volume": {
        "title": "Add Volume service as a dimmer",
        "type": "boolean",
        "required": false
      },
      "oppo205": {
        "title": "Add additional Inputs for Oppo 205",
        "type": "boolean",
        "required": false
      },
      "mediaButtons": {
        "title": "Add Media Remote Control buttons (Next, Previous, Forward, Rewind)",
        "type": "boolean",
        "required": false
      },
      "remainMovieTimer": {
        "title": "Add Movie Timer",
        "type": "boolean",
        "required": false
      },
      "movieControl": {
        "title": "Add Movie Progress as a dimmer",
        "type": "boolean",
        "required": false
      },
      "chapterControl": {
        "title": "Add Chapter Progress as a dimmer",
        "type": "boolean",
        "required": false
      },
      "chapterSelector": {
        "title": "Add Chapter Selector as a dimmer",
        "type": "boolean",
        "required": false
      },
      "mediaAudioVideoState": {
        "title": "Add the Audio and Video Format as motion sensors",
        "type": "boolean",
        "required": false
      },
      "chinoppo": {
        "title": "Add Wake Up support for Oppo clones (Chinoppos)",
        "type": "boolean",
        "required": false
      },
      "inputButtons": {
        "title": "Add Input Remote Control buttons",
        "type": "boolean",
        "required": false
      },
      "cursorUpB": {
        "title": "Add the Cursor Up button",
        "type": "boolean",
        "required": false
      },
      "cursorDownB": {
        "title": "Add the Cursor Down button",
        "type": "boolean",
        "required": false
      },
      "cursorLeftB": {
        "title": "Add the Cursor Left button",
        "type": "boolean",
        "required": false
      },
      "cursorRightB": {
        "title": "Add the Cursor Right button",
        "type": "boolean",
        "required": false
      },
      "cursorEnterB": {
        "title": "Add the Enter button",
        "type": "boolean",
        "required": false
      },
      "menuB": {
        "title": "Add the Menu button",
        "type": "boolean",
        "required": false
      },
      "backButtonB": {
        "title": "Add the Back button",
        "type": "boolean",
        "required": false
      },
      "clearB": {
        "title": "Add the Clear button",
        "type": "boolean",
        "required": false
      },
      "topMenuB": {
        "title": "Add the Top Menu button",
        "type": "boolean",
        "required": false
      },
      "optionB": {
        "title": "Add the Option button",
        "type": "boolean",
        "required": false
      },
      "homeMenuB": {
        "title": "Add the Home Menu button",
        "type": "boolean",
        "required": false
      },
      "infoB": {
        "title": "Add the Info button",
        "type": "boolean",
        "required": false
      },
      "setupB": {
        "title": "Add the Setup button",
        "type": "boolean",
        "required": false
      },
      "goToB": {
        "title": "Add the Go To button",
        "type": "boolean",
        "required": false
      },
      "pageUpB": {
        "title": "Add the Page Up button",
        "type": "boolean",
        "required": false
      },
      "pageDownB": {
        "title": "Add the Page Down button",
        "type": "boolean",
        "required": false
      },
      "popUpMenuB": {
        "title": "Add the Pop Up Menu button",
        "type": "boolean",
        "required": false
      },
      "dimmerB": {
        "title": "Add the Dimmer button",
        "type": "boolean",
        "required": false
      },
      "pureAudioB": {
        "title": "Add the Pure Audio button",
        "type": "boolean",
        "required": false
      },
      "redB": {
        "title": "Add the Red button",
        "type": "boolean",
        "required": false
      },
      "yellowB": {
        "title": "Add the Yellow button",
        "type": "boolean",
        "required": false
      },
      "blueB": {
        "title": "Add the Blue button",
        "type": "boolean",
        "required": false
      },
      "greenB": {
        "title": "Add the Green button",
        "type": "boolean",
        "required": false
      },
      "audioB": {
        "title": "Add the Audio button",
        "type": "boolean",
        "required": false
      },
      "subtitleB": {
        "title": "Add the Subtitle button",
        "type": "boolean",
        "required": false
      },
      "angleB": {
        "title": "Add the Angle button",
        "type": "boolean",
        "required": false
      },
      "zoomB": {
        "title": "Add the Zoom button",
        "type": "boolean",
        "required": false
      },
      "sapB": {
        "title": "Add the SAP button",
        "type": "boolean",
        "required": false
      },
      "abReplayB": {
        "title": "Add the AB Replay button",
        "type": "boolean",
        "required": false
      },
      "repeatB": {
        "title": "Add the Repeat button",
        "type": "boolean",
        "required": false
      },
      "pipB": {
        "title": "Add the PIP button",
        "type": "boolean",
        "required": false
      },
      "resolutionB": {
        "title": "Add the Resolution button",
        "type": "boolean",
        "required": false
      },
      "threeDB": {
        "title": "Add the 3D button",
        "type": "boolean",
        "required": false
      },
      "pictureB": {
        "title": "Add the Picture button",
        "type": "boolean",
        "required": false
      },
      "hdrButtonB": {
        "title": "Add the HDR button",
        "type": "boolean",
        "required": false
      },
      "subtitleHoldB": {
        "title": "Add the Subtitle (Hold) button",
        "type": "boolean",
        "required": false
      },
      "infoHoldB": {
        "title": "Add the Info (Hold) button",
        "type": "boolean",
        "required": false
      },
      "resolutionHoldB": {
        "title": "Add the Resolution (Hold) button",
        "type": "boolean",
        "required": false
      },
      "avSyncB": {
        "title": "Add the A/V Sync button",
        "type": "boolean",
        "required": false
      },
      "gaplessPlayB": {
        "title": "Add the Gapless Play button",
        "type": "boolean",
        "required": false
      },
      "inputB": {
        "title": "Add the Input button",
        "type": "boolean",
        "required": false
      },
      "powerB": {
        "title": "Add the Power button",
        "type": "boolean",
        "required": false
      },
      "ejectDiscB": {
        "title": "Add the Eject/Close button",
        "type": "boolean",
        "required": false
      },
      "autoIP": {
        "title": "Set the IP address manually. Use this option if the device cannot be found automatically",
        "type": "boolean",
        "required": false,
        "default": false
      },
      "changeDimmersToFan": {
        "title": "Enable this if you would like to change the Volume, Movie Progress, Chapter progress, or the Chapter Selector from Dimmers to Fans. This option is useful to avoid issues with Siri commands like 'Turn off all the lights'",
        "type": "boolean",
        "required": false,
        "default": false
      },
      "infoToMenu": {
        "title": "Change Info button to Menu button",
        "type": "boolean",
        "required": false,
        "default": false
      }
    }
  },
  "layout": [
    {
      "type": "flex",
      "flex-flow": "row wrap",
      "items": [
        {
          "type": "flex",
          "flex-flow": "column",
          "items": [
            "name"
          ]
        },
        {
          "type": "flex",
          "flex-flow": "column",
          "items": [
            "pollingInterval"
          ]
        },
        {
          "type": "flex",
          "flex-flow": "column",
          "items": [
            "modelName"
          ]
        },
        {
          "type": "flex",
          "flex-flow": "column",
          "items": [
            "manufacture"
          ]
        },
        {
          "type": "flex",
          "flex-flow": "column",
          "items": [
            "serialN"
          ]
        },
        {
          "key": "autoIP"
        },
        {
          "type": "flex",
          "flex-flow": "column",
          "condition": "model.autoIP",
          "items": [
            "ip"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "Optional Services",
      "expandable": true,
      "expanded": true,
      "items": [
        {
          "key": "volume"
        },
        {
          "key": "mediaButtons"
        },
        {
          "key": "inputButtons"
        },
        {
          "key": "oppo205"
        },
        {
          "key": "movieControl"
        },
        {
          "key": "chapterControl"
        },
        {
          "key": "remainMovieTimer"
        },
        {
          "key": "chapterSelector"
        },
        {
          "key": "mediaAudioVideoState"
        },
        {
          "key": "changeDimmersToFan"
        },
        {
          "key": "infoToMenu"
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "Navegation Buttons",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "key": "cursorUpB"
        },
        {
          "key": "cursorDownB"
        },
        {
          "key": "cursorLeftB"
        },
        {
          "key": "cursorRightB"
        },
        {
          "key": "cursorEnterB"
        },
        {
          "key": "menuB"
        },
        {
          "key": "backButtonB"
        },
        {
          "key": "clearB"
        },
        {
          "key": "topMenuB"
        },
        {
          "key": "optionB"
        },
        {
          "key": "homeMenuB"
        },
        {
          "key": "infoB"
        },
        {
          "key": "setupB"
        },
        {
          "key": "goToB"
        },
        {
          "key": "pageUpB"
        },
        {
          "key": "pageDownB"
        },
        {
          "key": "popUpMenuB"
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "Other Buttons",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "key": "dimmerB"
        },
        {
          "key": "powerB"
        },
        {
          "key": "pureAudioB"
        },
        {
          "key": "redB"
        },
        {
          "key": "yellowB"
        },
        {
          "key": "greenB"
        },
        {
          "key": "blueB"
        },
        {
          "key": "audioB"
        },
        {
          "key": "subtitleB"
        },
        {
          "key": "angleB"
        },
        {
          "key": "zoomB"
        },
        {
          "key": "sapB"
        },
        {
          "key": "abReplayB"
        },
        {
          "key": "repeatB"
        },
        {
          "key": "pipB"
        },
        {
          "key": "resolutionB"
        },
        {
          "key": "threeDB"
        },
        {
          "key": "pictureB"
        },
        {
          "key": "hdrButtonB"
        },
        {
          "key": "subtitleHoldB"
        },
        {
          "key": "infoHoldB"
        },
        {
          "key": "resolutionHoldB"
        },
        {
          "key": "avSyncB"
        },
        {
          "key": "gaplessPlayB"
        },
        {
          "key": "inputB"
        },
        {
          "key": "ejectDiscB"
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "Troubleshooting",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "key": "chinoppo",
          "description": "Enable this in case the Oppo clone does not turn on with the On/Off button"
        },
        {
          "key": "newPlatformUUID",
          "description": "Enable this if you do not see the accessory when you try to add it to the Home App. Note that it will create a new accesssory if the name of the device is changed in Settings. Old accesories must be removed manually in the Home app."
        }
      ]
    }
  ]
}