homebridge-proflame/config.schema.json

Homebridge plugin for Mendota / Proflame Connect fireplaces via WebSocket

{
  "pluginAlias": "ProflameFireplace",
  "pluginType": "accessory",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Accessory Name",
        "type": "string",
        "default": "Fireplace"
      },
      "ip": {
        "title": "Device IP Address *",
        "type": "string",
        "placeholder": "192.168.1.252",
        "description": "Local IP of the Mendota / Proflame Connect module."
      },
      "layout": {
        "title": "Layout",
        "type": "string",
        "default": "heaterCooler",
        "enum": [
          "heaterCooler",
          "classic"
        ]
      },
      "logLevel": {
        "title": "Log Level",
        "type": "string",
        "default": "none",
        "enum": [
          "none",
          "info",
          "debug"
        ]
      },
      "pilotEnabled": {
        "title": "Pilot Control (classic only)",
        "type": "boolean",
        "default": false
      },
      "fanEnabled": {
        "title": "Fan / Blower Control",
        "type": "boolean",
        "default": false
      },
      "splitFlowEnabled": {
        "title": "Flame Split Control",
        "type": "boolean",
        "default": false
      },
      "auxEnabled": {
        "title": "Aux Output",
        "type": "boolean",
        "default": false
      },
      "flameControlEnabled": {
        "title": "Flame Control Tile (classic only)",
        "type": "boolean",
        "default": false
      },
      "thermostatEnabled": {
        "title": "Thermostat Tile (classic only)",
        "type": "boolean",
        "default": false
      },
      "lampEnabled": {
        "title": "Lamp / Fireplace Light",
        "type": "boolean",
        "default": false
      },
      "smartModeEnabled": {
        "title": "Smart Mode (classic only)",
        "type": "boolean",
        "default": false
      },
      "presets": {
        "title": "On Preset",
        "type": "object",
        "properties": {
          "onPreset": {
            "title": "Preset Settings Applied When Turning On",
            "type": "object",
            "properties": {
              "flameLevel": {
                "title": "Default Flame Level (0\u20136)",
                "type": "integer",
                "minimum": 0,
                "maximum": 6,
                "ui": {
                  "type": "number"
                }
              },
              "fanLevel": {
                "title": "Default Fan Level (0\u20136)",
                "type": "integer",
                "minimum": 0,
                "maximum": 6,
                "ui": {
                  "type": "number"
                }
              },
              "splitLevel": {
                "title": "Default Split Flow (toggle)",
                "type": "boolean"
              },
              "lampLevel": {
                "title": "Default Lamp Level (0\u20136)",
                "type": "integer",
                "minimum": 0,
                "maximum": 6,
                "ui": {
                  "type": "number"
                }
              },
              "mode": {
                "title": "Default Mode (string)",
                "type": "string",
                "default": "manual"
              }
            }
          }
        }
      }
    },
    "required": [
      "ip"
    ]
  },
  "layout": [
    {
      "key": "name"
    },
    {
      "key": "ip"
    },
    {
      "key": "layout"
    },
    {
      "key": "logLevel"
    },
    {
      "type": "fieldset",
      "title": "Optional Features",
      "items": [
        "pilotEnabled",
        "fanEnabled",
        "splitFlowEnabled",
        "auxEnabled",
        "flameControlEnabled",
        "thermostatEnabled",
        "lampEnabled",
        "smartModeEnabled"
      ]
    },
    {
      "type": "fieldset",
      "title": "On Preset Settings",
      "expandable": true,
      "expanded": true,
      "items": [
        {
          "key": "presets.onPreset.flameLevel",
          "type": "number",
          "placeholder": "0\u20136"
        },
        {
          "key": "presets.onPreset.fanLevel",
          "type": "number",
          "placeholder": "0\u20136"
        },
        {
          "key": "presets.onPreset.splitLevel",
          "type": "checkbox"
        },
        {
          "key": "presets.onPreset.lampLevel",
          "type": "number",
          "placeholder": "0\u20136"
        },
        {
          "key": "presets.onPreset.mode",
          "type": "text",
          "placeholder": "manual"
        }
      ]
    }
  ]
}