homebridge-tahoma/platform.schema.json

Sample Platform plugin for TaHoma and Cozytouch services (Somfy,Atlantic,Thermor,Sauter): https://github.com/dubocr/homebridge-tahoma

{
  "plugin_alias": "Tahoma",
  "schema": {
    "type": "object",
    "properties": {
      "platform": {
        "title": "Platform",
        "type": "string",
        "const": "Tahoma",
        "readOnly": true
      },
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "TaHoma",
        "description": "The name of this platform in HomeKit"
      },
      "service": {
        "title": "Service",
        "type": "string",
        "default": "somfy_europe",
        "oneOf": [
          {
            "title": "Local API (TaHoma / Switch)",
            "enum": [
              "local"
            ]
          },
          {
            "title": "Somfy Europe (TaHoma / Switch / Connexoon IO)",
            "enum": [
              "somfy_europe"
            ]
          },
          {
            "title": "Somfy Australia (Connexoon RTS)",
            "enum": [
              "somfy_australia"
            ]
          },
          {
            "title": "Somfy North America",
            "enum": [
              "somfy_north_america"
            ]
          },
          {
            "title": "Cozytouch (Atlantic / Thermor / Sauter)",
            "enum": [
              "cozytouch"
            ]
          },
          {
            "title": "Energeasy Connect (Rexel)",
            "enum": [
              "rexel"
            ]
          },
          {
            "title": "Hi Kumo (Hitachi)",
            "enum": [
              "hi_kumo"
            ]
          },
          {
            "title": "Flexom (Bouygues)",
            "enum": [
              "flexom"
            ]
          }
        ],
        "required": true,
        "description": "Service name"
      },
      "user": {
        "title": "Username",
        "type": "string",
        "description": "Your username for selected service (email, gateway Pin or IP)"
      },
      "password": {
        "title": "Password",
        "type": "string",
        "options": {
          "hidden": true
        },
        "description": "Your password/token for selected service"
      },
      "exposeScenarios": {
        "title": "Expose scenarios",
        "type": "boolean",
        "description": "Expose scenarios as HomeKit switch to trigger them"
      },
      "exclude": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of device or scenario to exclude (should be a name, widget, uiClass or protocol)"
      }
    }
  }
}