matterbridge-xiaomi-roborock/matterbridge-xiaomi-roborock.schema.json

Matterbridge Xiaomi Roborock Plugin

{
  "title": "Matterbridge Xiaomi Roborock Robot Vacuum",
  "description": "Xiaomi Roborock Robot",
  "type": "object",
  "required": ["devices"],
  "properties": {
    "name": {
      "description": "Plugin name",
      "type": "string",
      "readOnly": true,
      "ui:widget": "hidden"
    },
    "type": {
      "description": "Plugin type",
      "type": "string",
      "readOnly": true,
      "ui:widget": "hidden"
    },
    "devices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the robot vacuum."
          },
          "ip": {
            "type": "string",
            "description": "The IP address of the robot vacuum."
          },
          "token": {
            "type": "string",
            "description": "The token of the robot vacuum. Can be extracted using https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor"
          },
          "roomNames": {
            "type": "array",
            "description": "(Optional) If your robot supports named rooms in the Xiaomi Home app but the RVC still returns it as numeric IDs, you can list the room names in the same order as shown in the log entry <<Room mapping found:>> and the plugin will override the names. If the robot doesn't support named rooms in the app, the rooms are discovered by looking for a cleaning timer scheduled for every day at 00:00 with the rooms explicitly selected (in the Robot's settings in the Xiaomi app). This room discovery method cannot obtain the name of the rooms, and need to be specified here in the same order as the rooms were selected. If not provided, the rooms will show up as \"Room 16\", \"Room 17\", etc.",
            "items": {
              "type": "string"
            }
          }
        },
        "required": ["name", "ip", "token"]
      },
      "minItems": 1,
      "default": []
    },
    "debug": {
      "description": "Capture debug-level logging from this plugin, overriding the Matterbridge global log level setting.",
      "type": "boolean",
      "default": false
    },
    "unregisterOnShutdown": {
      "description": "Unregister all exposed devices on shutdown (used for development/testing).",
      "type": "boolean",
      "default": false,
      "ui:widget": "hidden"
    }
  }
}