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 without mqtt://)",
      "type": "string",
      "default": "localhost"
    },
    "username": {
      "description": "MQTT server authentication user",
      "type": "string"
    },
    "password": {
      "description": "MQTT server authentication password",
      "type": "string",
      "ui:widget": "password"
    },
    "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 (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"
      }
    },
    "deviceScenes": {
      "description": "Enable the devices scenes",
      "type": "boolean",
      "default": false,
      "ui:widget": "hidden"
    },
    "groupScenes": {
      "description": "Enable the groups scenes",
      "type": "boolean",
      "default": false,
      "ui:widget": "hidden"
    },
    "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": ""
    },
    "postfixHostname": {
      "description": "DEPRECATED: 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). Use postfix instead.",
      "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,
      "ui:widget": "hidden"
    }
  }
}