config.schema.json

{
  "pluginAlias": "OpenWebIfTv",
  "pluginType": "platform",
  "singular": true,
  "fixArrays": true,
  "strictValidation": true,
  "headerDisplay": "This plugin works with Sat Receivers basis on the OpenWebIf interface. Devices are exposed to HomeKit as separate accessories and each needs to be manually paired.",
  "footerDisplay": "For documentation please see [GitHub repository](https://github.com/grzegorz914/homebridge-openwebif-tv).",
  "schema": {
    "type": "object",
    "properties": {
      "devices": {
        "type": "array",
        "items": {
          "title": "Device",
          "type": "object",
          "properties": {
            "name": {
              "title": "Name",
              "type": "string",
              "placeholder": "Sat Receiver",
              "required": true
            },
            "host": {
              "title": "IP/Hostname",
              "type": "string",
              "placeholder": "192.160.1.10",
              "format": "hostname",
              "required": true
            },
            "port": {
              "title": "Port",
              "type": "integer",
              "placeholder": 80,
              "required": true
            },
            "getInputsFromDevice": {
              "title": "Load Channels From Device",
              "type": "boolean",
              "default": false,
              "description": "This function get channels by bouquet direct from device, manually configured channels will be skipped.",
              "required": true
            },
            "inputsDisplayOrder": {
              "title": "Channels Display Order",
              "type": "integer",
              "minimum": 0,
              "maximum": 4,
              "default": 0,
              "description": "Here select display order of the channels list.",
              "oneOf": [
                {
                  "title": "None",
                  "enum": [
                    0
                  ]
                },
                {
                  "title": "Ascending by Name",
                  "enum": [
                    1
                  ]
                },
                {
                  "title": "Descending by Name",
                  "enum": [
                    2
                  ]
                },
                {
                  "title": "Ascending by Reference",
                  "enum": [
                    3
                  ]
                },
                {
                  "title": "Descending by Reference",
                  "enum": [
                    4
                  ]
                }
              ],
              "required": true
            },
            "bouquets": {
              "title": "Bouquet Name",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "title": "Name",
                    "type": "string",
                    "placeholder": "Bouquet name",
                    "description": "Here set bouquet name which should be loaded from device, only first 85 channels will be used.",
                    "required": false
                  },
                  "displayType": {
                    "title": "Extra Tile",
                    "type": "integer",
                    "default": 0,
                    "oneOf": [
                      {
                        "title": "None/Disabled",
                        "enum": [
                          0
                        ]
                      },
                      {
                        "title": "Outlet",
                        "enum": [
                          1
                        ]
                      },
                      {
                        "title": "Switch",
                        "enum": [
                          2
                        ]
                      }
                    ],
                    "description": "Here select extra tile for all channels of this bouquet to be exposed in HomeKit app.",
                    "required": true
                  },
                  "namePrefix": {
                    "title": "Prefix",
                    "type": "boolean",
                    "description": "Here enable/disable the accessory name as a prefix for extra tile name.",
                    "required": false
                  }
                }
              },
              "condition": {
                "functionBody": "return model.devices[arrayIndices].getInputsFromDevice === true;"
              },
              "required": false
            },
            "inputs": {
              "title": "Channels",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "title": "Name",
                    "type": "string",
                    "placeholder": "Channel name",
                    "description": "Here set Your own name.",
                    "required": false
                  },
                  "reference": {
                    "title": "Reference",
                    "type": "string",
                    "placeholder": "Channel reference",
                    "description": "Here set the reference.",
                    "required": false
                  },
                  "displayType": {
                    "title": "Extra Tile",
                    "type": "integer",
                    "default": 0,
                    "oneOf": [
                      {
                        "title": "None/Disabled",
                        "enum": [
                          0
                        ]
                      },
                      {
                        "title": "Outlet",
                        "enum": [
                          1
                        ]
                      },
                      {
                        "title": "Switch",
                        "enum": [
                          2
                        ]
                      }
                    ],
                    "description": "Here select extra tile to be exposed in HomeKit app.",
                    "required": true
                  },
                  "namePrefix": {
                    "title": "Prefix",
                    "type": "boolean",
                    "description": "Here enable/disable the accessory name as a prefix for extra tile name.",
                    "required": false
                  }
                }
              },
              "condition": {
                "functionBody": "return model.devices[arrayIndices].getInputsFromDevice === false;"
              },
              "required": false
            },
            "buttons": {
              "title": "Button",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "title": "Name",
                    "type": "string",
                    "placeholder": "Button name",
                    "description": "Here set Your own name.",
                    "required": false
                  },
                  "mode": {
                    "title": "Mode",
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 1,
                    "description": "Here select the function mode.",
                    "oneOf": [
                      {
                        "title": "Live TV Channel",
                        "enum": [
                          0
                        ]
                      },
                      {
                        "title": "Remote Control",
                        "enum": [
                          1
                        ]
                      }
                    ],
                    "required": false
                  },
                  "reference": {
                    "title": "Reference",
                    "type": "string",
                    "placeholder": "Button reference",
                    "description": "Here set the reference.",
                    "required": false
                  },
                  "command": {
                    "title": "RC Command",
                    "type": "string",
                    "oneOf": [
                      {
                        "title": "0",
                        "enum": [
                          "11"
                        ]
                      },
                      {
                        "title": "1",
                        "enum": [
                          "2"
                        ]
                      },
                      {
                        "title": "2",
                        "enum": [
                          "3"
                        ]
                      },
                      {
                        "title": "3",
                        "enum": [
                          "4"
                        ]
                      },
                      {
                        "title": "4",
                        "enum": [
                          "5"
                        ]
                      },
                      {
                        "title": "5",
                        "enum": [
                          "6"
                        ]
                      },
                      {
                        "title": "6",
                        "enum": [
                          "7"
                        ]
                      },
                      {
                        "title": "7",
                        "enum": [
                          "8"
                        ]
                      },
                      {
                        "title": "8",
                        "enum": [
                          "9"
                        ]
                      },
                      {
                        "title": "9",
                        "enum": [
                          "10"
                        ]
                      },
                      {
                        "title": "<",
                        "enum": [
                          "412"
                        ]
                      },
                      {
                        "title": ">",
                        "enum": [
                          "407"
                        ]
                      },
                      {
                        "title": "Power",
                        "enum": [
                          "116"
                        ]
                      },
                      {
                        "title": "Volume Up",
                        "enum": [
                          "115"
                        ]
                      },
                      {
                        "title": "Volume Down",
                        "enum": [
                          "114"
                        ]
                      },
                      {
                        "title": "Mute",
                        "enum": [
                          "113"
                        ]
                      },
                      {
                        "title": "Bouquet Up",
                        "enum": [
                          "402"
                        ]
                      },
                      {
                        "title": "Bouquet Down",
                        "enum": [
                          "403"
                        ]
                      },
                      {
                        "title": "Epg",
                        "enum": [
                          "358"
                        ]
                      },
                      {
                        "title": "Menu",
                        "enum": [
                          "139"
                        ]
                      },
                      {
                        "title": "Menu Up",
                        "enum": [
                          "103"
                        ]
                      },
                      {
                        "title": "Menu Down",
                        "enum": [
                          "108"
                        ]
                      },
                      {
                        "title": "Menu Left",
                        "enum": [
                          "105"
                        ]
                      },
                      {
                        "title": "Menu Right",
                        "enum": [
                          "106"
                        ]
                      },
                      {
                        "title": "Menu OK",
                        "enum": [
                          "352"
                        ]
                      },
                      {
                        "title": "Back",
                        "enum": [
                          "174"
                        ]
                      },
                      {
                        "title": "Exit",
                        "enum": [
                          "174"
                        ]
                      },
                      {
                        "title": "Play",
                        "enum": [
                          "207"
                        ]
                      },
                      {
                        "title": "Pause",
                        "enum": [
                          "119"
                        ]
                      },
                      {
                        "title": "Stop",
                        "enum": [
                          "128"
                        ]
                      },
                      {
                        "title": "Record",
                        "enum": [
                          "167"
                        ]
                      },
                      {
                        "title": "Forward",
                        "enum": [
                          "208"
                        ]
                      },
                      {
                        "title": "Rewind",
                        "enum": [
                          "168"
                        ]
                      },
                      {
                        "title": "Next",
                        "enum": [
                          "407"
                        ]
                      },
                      {
                        "title": "Previous",
                        "enum": [
                          "412"
                        ]
                      },
                      {
                        "title": "Red",
                        "enum": [
                          "398"
                        ]
                      },
                      {
                        "title": "Green",
                        "enum": [
                          "399"
                        ]
                      },
                      {
                        "title": "Yellow",
                        "enum": [
                          "400"
                        ]
                      },
                      {
                        "title": "Blue",
                        "enum": [
                          "401"
                        ]
                      },
                      {
                        "title": "TV",
                        "enum": [
                          "377"
                        ]
                      },
                      {
                        "title": "Radio",
                        "enum": [
                          "385"
                        ]
                      },
                      {
                        "title": "Video",
                        "enum": [
                          "393"
                        ]
                      },
                      {
                        "title": "Audio",
                        "enum": [
                          "392"
                        ]
                      },
                      {
                        "title": "Help",
                        "enum": [
                          "138"
                        ]
                      },
                      {
                        "title": "Subtitle",
                        "enum": [
                          "370"
                        ]
                      },
                      {
                        "title": "Text",
                        "enum": [
                          "388"
                        ]
                      }
                    ],
                    "description": "Here select the remote control command.",
                    "required": false
                  },
                  "displayType": {
                    "title": "Display Type",
                    "type": "integer",
                    "default": 0,
                    "oneOf": [
                      {
                        "title": "None/Disabled",
                        "enum": [
                          0
                        ]
                      },
                      {
                        "title": "Outlet",
                        "enum": [
                          1
                        ]
                      },
                      {
                        "title": "Switch",
                        "enum": [
                          2
                        ]
                      }
                    ],
                    "description": "Here select display type in HomeKit app",
                    "required": true
                  },
                  "namePrefix": {
                    "title": "Prefix",
                    "type": "boolean",
                    "description": "Here enable/disable the accessory name as a prefix for button name.",
                    "required": false
                  }
                }
              },
              "required": false
            },
            "sensorPower": {
              "title": "Power",
              "type": "boolean",
              "default": false,
              "description": "This expose Power as a Motion Sensor to use with automations.",
              "required": false
            },
            "sensorVolume": {
              "title": "Volume",
              "type": "boolean",
              "default": false,
              "description": "This expose Volume as a Motion Sensor to use with automations.",
              "required": false
            },
            "sensorMute": {
              "title": "Mute",
              "type": "boolean",
              "default": false,
              "description": "This expose Mute as a Motion Sensor to use with automations.",
              "required": false
            },
            "sensorChannel": {
              "title": "Channel",
              "type": "boolean",
              "default": false,
              "description": "This expose Channel as a Motion Sensor to use with automations.",
              "required": false
            },
            "sensorInputs": {
              "type": "array",
              "items": {
                "title": "Channels",
                "type": "object",
                "description": "Here create Channels Sensors based on reference, sensor will active if switch to it.",
                "properties": {
                  "name": {
                    "title": "Name",
                    "type": "string",
                    "placeholder": "Name",
                    "description": "Here set Your own name.",
                    "required": false
                  },
                  "reference": {
                    "title": "Reference",
                    "type": "string",
                    "placeholder": "Channel reference",
                    "description": "Here set the Channel reference.",
                    "required": false
                  },
                  "displayType": {
                    "title": "Type",
                    "type": "integer",
                    "default": 0,
                    "oneOf": [
                      {
                        "title": "None/Disabled",
                        "enum": [
                          0
                        ]
                      },
                      {
                        "title": "Motion Sensor",
                        "enum": [
                          1
                        ]
                      },
                      {
                        "title": "Occupancy Sensor",
                        "enum": [
                          2
                        ]
                      },
                      {
                        "title": "Contact Sensor",
                        "enum": [
                          3
                        ]
                      }
                    ],
                    "description": "Here select sensor type to be exposed in HomeKit app.",
                    "required": true
                  },
                  "namePrefix": {
                    "title": "Prefix",
                    "type": "boolean",
                    "description": "Here enable/disable the accessory name as a prefix for sensor name.",
                    "required": false
                  }
                }
              },
              "required": false
            },
            "auth": {
              "title": "Authorization",
              "type": "boolean",
              "default": false,
              "required": false
            },
            "user": {
              "title": "User",
              "type": "string",
              "placeholder": "User",
              "condition": {
                "functionBody": "return model.devices[arrayIndices].auth === true;"
              },
              "required": false
            },
            "pass": {
              "title": "Password",
              "type": "string",
              "placeholder": "Password",
              "format": "password",
              "condition": {
                "functionBody": "return model.devices[arrayIndices].auth === true;"
              },
              "required": false
            },
            "infoButtonCommand": {
              "title": "Info Button",
              "type": "string",
              "default": "139",
              "oneOf": [
                {
                  "title": "Epg",
                  "enum": [
                    "358"
                  ]
                },
                {
                  "title": "Menu",
                  "enum": [
                    "139"
                  ]
                },
                {
                  "title": "Red",
                  "enum": [
                    "398"
                  ]
                },
                {
                  "title": "Green",
                  "enum": [
                    "399"
                  ]
                },
                {
                  "title": "Yellow",
                  "enum": [
                    "400"
                  ]
                },
                {
                  "title": "Blue",
                  "enum": [
                    "401"
                  ]
                },
                {
                  "title": "TV",
                  "enum": [
                    "377"
                  ]
                },
                {
                  "title": "Radio",
                  "enum": [
                    "385"
                  ]
                },
                {
                  "title": "Video",
                  "enum": [
                    "393"
                  ]
                },
                {
                  "title": "Audio",
                  "enum": [
                    "392"
                  ]
                },
                {
                  "title": "Help",
                  "enum": [
                    "138"
                  ]
                },
                {
                  "title": "Subtitle",
                  "enum": [
                    "370"
                  ]
                },
                {
                  "title": "Text",
                  "enum": [
                    "388"
                  ]
                },
                {
                  "title": "Record",
                  "enum": [
                    "167"
                  ]
                }
              ],
              "description": "Here select the function of info button in RC.",
              "required": true
            },
            "volumeControlNamePrefix": {
              "title": "Volume Control Name Prefix",
              "type": "boolean",
              "default": false,
              "description": "Here enable/disable the accessory name as a prefix for volume control name.",
              "required": false
            },
            "volumeControlName": {
              "title": "Volume Control Name",
              "type": "string",
              "placeholder": "Name",
              "description": "Here set Your own volume control name or leave empty.",
              "required": false
            },
            "volumeControl": {
              "title": "Volume Control",
              "type": "integer",
              "minimum": 0,
              "maximum": 2,
              "default": 0,
              "description": "Here select what a volume control mode You want to use. If select *None/Disabled* only hardware buttons in RC app can be used to control volume.",
              "oneOf": [
                {
                  "title": "None/Disabled",
                  "enum": [
                    0
                  ]
                },
                {
                  "title": "Slider",
                  "enum": [
                    1
                  ]
                },
                {
                  "title": "Fan",
                  "enum": [
                    2
                  ]
                }
              ],
              "required": true
            },
            "refreshInterval": {
              "title": "Refresh interval (sec)",
              "type": "number",
              "default": 5,
              "minimum": 0.5,
              "maximum": 30,
              "multipleOf": 0.5,
              "description": "Here set the background data refresh interval.",
              "required": true
            },
            "disableLogDeviceInfo": {
              "title": "Disable Log Device Info",
              "type": "boolean",
              "default": false,
              "description": "This disable logging device info by every connections device to the network.",
              "required": false
            },
            "disableLogInfo": {
              "title": "Disable Log Info",
              "type": "boolean",
              "default": false,
              "required": false
            },
            "disableLogSuccess": {
              "title": "Disable Log Success",
              "type": "boolean",
              "default": false,
              "required": false
            },
            "disableLogWarn": {
              "title": "Disable Log Warn",
              "type": "boolean",
              "default": false,
              "required": false
            },
            "disableLogError": {
              "title": "Disable Log Error",
              "type": "boolean",
              "default": false,
              "required": false
            },
            "enableDebugMode": {
              "title": "Enable Log Debug",
              "type": "boolean",
              "default": false,
              "required": false
            },
            "mqtt": {
              "title": "MQTT",
              "type": "object",
              "properties": {
                "enable": {
                  "title": "Enable",
                  "type": "boolean",
                  "default": false,
                  "description": "This enable MQTT client."
                },
                "debug": {
                  "title": "Debug",
                  "type": "boolean",
                  "default": false,
                  "description": "This enable debug mode for MQTT.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true;"
                  },
                  "required": false
                },
                "host": {
                  "title": "IP/Hostname",
                  "type": "string",
                  "placeholder": "ip or hostname",
                  "format": "hostname",
                  "description": "Here set the IP/Hostname of MQTT Broker.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true;"
                  },
                  "required": false
                },
                "port": {
                  "title": "Port",
                  "type": "integer",
                  "placeholder": 1883,
                  "description": "Here set the port of MQTT Broker.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true;"
                  },
                  "required": false
                },
                "clientId": {
                  "title": "Client ID",
                  "type": "string",
                  "placeholder": "client id",
                  "description": "Here optional set the Client ID of MQTT Broker.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true"
                  },
                  "required": false
                },
                "prefix": {
                  "title": "Prefix",
                  "type": "string",
                  "placeholder": "home/envoy",
                  "description": "Here set the prefix.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true;"
                  },
                  "required": false
                },
                "auth": {
                  "title": "Authorization",
                  "type": "boolean",
                  "default": false,
                  "description": "This enable authorization for MQTT Broker.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true;"
                  },
                  "required": false
                },
                "user": {
                  "title": "User",
                  "type": "string",
                  "placeholder": "user",
                  "description": "Here set the user of MQTT Broker.",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true && model.devices[arrayIndices].mqtt.auth === true;"
                  },
                  "required": false
                },
                "passwd": {
                  "title": "Password",
                  "type": "string",
                  "placeholder": "password",
                  "description": "Here set the password of MQTT Broker.",
                  "format": "password",
                  "condition": {
                    "functionBody": "return model.devices[arrayIndices].mqtt.enable === true && model.devices[arrayIndices].mqtt.auth === true;"
                  },
                  "required": false
                }
              }
            }
          }
        }
      }
    }
  },
  "layout": [
    {
      "key": "devices",
      "type": "tabarray",
      "title": "{{ value.name || 'device' }}",
      "items": [
        "devices[].name",
        "devices[].host",
        "devices[].port",
        {
          "key": "devices[]",
          "type": "section",
          "title": "Channels",
          "expandable": true,
          "expanded": false,
          "items": [
            "devices[].getInputsFromDevice",
            "devices[].inputsDisplayOrder",
            {
              "key": "devices[].bouquets",
              "type": "tabarray",
              "title": "{{ value.name || 'bouquet' }}",
              "items": [
                "devices[].bouquets[].name",
                "devices[].bouquets[].displayType",
                "devices[].bouquets[].namePrefix"
              ]
            },
            {
              "key": "devices[].inputs",
              "type": "tabarray",
              "title": "{{ value.name || 'channel' }}",
              "items": [
                "devices[].inputs[].name",
                "devices[].inputs[].reference",
                "devices[].inputs[].displayType",
                "devices[].inputs[].namePrefix"
              ]
            }
          ]
        },
        {
          "key": "devices[]",
          "type": "section",
          "title": "Buttons",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "key": "devices[].buttons",
              "type": "tabarray",
              "title": "{{ value.name || 'button' }}",
              "items": [
                "devices[].buttons[].name",
                "devices[].buttons[].mode",
                "devices[].buttons[].reference",
                "devices[].buttons[].command",
                "devices[].buttons[].displayType",
                "devices[].buttons[].namePrefix"
              ]
            }
          ]
        },
        {
          "key": "devices[]",
          "type": "section",
          "title": "Advanced Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "key": "devices[]",
              "type": "tabarray",
              "title": "{{ value.title }}",
              "items": [
                {
                  "key": "devices[]",
                  "title": "Volume",
                  "items": [
                    "devices[].volumeControlNamePrefix",
                    "devices[].volumeControlName",
                    "devices[].volumeControl"
                  ]
                },
                {
                  "key": "devices[]",
                  "title": "Sensors",
                  "items": [
                    "devices[].sensorPower",
                    "devices[].sensorVolume",
                    "devices[].sensorMute",
                    "devices[].sensorChannel",
                    {
                      "key": "devices[]",
                      "type": "section",
                      "title": "Custom Channels",
                      "expandable": true,
                      "expanded": false,
                      "items": [
                        {
                          "key": "devices[].sensorInputs",
                          "type": "tabarray",
                          "title": "{{ value.name || 'sensor' }}",
                          "items": [
                            "devices[].sensorInputs[].name",
                            "devices[].sensorInputs[].reference",
                            "devices[].sensorInputs[].displayType",
                            "devices[].sensorInputs[].namePrefix"
                          ]
                        }
                      ]
                    }
                  ]
                },
                {
                  "key": "devices[]",
                  "title": "Authorization",
                  "items": [
                    "devices[].auth",
                    "devices[].user",
                    {
                      "key": "devices[].pass",
                      "type": "password"
                    }
                  ]
                },
                {
                  "key": "devices[]",
                  "title": "Device",
                  "items": [
                    "devices[].infoButtonCommand",
                    "devices[].refreshInterval"
                  ]
                },
                {
                  "key": "devices[]",
                  "title": "Log",
                  "items": [
                    "devices[].disableLogDeviceInfo",
                    "devices[].disableLogInfo",
                    "devices[].disableLogSuccess",
                    "devices[].disableLogWarn",
                    "devices[].disableLogError",
                    "devices[].enableDebugMode"
                  ]
                },
                {
                  "key": "devices[]",
                  "title": "External Integrations",
                  "items": [
                    {
                      "key": "devices[]",
                      "type": "tabarray",
                      "title": "{{ value.title }}",
                      "items": [
                        {
                          "key": "devices[].mqtt",
                          "title": "MQTT",
                          "items": [
                            "devices[].mqtt.enable",
                            "devices[].mqtt.debug",
                            "devices[].mqtt.host",
                            "devices[].mqtt.port",
                            "devices[].mqtt.clientId",
                            "devices[].mqtt.prefix",
                            "devices[].mqtt.auth",
                            "devices[].mqtt.user",
                            {
                              "key": "devices[].mqtt.passwd",
                              "type": "password"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}