config.schema.json

{
  "pluginAlias": "OpenSpa",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "OpenSpa by Ungodly Design. Hardware available [here](https://ungodly.design/openspa).",
  "schema": {
    "type": "object",
    "properties": {
      "manufacturer": {
        "type": "string",
        "title": "Manufacturer",
        "description": "Name of the manufacturer.",
        "required": true
      },
      "platform": {
        "type": "string",
        "title": "Platform Name",
        "description": "Name of the platform.",
        "required": true
      },
      "name": {
        "type": "string",
        "title": "Sauna System Name",
        "description": "Custom name for the sauna system.",
        "required": true
      },
      "serial": {
        "type": "string",
        "title": "Serial Number",
        "description": "Custom serial number for the sauna system.",
        "required": true
      },
      "hasSauna": {
        "type": "boolean",
        "title": "Enable Sauna",
        "description": "Indicates if the sauna functionality is available.",
        "default": false
      },
      "hasSaunaSplitPhase": {
        "type": "boolean",
        "title": "Sauna Split Phase",
        "description": "False for 120V, True for 240V sauna configuration.",
        "default": false
      },
      "hasSteam": {
        "type": "boolean",
        "title": "Enable Steam",
        "description": "Indicates if the steam room functionality is available.",
        "default": false
      },
      "hasSteamI2C": {
        "type": "boolean",
        "title": "Steam I2C Sensor",
        "description": "Indicates if the I2C humidity/temp sensor is available.",
        "default": false
      },
      "hasSteamSplitPhase": {
        "type": "boolean",
        "title": "Steam Split Phase",
        "description": "False for 120V, True for 240V steam configuration.",
        "default": false
      },
      "hasLight": {
        "type": "boolean",
        "title": "Enable Light Control",
        "description": "Indicates if light control is available.",
        "default": false
      },
      "hasFan": {
        "type": "boolean",
        "title": "Enable Fan Control",
        "description": "Indicates if fan control is available.",
        "default": false
      },
      "inverseSaunaDoor": {
        "type": "boolean",
        "title": "Inverse Sauna Door Logic",
        "description": "True if sauna door sensor logic is inverted.",
        "default": false
      },
      "inverseSteamDoor": {
        "type": "boolean",
        "title": "Inverse Steam Door Logic",
        "description": "True if steam door sensor logic is inverted.",
        "default": false
      },
      "temperatureUnitFahrenheit": {
        "type": "boolean",
        "title": "Temperature Unit Fahrenheit",
        "description": "True for Fahrenheit, False for Celsius.",
        "default": false
      },
      "GPIO": {
        "type": "object",
        "title": "GPIO Pins Configuration",
        "properties": {
          "saunaPowerPins": {
            "type": "array",
            "title": "Sauna Power Pins",
            "description": "Array of GPIO pins for sauna power control.",
            "items": {
              "type": "number"
            },
            "default": []
          },
          "steamPowerPins": {
            "type": "array",
            "title": "Steam Power Pins",
            "description": "Array of GPIO pins for steam power control.",
            "items": {
              "type": "number"
            },
            "default": []
          },
          "lightPin": {
            "type": "number",
            "title": "Light Control Pin",
            "description": "Optional GPIO pin for light control.",
            "default": null
          },
          "fanPin": {
            "type": "number",
            "title": "Fan Control Pin",
            "description": "Optional GPIO pin for fan control.",
            "default": null
          },
          "saunaDoorPin": {
            "type": "number",
            "title": "Sauna Door Sensor Pin",
            "description": "GPIO pin for sauna door sensor.",
            "default": null
          },
          "steamDoorPin": {
            "type": "number",
            "title": "Steam Door Sensor Pin",
            "description": "GPIO pin for steam door sensor.",
            "default": null
          }
        }
      },
      "thermistors": {
        "type": "array",
        "title": "Auxiliary Sensors",
        "description": "Array of auxiliary sensors for additional readings.",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "title": "Sensor Name",
              "description": "Name or label for the auxiliary sensor.",
              "required": true
            },
            "channel": {
              "type": "number",
              "title": "ADC Channel",
              "description": "ADC channel for the auxiliary sensor.",
              "required": true
            },
            "system": {
              "type": "string",
              "title": "Associated System",
              "description": "System this sensor is associated with.",
              "enum": ["sauna", "steam", "controller", null],
              "default": null
            },
            "control": {
              "type": "boolean",
              "title": "Impact Control",
              "description": "Whether this sensor impacts system control.",
              "default": false
            },
            "resistanceAt25C": {
              "type": "number",
              "title": "Resistance at 25°C",
              "description": "NTC resistance in Ohms at 25°C.",
              "required": true
            },
            "bValue": {
              "type": "number",
              "title": "B Value",
              "description": "NTC beta value.",
              "required": true
            }
          }
        },
        "default": []
      },
      "saunaOnWhileDoorOpen": {
        "type": "boolean",
        "title": "Sauna On While Door Open",
        "description": "Allows the sauna to be on while the door is open.",
        "default": false
      },
      "steamOnWhileDoorOpen": {
        "type": "boolean",
        "title": "Steam On While Door Open",
        "description": "Allows the steam room to be on while the door is open.",
        "default": false
      },
      "saunaTimeout": {
        "type": "number",
        "title": "Sauna Timeout",
        "description": "Maximum runtime for the sauna in minutes before auto-shutdown.",
        "default": 60
      },
      "steamTimeout": {
        "type": "number",
        "title": "Steam Timeout",
        "description": "Maximum runtime for the steam room in minutes before auto-shutdown.",
        "default": 60
      },
      "controllerSafetyTemperature": {
        "type": "number",
        "title": "Controller Safety Temperature",
        "description": "Safety limit for the controller board temperature in degrees.",
        "default": 85
      },
      "saunaMaxTemperature": {
        "type": "number",
        "title": "Sauna Maximum Temperature",
        "description": "Maximum user-configurable temperature for the sauna in degrees.",
        "default": 80
      },
      "saunaSafetyTemperature": {
        "type": "number",
        "title": "Sauna Safety Temperature",
        "description": "Safety limit for sauna temperature in degrees.",
        "default": 100
      },
      "steamMaxTemperature": {
        "type": "number",
        "title": "Steam Maximum Temperature",
        "description": "Maximum user-configurable temperature for the steam room in degrees.",
        "default": 50
      },
      "steamSafetyTemperature": {
        "type": "number",
        "title": "Steam Safety Temperature",
        "description": "Safety limit for steam room temperature in degrees.",
        "default": 60
      },
      "steamMaxHumidity": {
        "type": "number",
        "title": "Steam Maximum Humidity",
        "description": "Maximum user-configurable humidity for the steam room in percent.",
        "default": 95
      }
    }
  }
}