config.schema.json

{
  "pluginAlias": "Dingz",
  "pluginType": "platform",
  "singular": false,
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "default": "dingz and myStrom SmartHome platform",
        "required": true
      },
      "pollerInterval": {
        "title": "Update interval (in seconds)",
        "type": "number",
        "required": true,
        "default": 10,
        "minimum": 5,
        "maximum": 60,
        "description": "The plugin will poll all devices at regular intervals to get updated values for temperature, light or switch states, and to check whether the device is still reachable. The default value is set a 5s but can be changed to a different value. Reasonable ranges are between 5s-20s, everything below 5s will likely cause problems, longer intervals might lead to unmet user expectations e.g. with respect to automations etc."
      },
      "motionPoller": {
        "title": "Poll dingz Motion Sensor",
        "type": "boolean",
        "default": false,
        "description": "By default, motion events will be triggered via the callback action. With this setting, you can change this behaviour to a `polling` mode of operation. If checked, the dingz will be polled every 2.5 seconds for the motion state. If you disable this, the dingz will push a trigger event when motion begins and reset the motion event when the motion timer of the dingz fires at the end of the period defined in the dingz Web UI (default: 180s). While the pull puts additional strain on the dingz *and* introduces a certain lag, the push mode is dependent on the timer setting which might not be what you want."
      },
      "minStepTiltAngle": {
        "title": "Minimum step for tilt angle (in percent)",
        "type": "number",
        "required": true,
        "default": 1,
        "minimum": 1,
        "maximum": 100,
        "description": "Sets the minimum step for the tilt angle in percent. Default is 1 percent."
      },
      "autoDiscover": {
        "title": "Auto-discovery of devices",
        "type": "boolean",
        "description": "Disable this setting if you want auto-discovery to be turned off.",
        "default": true
      },
      "globalToken": {
        "title": "Global REST API Token",
        "type": "string",
        "description": "Set a global authentication token. This will be used for auto-discovery on the local network and as default token for manually specified devices."
      },
      "ignore": {
        "title": "Ignored Devices",
        "description": "Devices in this list will be excluded when found via auto-discovery. Add an entry (MAC-Address without the colon) for each devices that shall be ignored. The MAC-Address of your myStrom and Dingz devices can be found in the respective app, or via the device's own webpage.",
        "type": "array",
        "items": {
          "title": "Device",
          "type": "object",
          "properties": {
            "mac": {
              "title": "MAC-Address",
              "type": "string",
              "pattern": "^([A-Fa-f0-9]{2}){5}[A-Fa-f0-9]{2}$",
              "required": true
            },
            "comment": {
              "title": "Comment",
              "type": "string"
            }
          }
        }
      },
      "callbackHostname": {
        "title": "Hostname / IP to use for button callbacks ",
        "type": "string",
        "format": "hostname",
        "description": "In order to implement button actions, the dingz plugin exposes a webserver for callbacks. By default, it will use the hostname where homebridge runs as address. Should you use a proxy service or run Homebridge inside a docker container, you might have to add it manually."
      },
      "callbackPort": {
        "title": "Port for button callbacks",
        "type": "number",
        "description": "In order to implement button actions, the dingz plugin exposes a webserver for callbacks. By default, it listens on port 18081. Add this setting if you want to change this."
      },
      "callbackOverride": {
        "title": "Override generic callbacks",
        "type": "boolean",
        "description": "If set, actions will be overriden, that is, existing action URLs (for the 'generic' endpoint) will be <em>replaced</em> by an action to this server only. Useful for testing and/or resetting your devices if you homebridge server's address changes."
      },
      "devices": {
        "title": "dingz Devices",
        "type": "array",
        "items": {
          "title": "dingz",
          "type": "object",
          "properties": {
            "type": {
              "title": "Device Type",
              "type": "string",
              "oneOf": [
                { "title": "dingz", "enum": ["dingz"] },
                { "title": "myStrom Switch", "enum": ["myStromSwitch"] },
                { "title": "myStrom Lightbulb", "enum": ["myStromBulb"] },
                { "title": "myStrom LED Strip", "enum": ["myStromLED"] },
                {
                  "title": "myStrom PIR (Motion) Sensor",
                  "enum": ["myStromPIR"]
                },
                { "title": "myStrom Button", "enum": ["myStromButton"] },
                {
                  "title": "myStrom Button+ (2nd Gen)",
                  "enum": ["myStromButtonPlus"]
                }
              ],
              "required": true
            },
            "name": {
              "title": "Name",
              "type": "string",
              "default": "dingz SmartHome Device",
              "required": true
            },
            "address": {
              "title": "IP / Hostname",
              "type": "string",
              "format": "hostname",
              "required": true
            },
            "token": {
              "title": "REST API Token",
              "type": "string",
              "description": "If you have set a Token to protect the REST API, enter it here. Highly recommended."
            }
          }
        }
      }
    }
  }
}