config.schema.json

{
  "pluginAlias": "Meater",
  "pluginType": "platform",
  "singular": true,
  "customUi": true,
  "customUiPath": "./dist/homebridge-ui",
  "headerDisplay": "<p align='center'><img width='250px' src='https://raw.githubusercontent.com/homebridge-plugins/homebridge-meater/latest/branding/Homebridge_x_Meater.png'></p>\n\nThe **Meater** plugin allows you to see your Meater status.",
  "footerDisplay": "Please raise any issues on our [project page](https://github.com/homebridge-plugins/homebridge-meater/issues).\n\nFill out the [Feature Request Form](https://github.com/homebridge-plugins/homebridge-meater/issues/new?assignees=&labels=&template=feature_request.md) if there is a feature you would like to request.",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "title": "Name",
        "default": "Meater"
      },
      "credentials": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "title": "email",
            "placeholder": "apple@icloud.com",
            "format": "email"
          },
          "password": {
            "type": "string",
            "title": "Password",
            "x-schema-form": {
              "type": "password"
            }
          },
          "token": {
            "type": "string",
            "title": "Token",
            "x-schema-form": {
              "type": "token"
            }
          },
          "notice": {
            "title": "Notice",
            "type": "string",
            "default": "Keep your tokens a secret!"
          }
        },
        "required": ["email", "password"]
      },
      "options": {
        "type": "object",
        "properties": {
          "devices": {
            "type": "array",
            "items": {
              "title": "Devices",
              "type": "object",
              "properties": {
                "id": {
                  "title": "Device ID",
                  "type": "string",
                  "placeholder": "81F3UT59513F"
                },
                "configDeviceName": {
                  "title": "Device Name",
                  "type": "string",
                  "placeholder": "Hallway Thermostat",
                  "condition": {
                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].id);"
                  }
                },
                "hide_device": {
                  "title": "Hide Device",
                  "type": "boolean",
                  "condition": {
                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].id);"
                  }
                },
                "external": {
                  "title": "External Accessory",
                  "type": "boolean",
                  "condition": {
                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].id && !model.options.devices[arrayIndices].hide_device);"
                  }
                },
                "firmware": {
                  "title": "Firmware Override",
                  "type": "string",
                  "placeholder": "1.2.8",
                  "condition": {
                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].id && !model.options.devices[arrayIndices].hide_device);"
                  }
                },
                "refreshRate": {
                  "title": "Device Refresh Rate",
                  "type": "number",
                  "minimum": 30,
                  "maximum": 2073600,
                  "placeholder": 360,
                  "description": "Indicates the number of seconds between polls of Meater API.",
                  "condition": {
                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].id && !model.options.devices[arrayIndices].hide_device);"
                  }
                },
                "logging": {
                  "title": "Device Logging Level Override",
                  "description": "Overrides the plugin logging level for this device only. None turns off all messages from this plugin. Standard shows normal activity, warnings and errors. Debug adds detailed messages, and is what to use when reporting a problem. Default behaves the same as Standard.",
                  "type": "string",
                  "default": "",
                  "oneOf": [
                    {
                      "title": "Default (same as Standard)",
                      "enum": [""]
                    },
                    {
                      "title": "None",
                      "enum": ["none"]
                    },
                    {
                      "title": "Standard",
                      "enum": ["standard"]
                    },
                    {
                      "title": "Debug",
                      "enum": ["debug"]
                    }
                  ],
                  "condition": {
                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].id && !model.options.devices[arrayIndices].hide_device);"
                  }
                }
              },
              "required": ["id", "configDeviceName", "logging"]
            }
          },
          "refreshRate": {
            "title": "Refresh Rate",
            "type": "number",
            "minimum": 30,
            "maximum": 2073600,
            "placeholder": 120,
            "description": "Indicates the number of seconds between polls of the Meater service."
          },
          "logging": {
            "title": "Plugin Logging Level",
            "description": "None turns off all messages from this plugin. Standard shows normal activity, warnings and errors. Debug adds detailed messages, and is what to use when reporting a problem. Default behaves the same as Standard.",
            "type": "string",
            "default": "",
            "oneOf": [
              {
                "title": "Default (same as Standard)",
                "enum": [""]
              },
              {
                "title": "None",
                "enum": ["none"]
              },
              {
                "title": "Standard",
                "enum": ["standard"]
              },
              {
                "title": "Debug",
                "enum": ["debug"]
              }
            ]
          },
          "enableMatter": {
            "title": "Enable Matter",
            "type": "boolean",
            "default": true,
            "description": "Uses Matter automatically when Homebridge v2.0 Matter support is available. Disable this to force HAP-only behavior."
          },
          "allowInvalidCharacters": {
            "title": "Allow Invalid Characters",
            "type": "boolean",
            "default": false,
            "description": "Keep accessory names exactly as the provider reports them. Without this, characters HomeKit does not accept are stripped out and the change is reported in the log."
          }
        },
        "required": ["logging"]
      }
    }
  },
  "layout": [
    {
      "type": "fieldset",
      "title": "Meater Account Info",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "type": "help",
          "helpvalue": "<h5></h5><em class='primary-text'>This is for Manual Setup Only.</em>"
        },
        "credentials.email",
        "credentials.password",
        "credentials.token"
      ]
    },
    {
      "type": "fieldset",
      "title": "Meater Device Settings",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "key": "options.devices",
          "notitle": true,
          "type": "tabarray",
          "title": "{{ value.configDeviceName || value.id || 'New Meater Device' }}",
          "expandable": true,
          "expanded": false,
          "orderable": false,
          "items": [
            "options.devices[].configDeviceName",
            "options.devices[].id",
            "options.devices[].hide_device",
            "options.devices[].firmware",
            "options.devices[].external",
            "options.devices[].refreshRate",
            "options.devices[].logging"
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "Advanced Settings",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "type": "help",
          "helpvalue": "<h5>Refresh Rate</h5><em class='primary-text'>Refresh Rate indicates the number of seconds between polls of the Meater service.</em>"
        },
        {
          "key": "options.refreshRate",
          "notitle": true
        },
        "options.logging",
        "options.allowInvalidCharacters"
      ]
    },
    {
      "type": "fieldset",
      "title": "Matter Settings (Homebridge v2.0+)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "type": "help",
          "helpvalue": "<h5>Matter Support</h5><em class='primary-text'>Matter is selected automatically when available. Disable this option only if you want to force HAP.</em>"
        },
        "options.enableMatter"
      ]
    }
  ]
}