homebridge-test-zigbee-nt/config.schema.json

ZigBee New Technology Platform plugin for HomeBridge

{
  "pluginAlias": "ZigbeeHomebridgeNTPlatform",
  "pluginType": "platform",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "default": "ZigBee",
        "minLength": 1,
        "required": true
      },
      "port": {
        "title": "Port",
        "description": "Port for USB stick (example: /dev/tty.usbmodem144). If not set, it tries to find port automatically.",
        "type": "string",
        "required": false
      },
      "panId": {
        "title": "PanId",
        "description": "Identify the ZigBee PAN-ID. This id should be a value between 1 and 65534 (0xFFFE). You can also set it to 65534 (0xFFFE) to let ZigBee choose a random PAN-ID on its own.",
        "type": "number",
        "oneOf": [
          {
            "type": "number",
            "default": 65534,
            "minimum": 1,
            "maximum": 65534
          },
          {
            "type": "number",
            "default": 1,
            "minimum": 1,
            "maximum": 16383
          }
        ],
        "required": true
      },
      "channel": {
        "title": "Channel",
        "description": "Channel for your ZigBee dongle (11-25).",
        "type": "number",
        "enum": [11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25],
        "default": 11,
        "required": true
      },
      "secondaryChannel": {
        "title": "Secondary Channel",
        "description": "Secondary (backup) Channel for your ZigBee dongle (11-25).",
        "type": "string",
        "enum": [
          "None",
          "11",
          "12",
          "13",
          "14",
          "15",
          "16",
          "17",
          "18",
          "19",
          "20",
          "21",
          "22",
          "23",
          "24",
          "25"
        ],
        "default": 25,
        "required": true
      },
      "adapter": {
        "title": "Adapter",
        "description": "Type of adapter to use. Default to zstack",
        "type": "string",
        "default": "zstack",
        "enum": ["zstack", "deconz", "zigate"],
        "required": false
      },
      "database": {
        "title": "Database",
        "description": "Path to zigbee database. If not set, it uses 'homebridge_storage_path/zigbee.db' path.",
        "type": "string",
        "required": false
      },
      "routerPollingInterval": {
        "title": "Ping Interval",
        "description": "Ping interval for routers to prevent them from sleeping (in seconds).",
        "type": "number",
        "default": 30,
        "minimum": 10,
        "maximum": 180,
        "required": false
      },
      "disableRouterPolling": {
        "title": "Disable Router Polling",
        "description": "Turn off the polling for router devices",
        "type": "boolean",
        "default": false,
        "required": false
      },
      "disableHttpServer": {
        "title": "Disable HTTP Server (UI)",
        "description": "Turn off the HTTP server and the internal UI used for managing devices",
        "type": "boolean",
        "default": false,
        "required": false
      },
      "httpPort": {
        "title": "HTTP Server Port",
        "description": "Port for HTTP server. Default to 9000",
        "type": "number",
        "required": false
      },
      "disableLed": {
        "title": "Disable Led",
        "description": "Turn off the stick led indicator.",
        "type": "boolean",
        "default": false,
        "required": false
      },
      "devices": {
        "title": "Custom configured devices",
        "type": "object",
        "required": false
      }
    }
  },
  "form": [
    "name",
    "port",
    "panId",
    "channel",
    "secondaryChannel",
    "adapter",
    "database",
    "disableRouterPolling",
    "routerPollingInterval",
    "disableHttpServer",
    "httpPort",
    "disableLed"
  ]
}