config.schema.json

{
  "pluginAlias": "ZigbeeHomebridgeNTPlatform",
  "pluginType": "platform",
  "singular": true,
  "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": false
      },
      "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", "ezsp"],
        "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
      },
      "preferAutoDiscover": {
        "title": "Prefer Auto discover over mapped devices",
        "description": "Prefer Auto discover of devices when looking for accessories (ignore internally mapped devices). Warning: don't use this if you have devices that are not supported by autodiscovery, like thermostats or complex switches",
        "type": "boolean",
        "default": false,
        "required": false
      },
      "devices": {
        "type": "array",
        "items": [
          {
            "type": "object",
            "properties": {
              "manufacturers": {
                "type": "array",
                "items": {
                  "title": "Manufacturer",
                  "type": "string"
                }
              },
              "models": {
                "type": "array",
                "items": {
                  "title": "Model",
                  "type": "string"
                }
              },
              "services": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "unknown",
                        "contact-sensor",
                        "light-sensor",
                        "bulb",
                        "light-bulb",
                        "switch",
                        "motion-sensor",
                        "leak-sensor",
                        "vibration-sensor",
                        "battery",
                        "humidity-sensor",
                        "temperature-sensor",
                        "outlet",
                        "lock",
                        "climate"
                      ]
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "colorTemp": {
                          "title": "Supports color temperature",
                          "type": "boolean"
                        },
                        "batteryLow": {
                          "title": "Supports battery low alert",
                          "type": "boolean"
                        },
                        "colorXY": {
                          "title": "Supports color XY",
                          "type": "boolean"
                        },
                        "brightness": {
                          "title": "Supports brightness",
                          "type": "boolean"
                        },
                        "hue": {
                          "title": "Supports hue",
                          "type": "boolean"
                        },
                        "saturation": {
                          "title": "Supports saturation",
                          "type": "boolean"
                        },
                        "power": {
                          "title": "Supports power consumption reporting",
                          "type": "boolean"
                        },
                        "voltage": {
                          "title": "Supports voltage reporting",
                          "type": "boolean"
                        },
                        "current": {
                          "title": "Supports current reporting",
                          "type": "boolean"
                        },
                        "waterLeak": {
                          "title": "Has a water leak sensor",
                          "type": "boolean"
                        },
                        "gasLeak": {
                          "title": "Has a gas leak sensor",
                          "type": "boolean"
                        },
                        "smokeLeak": {
                          "title": "Has a smoke leak sensor",
                          "type": "boolean"
                        },
                        "tamper": {
                          "title": "Can report tampered status",
                          "type": "boolean"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "customDeviceSettings": {
        "type": "array",
        "required": false,
        "items": {
          "type": "object",
          "properties": {
            "ieeeAddr": {
              "title": "Accessory IEEE Address",
              "type": "string",
              "required": true,
              "key": "customDeviceSettings[].ieeeAddr",
              "placeholder": "Enter IEEE address..."
            },
            "friendlyName": {
              "title": "Accessory friendly name",
              "type": "string",
              "required": true,
              "key": "customDeviceSettings[].friendlyName",
              "placeholder": "Enter friendly name..."
            }
          }
        }
      }
    }
  },
  "layout": [
    {
      "type": "fieldset",
      "title": "Standard Settings",
      "expandable": true,
      "expanded": true,
      "items": ["name", "port", "channel", "secondaryChannel", "adapter", "disableLed"]
    },
    {
      "type": "fieldset",
      "title": "Advanced Settings",
      "expandable": true,
      "expanded": false,
      "items": [
        "panId",
        "database",
        "disableRouterPolling",
        "routerPollingInterval",
        "disableHttpServer",
        "httpPort",
        "preferAutoDiscover"
      ]
    },
    {
      "type": "fieldset",
      "title": "Custom Device Settings",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "type": "help",
          "helpvalue": "<em class='primary-text'>Enter friendly names for your devices</em>"
        },
        {
          "nodescription": true,
          "notitle": true,
          "key": "customDeviceSettings",
          "type": "array",
          "orderable": false,
          "items": [
            {
              "type": "div",
              "displayFlex": true,
              "flex-direction": "row",
              "items": [
                {
                  "flex": "1 1 50px",
                  "notitle": true,
                  "title": "Accessory IEEE Address",
                  "type": "string",
                  "required": true,
                  "key": "customDeviceSettings[].ieeeAddr",
                  "placeholder": "Enter IEEE address..."
                },
                {
                  "flex": "1 1 50px",
                  "notitle": true,
                  "title": "Accessory friendly name",
                  "type": "string",
                  "required": true,
                  "key": "customDeviceSettings[].friendlyName",
                  "placeholder": "Enter friendly name..."
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}