matterbridge-hass/matterbridge-hass.schema.json

Matterbridge hass plugin

{
  "title": "Matterbridge Home Assistant plugin",
  "description": "matterbridge-hass v. 0.0.1 by https://github.com/Luligu",
  "type": "object",
  "required": ["host", "token"],
  "properties": {
    "name": {
      "description": "Plugin name",
      "type": "string",
      "readOnly": true
    },
    "type": {
      "description": "Plugin type",
      "type": "string",
      "readOnly": true
    },
    "host": {
      "description": "Home Assistant host (eg. ws://homeassistant.local:8123 or ws://homeassistant:8123 or ws://<IP-ADDRESS>:8123). For ssl connections use wss:// (eg. wss://homeassistant.local:8123) and enable rejectUnauthorized or provide certificatePath.",
      "type": "string",
      "default": "ws://homeassistant.local:8123"
    },
    "certificatePath": {
      "description": "Fully qualified path to the SSL ca certificate file. This is only needed if you use a self-signed certificate and rejectUnauthorized is enabled.",
      "type": "string"
    },
    "rejectUnauthorized": {
      "description": "Ignore SSL certificate errors. It allows to connect to Home Assistant with self-signed certificates.",
      "type": "boolean",
      "default": true
    },
    "token": {
      "description": "Home Assistant Long-Lived Access Token",
      "type": "string"
    },
    "reconnectTimeout": {
      "description": "Reconnect timeout in seconds (minimum 30 seconds). If the connection is lost, the plugin will try to reconnect after this timeout.",
      "type": "number",
      "default": 60
    },
    "reconnectRetries": {
      "description": "Number of times to try to reconnect before giving up. Set to 0 for no reconnects.",
      "type": "number",
      "default": 10
    },
    "filterByArea": {
      "description": "Filter devices and individual entities by area (use area name). If enabled, only devices and individual entities in the selected areas will be exposed. If disabled, all devices and individual entities will be exposed.",
      "type": "string",
      "default": ""
    },
    "filterByLabel": {
      "description": "Filter devices and individual entities by label (use label name or label_id). If enabled, only devices and individual entities with the selected labels will be exposed. If disabled, all devices and individual entities will be exposed.",
      "type": "string",
      "default": ""
    },
    "applyFiltersToDeviceEntities": {
      "description": "Apply the filters to device entities too. If enabled, the filters will be applied to device entities as well. If disabled, the filters will only be applied to devices and individual entities.",
      "type": "boolean",
      "default": false
    },
    "whiteList": {
      "description": "Only the devices and individual entities in the list will be exposed. Use the name or the id. If the list is empty, all the devices and individual entities will be exposed.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "blackList": {
      "description": "The devices and individual entities in the list will not be exposed. Use the name or the id. If the list is empty, no devices and individual entities will be excluded.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "entityBlackList": {
      "description": "The entities in the list that belongs to a device will not be exposed (this doesn't black list the individual entities). Enter the entity name. This is only related to device entities, not individual entities.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectEntityFrom": "name",
      "ui:widget": "hidden"
    },
    "deviceEntityBlackList": {
      "description": "List of entities not to be exposed for a single device. Enter in the first field the name of the device and in the list add all the entity names you want to exclude for that device. This is only related to device entities, not individual entities.",
      "type": "object",
      "uniqueItems": true,
      "selectFrom": "name",
      "additionalProperties": {
        "description": "List of entities not to be exposed for this device.",
        "type": "array",
        "items": {
          "type": "string"
        },
        "uniqueItems": true,
        "selectDeviceEntityFrom": "name"
      }
    },
    "namePostfix": {
      "description": "Add this unique postfix (3 characters max) to each device name to avoid collision with other instances (you may loose the configuration of the devices in your controller when changing this value or you may need to pair again the controller).",
      "type": "string",
      "default": ""
    },
    "postfix": {
      "description": "Add this unique postfix (3 characters max) to each device serial to avoid collision with other instances (you may loose the configuration of the devices in your controller when changing this value or you may need to pair again the controller).",
      "type": "string",
      "default": ""
    },
    "airQualityRegex": {
      "description": "Custom regex pattern to match not standard air quality sensors entities (e.g., '^sensor\\..*_air_quality$').",
      "type": "string",
      "default": "^sensor\\..*_air_quality$"
    },
    "debug": {
      "description": "Enable the debug for the plugin (development only)",
      "type": "boolean",
      "default": false
    },
    "unregisterOnShutdown": {
      "description": "Unregister all devices on shutdown (development only)",
      "type": "boolean",
      "default": false,
      "ui:widget": "hidden"
    }
  }
}