config.schema.json

{
  "pluginAlias": "Intercom Plugin",
  "pluginType": "platform",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "default": "Intercom",
        "description": "The name that will appear in your Homebridge log."
      },
      "manufacturer": {
        "title": "Manufacturer",
        "type": "string",
        "default": "Default-Manufacturer",
        "description": "What will show under Manufacturer in accessory settings."
      },
      "model": {
        "title": "Model",
        "type": "string",
        "default": "Default-Model",
        "description": "What will show under Model in accessory settings."
      },
      "serialNumber": {
        "title": "Serial Number",
        "type": "string",
        "default": "Default-Serial",
        "description": "What will show under Serial Number in accessory settings."
      },
      "timeout": {
        "title": "Timeout",
        "type": "number",
        "default": 10,
        "minimum": 5,
        "maximum": 60,
        "description": "The number of seconds between the unlocking and locking notifications. Defaults to 10 seconds."
      },
      "intercomType": {
        "title": "Intercom",
        "type": "string",
        "description": "Select your intercom model.",
        "oneOf": [
          {
            "title": "Shelly Uni",
            "enum": [
              "shellyUni"
            ]
          }
        ],
        "default": "shellyUni"
      },
      "shellyUniRingNotificationType": {
        "title": "Ring Notification Type",
        "type": "string",
        "description": "Choose how the plugin should detect ringing: 'request' exposes a webhook that the Shelly Uni calls, and 'poll' means the plugin polls an endpoint.",
        "oneOf": [
          {
            "title": "Request",
            "enum": [
              "request"
            ]
          },
          {
            "title": "Poll",
            "enum": [
              "poll"
            ]
          }
        ],
        "default": "request"
      },
      "shellyUniWebhookPort": {
        "title": "Webhook Port",
        "type": "number",
        "minimum": 1,
        "maximum": 65535,
        "default": 9000,
        "description": "The port on which the webhook will listen for 'http://homebridge_ip:port/ringing?status=$value' calls.\nWARNING: If you're running this in docker you must expose this port to the host.",
        "condition": {
          "functionBody": "return model.shellyUniRingNotificationType === 'request' && model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniStatusUrl": {
        "title": "Status URL",
        "type": "string",
        "placeholder": "http://shelly_user@shelly_ip/status",
        "description": "URL which retrieves the status of the Shelly Uni.",
        "condition": {
          "functionBody": "return model.shellyUniRingNotificationType === 'poll' && model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniStatusJsonPath": {
        "title": "Status JSON Path",
        "type": "string",
        "placeholder": "field1.0.field2",
        "description": "Path in JSON structure to the field that changes upon ringing.",
        "condition": {
          "functionBody": "return model.shellyUniRingNotificationType === 'poll' && model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniPollingInterval": {
        "title": "Poll Interval",
        "type": "number",
        "minimum": 1,
        "maximum": 60,
        "default": 1,
        "description": "The interval in seconds at which the plugin polls the endpoint for ringing status.",
        "condition": {
          "functionBody": "return model.shellyUniRingNotificationType === 'poll' && model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniStatusThreshold": {
        "title": "Status Threshold",
        "type": "number",
        "minimum": 1,
        "maximum": 100,
        "default": 2,
        "description": "The minimum value considered as a ringing trigger for 'poll' or 'request' methods.",
        "condition": {
          "functionBody": "return model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniTalkUrl": {
        "title": "Talk URL",
        "type": "string",
        "placeholder": "http://shelly_user@shelly_ip/relay/0?turn=on",
        "description": "URL which triggers Talk button on the Shelly Uni.",
        "condition": {
          "functionBody": "return model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniOpenUrl": {
        "title": "Open URL",
        "type": "string",
        "placeholder": "http://shelly_user@shelly_ip/relay/0?turn=on",
        "description": "URL which triggers Open button on the Shelly Uni.",
        "condition": {
          "functionBody": "return model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniButtonsOrder": {
        "title": "Buttons pressing order",
        "type": "string",
        "placeholder": "talk-open-talk",
        "description": "Some intercoms require different pressing order.",
        "condition": {
          "functionBody": "return model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniButtonsTimeout": {
        "title": "Buttons timeout",
        "type": "number",
        "default": 1,
        "minimum": 1,
        "maximum": 5,
        "description": "The number of seconds between pressing the buttons.",
        "condition": {
          "functionBody": "return model.intercomType === 'shellyUni';"
        }
      },
      "shellyUniRingSuppressionTimeout": {
        "title": "Ring suppression timeout",
        "type": "number",
        "default": 0,
        "minimum": 0,
        "description": "Seconds to ignore subsequent ringings after the first one.",
        "condition": {
          "functionBody": "return model.intercomType === 'shellyUni';"
        }
      }
    },
    "required": [
      "name",
      "timeout",
      "intercomType",
      "shellyUniRingNotificationType",
      "shellyUniStatusThreshold",
      "shellyUniTalkUrl",
      "shellyUniOpenUrl",
      "shellyUniButtonsOrder",
      "shellyUniButtonsTimeout",
      "shellyUniRingSuppressionTimeout"
    ],
    "allOf": [
      {
        "if": {
          "properties": {
            "shellyUniRingNotificationType": {
              "const": "poll"
            }
          }
        },
        "then": {
          "required": [
            "shellyUniStatusUrl",
            "shellyUniStatusJsonPath",
            "shellyUniPollingInterval"
          ]
        }
      },
      {
        "if": {
          "properties": {
            "shellyUniRingNotificationType": {
              "const": "request"
            }
          }
        },
        "then": {
          "required": [
            "shellyUniWebhookPort"
          ]
        }
      }
    ]
  }
}