matterbridge-zigbee2mqtt/matterbridge-zigbee2mqtt.schema.json

Matterbridge zigbee2mqtt plugin

{
  "title": "Matterbridge zigbee2mqtt plugin",
  "description": "matterbridge-zigbee2mqtt v. 2.0.17 by https://github.com/Luligu",
  "type": "object",
  "required": ["host", "port", "topic"],
  "properties": {
    "name": {
      "description": "Plugin name",
      "type": "string",
      "readOnly": true,
      "ui:widget": "hidden"
    },
    "type": {
      "description": "Plugin type",
      "type": "string",
      "readOnly": true,
      "ui:widget": "hidden"
    },
    "host": {
      "description": "MQTT server host (IP address or hostname with mqtt:// or mqtts:// prefix). For secure connections, use the mqtts:// prefix and ensure your certificates are configured. If you use a hostname, make sure that the hostname is resolvable by the system running matterbridge.",
      "type": "string",
      "default": "mqtt://localhost"
    },
    "port": {
      "description": "MQTT server port (i.e. 1883 for mqtt:// and 8883 for mqtts://).",
      "type": "number",
      "default": 1883
    },
    "protocolVersion": {
      "description": "MQTT server protocol version 3, 4 or 5 (default 5). Version 5 is recommended for most modern MQTT brokers.",
      "type": "number",
      "default": 5
    },
    "username": {
      "description": "MQTT server authentication user. Only required if the MQTT server requires authentication (i.e allow_anonymous false)",
      "type": "string"
    },
    "password": {
      "description": "MQTT server authentication password. Only required if the MQTT server requires authentication (i.e allow_anonymous false)",
      "type": "string",
      "ui:widget": "password"
    },
    "ca": {
      "description": "Absolute path to the SSL/TLS CA certificate used to sign both the server and client certificates (PEM format). Required for secure connections (i.e. mqtts://) with self-signed certificates.",
      "type": "string"
    },
    "rejectUnauthorized": {
      "description": "Reject unauthorized MQTT server. Only used for secure connections (i.e. mqtts://).",
      "type": "boolean",
      "default": true
    },
    "cert": {
      "description": "Absolute path to the SSL/TLS MQTT client certificate (PEM format). Only required if the MQTT server requires a client certificate for authentication (i.e. require_certificate true).",
      "type": "string"
    },
    "key": {
      "description": "Absolute path to the SSL/TLS MQTT client private key (PEM format). Only required if the MQTT server requires a client certificate for authentication (i.e. require_certificate true).",
      "type": "string"
    },
    "topic": {
      "description": "MQTT base topic for Zigbee2MQTT MQTT messages. This should match the base_topic in your Zigbee2MQTT configuration.yaml file.",
      "type": "string",
      "default": "zigbee2mqtt"
    },
    "zigbeeFrontend": {
      "description": "Zigbee frontend host to prefix the configUrl from matterbridge frontend (i.e. http://192.168.1.100:8080)",
      "type": "string",
      "default": "http://localhost:8080"
    },
    "whiteList": {
      "description": "Only the devices in the list will be exposed. If the list is empty, all the devices will be exposed.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "blackList": {
      "description": "The devices in the list will not be exposed. If the list is empty, no devices will be excluded.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "switchList": {
      "description": "The devices in the list will be exposed like switches (don't use it for Alexa, use lightList or outletList instead).",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "lightList": {
      "description": "The devices in the list will be exposed like lights.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "outletList": {
      "description": "The devices in the list will be exposed like outlets.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "featureBlackList": {
      "description": "The features in the list will not be exposed for all devices.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true,
      "selectEntityFrom": "name"
    },
    "deviceFeatureBlackList": {
      "description": "List of features 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 features to exclude.",
      "type": "object",
      "uniqueItems": true,
      "selectFrom": "name",
      "additionalProperties": {
        "description": "List of features not to be exposed for this device. Enter the feature (i.e. device_temperature) to exclude.",
        "type": "array",
        "items": {
          "type": "string"
        },
        "uniqueItems": true,
        "selectDeviceEntityFrom": "name"
      }
    },
    "scenesType": {
      "description": "Device type to use to expose scenes",
      "type": "string",
      "oneOf": [
        {
          "title": "Light",
          "enum": ["light"]
        },
        {
          "title": "Outlet",
          "enum": ["outlet"]
        },
        {
          "title": "Switch",
          "enum": ["switch"]
        },
        {
          "title": "Mounted Switch",
          "enum": ["mounted_switch"]
        }
      ],
      "default": "outlet"
    },
    "scenesPrefix": {
      "description": "Add the device/group friendly name before the scene name.",
      "type": "boolean",
      "default": true
    },
    "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).",
      "type": "string",
      "default": ""
    },
    "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"
    }
  }
}