config.schema.json

{
  "pluginAlias": "Flo-by-Moen",
  "pluginType": "platform",
  "singular": true,
  "footerDisplay": "Flo Module Configuration",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "Flo-by-Moen",
        "placeholder": "e.g. Flo By Moen"
      },
      "auth": {
        "title": "Authorization",
        "type": "object",
        "properties": {
          "username": {
            "title": "Flo Username",
            "type": "string",
            "required": true,
            "x-schema-form": {
              "type": "username"
            }
          },
          "password": {
            "title": "Flo Password",
            "type": "string",
            "required": true,
            "x-schema-form": {
              "type": "password"
            }
          }
        }
      },
        "disableCache": {
        "title": "Disable Caching of Flo Token",
        "type": "boolean",
        "default": false
      },
        "showTemperatureAndHumidity": {
        "title": "Show Water Sensor Temperature and Humidity in HomeKit",
        "type": "boolean",
        "default": true,
        "description": "Display Water Sensor(s) area temperature and humidity in HomeKit."
      },
        "enableValveControl": {
        "title": "Enable Valve Control in HomeKit",
        "type": "boolean",
        "default": false,
        "description": "Enable or disable Smart Water Shutoff within HomeKit."
      },
        "showHealthTestSwitch": {
        "title": "Run Health Test from HomeKit",
        "type": "boolean",
        "default": false,
        "description": "Display a Health Test switch button to start a manual Health Test in Flo."
      },
        "showAuxSwitch": {
        "title": "Create additional switch for turning on/off the water valve",
        "type": "boolean",
        "default": false,
        "description": "Display an auxiliary water on/off switch. This is useful in Apple's Home application, other Homekit applications such as Eve exposes the Flo valve for automation."
      },
        "treatWarningAsCritical": {
        "title": "Treat Warning as Critical Events",
        "type": "boolean",
        "default": false,
        "description": "This option allows <i>Warning</i> to be treated as <i>Critical</i> events thus trigging the alarm."
      },
       "clearOnNoLeak": {
        "title": "Auto Clear Leak Detection",
        "type": "boolean",
        "default": false,
        "description": "By default the leak event remain active until it is clear within the flo system, this option allows the plug-in to auto clear when water is no longer detected."
      },
        "deviceRefresh": {
        "title": "Device Refresh Interval (seconds)",
        "type": "integer",
        "default": 90,
        "description": "Poll interval to obtain device updates in seconds. <b>Please note:</b> A very low value may cause lockout to your account and/or API errors.",
        "minimum": 15,
        "maximum": 3600
      },
        "offlineTimeLimit": {
        "title": "Offline Time Limit (hours)",
        "type": "integer",
        "description": "Number of house with no refresh before considering device offline.",
        "default": 4,
        "minimum": 2,
        "maximum": 24
      },
        "sleepRevertMinutes": {
        "title": "Sleep Time",
        "type": "integer",
        "default": 120,
        "description": "Sleep Mode is a system mode that quiets all monitoring and alerting, effectively putting the Flo System to sleep. This value represents the length of time to place the system in sleep mode.",
        "oneOf": [{
          "title": "2 Hours",
          "enum": [
            120
          ]
        },
        {
          "title": "24 Hours",
          "enum": [
           1440
          ]
        },
        {
          "title": "72 Hours",
          "enum": [
            4320
          ]
        }
        ],
        "required": true
      },
      "securityControlOption": {
        "title": "Security Control Options",
        "type": "integer",
        "default": 0,
        "description": "This option allows you to control the display of the security control in HomeKit. The default is to display the security control. If security control is not displayed, auxiliary switch will be used to control the valve.",
        "oneOf": [{
          "title": "Enable Security Control",
          "enum": [
            0
          ]
        },
        {
          "title": "Enable Security Control, with no notifications and no alarm",
          "enum": [
            1
          ]
        },
        {
          "title": "Disable Security Control",
          "enum": [
            2
          ]
        }
        ],
        "required": true
      },
      "excludedDevices": {
        "type": "array",
        "items": {
          "type": "string",
          "description": "Serial Number"
        }
      },
      "retryErrorDisplay": {
        "title": "Maximum number of refresh error before alerting in log.",
        "type": "integer",
        "default": 3,
        "description": "At times the plug-in reports a 502 error. This is a communication error with the Flo server. An occasional error will not effect operations but can fill up log. This value define number of consecutive failure before logging.",
        "minimum": 3
      },
      "showGPMPSIasLight": {
        "title": "Show the current Gallons Per Minute (GPM) and Water Pressure (PSI) value as lux sensors.",
        "type": "boolean",
        "default": false
      }
    }
  },
  "layout": [{
      "type": "fieldset",
      "items": [
        "name",
        "auth.username",
        "auth.password",
        "deviceRefresh",
        "sleepRevertMinutes",
        "showTemperatureAndHumidity",
        "showHealthTestSwitch",
        "enableValveControl",
        "showAuxSwitch",
        "offlineTimeLimit"
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "title": "Advanced Options",
      "items": [
        "securityControlOption",
        "showGPMPSIasLight",
        "treatWarningAsCritical",
        "clearOnNoLeak",
        "retryErrorDisplay",
        {
          "key": "disableCache",
          "description": "Disabled the storage of Flo access token to local Homebridge server. Refresh token at start-up."

        },
        {
          "key": "excludedDevices",
          "title": "Excluded Devices",
          "description": "A list of devices to exclude from HomeKit. Users device serial number which can be found in the Flo app.",
          "add": "Add Another Device",
          "type": "array",
          "items": [
            {
              "type": "fieldset",
              "items": [
                "excludedDevices[]"
              ]
            }
          ]
        }
      ]
    }
  ]
}