matterbridge-zigbee2mqtt.schema.json

{
  "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
    },
    "type": {
      "description": "Plugin type",
      "type": "string",
      "readOnly": true
    },
    "host": {
      "description": "MQTT server host (IP address or hostname without mqtt://)",
      "type": "string",
      "default": "localhost"
    },
    "username": {
      "description": "MQTT server authentication user",
      "type": "string"
    },
    "password": {
      "description": "MQTT server authentication password",
      "type": "string"
    },
    "port": {
      "description": "MQTT server port (default 1883)",
      "type": "number",
      "default": 1883
    },
    "protocolVersion": {
      "description": "MQTT server protocol version 3, 4 or 5 (default 5)",
      "type": "number",
      "default": 5
    },
    "topic": {
      "description": "MQTT base topic for Zigbee2MQTT MQTT messages",
      "type": "string",
      "default": "zigbee2mqtt"
    },
    "zigbeeFrontend": {
      "description": "Zigbee frontend host to prefix the configUrl",
      "type": "string",
      "default": "http://localhost:8080"
    },
    "blackList": {
      "description": "The devices in the list will not be exposed.",
      "type": "array",
      "items": {
        "type": "string",
        "default": "device or group name"
      },
      "uniqueItems": true,
      "selectFrom": "name"
    },
    "whiteList": {
      "description": "Only the devices in the list will be exposed.",
      "type": "array",
      "items": {
        "type": "string",
        "default": "device or group name"
      },
      "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"
      }
    },
    "postfixHostname": {
      "description": "Unique postfix added to each device identifier to avoid collision with other instances (you may loose the configuration of the devices in your controller when changing this value).",
      "type": "boolean",
      "default": true
    },
    "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
    }
  }
}