config.schema.json

{
  "pluginAlias": "Ecowitt",
  "pluginType": "platform",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "mac": {
        "title": "MAC Address",
        "type": "string",
        "pattern": "^([A-Fa-f0-9]{2}:){5}[A-Fa-f0-9]{2}$",
        "required": true,
        "default" : "00:00:00:00",
        "description": "The MAC address of your console or gateway"
      },
      "port": {
        "title": "Port",
        "type": "integer",
        "required": true,
        "default": "8080",
        "description": "Port number on which to listen for data reports"
      },
      "path": {
        "title": "Path",
        "type": "string",
        "required": true,
        "default": "/data/report/",
        "description": "Host path which will receive data reports"
      },
      "showasthermostat": {
        "title": "Fake thermostat",
        "type": "boolean",
        "required": true,
        "default": false,
        "description": "Adds fake thermostat tiles for temperature sensors"
      },
      "updatelogleveldebug": {
        "title": "Log updates as debug",
        "type": "boolean",
        "required": true,
        "default": false,
        "description": "After initialization, only log updates at the debug level"
      },
      "unregister": {
        "title": "Unregister",
        "type": "boolean",
        "required": true,
        "default": false,
        "description": "Removes existing accessories and reregisters with defaults (only enable when you're sure this is what you want)"
      },      
      "ws": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          },
          "uv": {
            "type": "object",
            "properties": {
              "hide": {
                "title": "Hide",
                "type": "boolean",
                "default": false
              },
              "threshold": {
                "title": "Threshold",
                "type": "integer",
                "default": 6,
                "description": "<p class='help-block'><br/><b><u>UV Levels</u></b><br/>0-2: Low<br/>3-5: Moderate<br/>6-7: High<br/>8-10: Very High<br/>11+: Extreme</p>"
              }
            }
          },
          "solarradiation": {
            "type": "object",
            "properties": {
              "hide": {
                "title": "Hide",
                "type": "boolean",
                "default": false
              },
              "luxFactor": {
                "title": "W/m² to lux conversion factor",
                "type": "number",
                "default": 126.7
              }
            }
          },
          "wind": {
            "type": "object",
            "properties": {
              "units": {
                "title": "Units",
                "type": "string",
                "default": "beaufort",
                "oneOf": [
                  {
                    "title": "Miles per hour",
                    "enum": [
                      "mph"
                    ]
                  },
                  {
                    "title": "Knots",
                    "enum": [
                      "kts"
                    ]
                  },
                  {
                    "title": "Kilometers per hour",
                    "enum": [
                      "kmh"
                    ]
                  },
                  {
                    "title": "Meters per second",
                    "enum": [
                      "mps"
                    ]
                  },
                  {
                    "title": "Beaufort Scale",
                    "enum": [
                      "beaufort"
                    ]
                  }
                ],
                "required": true
              },
              "hide": {
                "title": "Hide",
                "type": "array",
                "uniqueItems": true,
                "items": {
                  "title": "Indicator",
                  "type": "string",
                  "enum": [
                    "Direction",
                    "Speed",
                    "Gust",
                    "MaxDailyGust"
                  ]
                }
              },
              "speedThreshold": {
                "title": "Wind speed threshold (<a href=\"https://simple.wikipedia.org/wiki/Beaufort_scale\" target=\"_blank\" rel=\"noopener noreferrer\">Beaufort scale</a>)",
                "type": "integer",
                "minimum": 0,
                "maximum": 12,
                "default": 1
              },
              "gustThreshold": {
                "title": "Wind gusts threshold (<a href=\"https://simple.wikipedia.org/wiki/Beaufort_scale\" target=\"_blank\" rel=\"noopener noreferrer\">Beaufort scale</a>)",
                "type": "integer",
                "minimum": 0,
                "maximum": 12,
                "default": 3
              },
              "maxDailyGustThreshold": {
                "title": "Max daily gust threshold (<a href=\"https://simple.wikipedia.org/wiki/Beaufort_scale\" target=\"_blank\" rel=\"noopener noreferrer\">Beaufort scale</a>)",
                "type": "integer",
                "minimum": 0,
                "maximum": 12,
                "default": 8
              }
            }
          },
          "rain": {
            "type": "object",
            "properties": {
              "units": {
                "title": "Units",
                "type": "string",
                "default": "mm",
                "oneOf": [
                  {
                    "title": "Millimeters",
                    "enum": [
                      "mm"
                    ]
                  },
                  {
                    "title": "Inches",
                    "enum": [
                      "in"
                    ]
                  }
                ],
                "required": true
              },
              "hide": {
                "title": "Hide",
                "type": "array",
                "uniqueItems": true,
                "items": {
                  "title": "Indicator",
                  "type": "string",
                  "enum": [
                    "Rate",
                    "Event",
                    "Hourly",
                    "Daily",
                    "Weekly",
                    "Monthly",
                    "Yearly"
                  ]
                }
              },
              "rateThreshold": {
                "title": "Rate threshold (mm)",
                "type": "number"
              },
              "eventThreshold": {
                "title": "Event threshold (mm)",
                "type": "number"
              },
              "hourlyThreshold": {
                "title": "Hourly threshold (mm)",
                "type": "number"
              },
              "dailyThreshold": {
                "title": "Daily threshold (mm)",
                "type": "number"
              },
              "weeklyThreshold": {
                "title": "Weekly threshold (mm)",
                "type": "number"
              },
              "monthlyThreshold": {
                "title": "Monthly threshold (mm)",
                "type": "number"
              },
              "yearlyThreshold": {
                "title": "Yearly threshold (mm)",
                "type": "number",
                "description": "Blank threshold = no detection trigger"
              }
            }
          }
        }
      },
      "thbin": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          }
        }
      },
      "th": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          },
          "name1": {
            "title": "Channel 1",
            "type": "string"
          },
          "name2": {
            "title": "Channel 2",
            "type": "string"
          },
          "name3": {
            "title": "Channel 3",
            "type": "string"
          },
          "name4": {
            "title": "Channel 4",
            "type": "string"
          },
          "name5": {
            "title": "Channel 5",
            "type": "string"
          },
          "name6": {
            "title": "Channel 6",
            "type": "string"
          },
          "name7": {
            "title": "Channel 7",
            "type": "string"
          },
          "name8": {
            "title": "Channel 8",
            "type": "string"
          }
        }
      },
      "thod": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          }
        }
      },
      "soil": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          },
          "name1": {
            "title": "Channel 1",
            "type": "string"
          },
          "name2": {
            "title": "Channel 2",
            "type": "string"
          },
          "name3": {
            "title": "Channel 3",
            "type": "string"
          },
          "name4": {
            "title": "Channel 4",
            "type": "string"
          },
          "name5": {
            "title": "Channel 5",
            "type": "string"
          },
          "name6": {
            "title": "Channel 6",
            "type": "string"
          },
          "name7": {
            "title": "Channel 7",
            "type": "string"
          },
          "name8": {
            "title": "Channel 8",
            "type": "string"
          }
        }
      },
      "leak": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          },
          "name1": {
            "title": "Channel 1",
            "type": "string"
          },
          "name2": {
            "title": "Channel 2",
            "type": "string"
          },
          "name3": {
            "title": "Channel 3",
            "type": "string"
          },
          "name4": {
            "title": "Channel 4",
            "type": "string"
          }
        }
      },
      "pm25": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          },
          "name1": {
            "title": "Channel 1",
            "type": "string"
          },
          "name2": {
            "title": "Channel 2",
            "type": "string"
          },
          "name3": {
            "title": "Channel 3",
            "type": "string"
          },
          "name4": {
            "title": "Channel 4",
            "type": "string"
          }
        }
      },
      "lightning": {
        "type": "object",
        "properties": {
          "hide": {
            "title": "Hide",
            "type": "boolean",
            "default": false
          },
          "units": {
            "title": "Distance Units",
            "type": "string",
            "default": "km",
            "oneOf": [
              {
                "title": "Kilometres",
                "enum": [
                  "km"
                ]
              },
              {
                "title": "Miles",
                "enum": [
                  "mi"
                ]
              }
            ],
            "required": true
          }
        }
      }
    }
  },
  "form": [
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Base Station",
      "items": [
        "mac",
        {
          "type": "section",
          "expandable": true,
          "expanded": true,
          "title": "Data Report Service",
          "items": [
            "port",
            "path",
            "showasthermostat",
            "updatelogleveldebug",
            "unregister"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Outdoor Weather Sensors",
      "items": [
        "ws.hide",
        {
          "type": "fieldset",
          "notitle": true,
          "condition": {
            "functionBody": "return !model.ws.hide;"
          },
          "items": [
            {
              "type": "section",
              "expandable": true,
              "expanded": false,
              "title": "Wind",
              "items": [
                "ws.wind.units",
                "ws.wind.hide",
                "ws.wind.speedThreshold",
                "ws.wind.gustThreshold",
                "ws.wind.maxDailyGustThreshold"
              ]
            },
            {
              "type": "section",
              "expandable": true,
              "expanded": false,
              "title": "Rain",
              "items": [
                "ws.rain.units",
                "ws.rain.hide",
                "ws.rain.rateThreshold",
                "ws.rain.eventThreshold",
                "ws.rain.hourlyThreshold",
                "ws.rain.dailyThreshold",
                "ws.rain.weeklyThreshold",
                "ws.rain.monthlyThreshold",
                "ws.rain.yearlyThreshold"
              ]
            },
            {
              "type": "section",
              "expandable": true,
              "expanded": false,
              "title": "UV",
              "items": [
                "ws.uv.hide",
                {
                  "type": "fieldset",
                  "notitle": true,
                  "condition": {
                    "functionBody": "return !model.ws.uv.hide;"
                  },
                  "items": [
                    "ws.uv.threshold"
                  ]
                }
              ]
            },
            {
              "type": "section",
              "expandable": true,
              "expanded": false,
              "title": "Solar Radiation",
              "items": [
                "ws.solarradiation.hide",
                {
                  "type": "fieldset",
                  "notitle": true,
                  "condition": {
                    "functionBody": "return !model.ws.solarradiation.hide;"
                  },
                  "items": [
                    "ws.solarradiation.luxFactor"
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Indoor Thermometer/Hygrometer/Barometer Sensor",
      "items": [
        "thbin.hide"
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Multi-Channel Thermometer/Hygrometer Sensors",
      "items": [
        "th.hide",
        {
          "type": "fieldset",
          "notitle": true,
          "condition": {
            "functionBody": "return !model.th.hide;"
          },
          "items": [
            "th.name1",
            "th.name2",
            "th.name3",
            "th.name4",
            "th.name5",
            "th.name6",
            "th.name7",
            "th.name8"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Outdoor Thermometer/Hygrometer Sensor",
      "items": [
        "thod.hide"
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Lightning Detection Sensor",
      "items": [
        "lightning.hide",
        {
          "type": "fieldset",
          "notitle": true,
          "condition": {
            "functionBody": "return !model.lightning.hide;"
          },
          "items": [
            "lightning.units"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Soil Moisture Sensors",
      "items": [
        "soil.hide",
        {
          "type": "fieldset",
          "notitle": true,
          "condition": {
            "functionBody": "return !model.soil.hide;"
          },
          "items": [
            "soil.name1",
            "soil.name2",
            "soil.name3",
            "soil.name4",
            "soil.name5",
            "soil.name6",
            "soil.name7",
            "soil.name8"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "Leak Detection Sensors",
      "items": [
        "leak.hide",
        {
          "type": "section",
          "notitle": true,
          "condition": {
            "functionBody": "return !model.leak.hide;"
          },
          "items": [
            "leak.name1",
            "leak.name2",
            "leak.name3",
            "leak.name4"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "expandable": true,
      "expanded": false,
      "title": "PM2.5 Air Quality Sensors",
      "items": [
        "pm25.hide",
        {
          "type": "fieldset",
          "notitle": true,
          "condition": {
            "functionBody": "return !model.pm25.hide;"
          },
          "items": [
            "pm25.name1",
            "pm25.name2",
            "pm25.name3",
            "pm25.name4"
          ]
        }
      ]
    }
  ]
}