homebridge-pushover-notification/config.schema.json

Homebridge plugin to send push notifications through Pushover from HomeKit

{
  "pluginAlias": "PushoverNotification",
  "pluginType": "platform",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "default": "Pushover Notification"
      },
      "user": {
        "title": "User Key",
        "description": "The user key for your Pushover account.",
        "type": "string"
      },
      "token": {
        "title": "API Token",
        "description": "The application API token created under your Pushover account.",
        "type": "string"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "title": "Name",
              "description": "Name of the switch shown in the Home app.",
              "type": "string"
            },
            "title": {
              "title": "Title",
              "description": "Title of the notification sent to the device.",
              "type": "string"
            },
            "message": {
              "title": "Message",
              "description": "Message text of the notification sent to the device.",
              "type": "string"
            },
            "priority": {
              "title": "Priority",
              "description": "Priority of the message. Default: normal [<a href=\"https://pushover.net/api#prioritys\" target=\"_blank\">More info</a>]",
              "type": "string",
              "default": "normal",
              "oneOf": [
                {
                  "title": "Emergency",
                  "const": "emergency"
                },
                {
                  "title": "High",
                  "const": "high"
                },
                {
                  "title": "Normal",
                  "const": "normal"
                },
                {
                  "title": "Low",
                  "const": "low"
                },
                {
                  "title": "Lowest",
                  "const": "lowest"
                }              
              ]
            },
            "retry": {
              "title": "Retry interval (seconds)",
              "description": "How often to send the notification until it has been acknowledged. Only applicable when priority is set to 'Emergency'. Note: Max number of retries is 50, regardless of the set interval. Default: 300 (5 mins). Min: 30",
              "placeholder": "300",
              "type": "integer",
              "minimum": 30
            },
            "expire": {
              "title": "Expire time (seconds)",
              "description": "Total time the notification will be resent until it has been acknowledged. Only applicable when priority is set to 'Emergency'. Default: 1800 (30 mins). Max: 10800 (3 hours)",
              "placeholder": "1800",
              "type": "integer",
              "maximum": 10800
            },
            "sound": {
              "title": "Sound",
              "description": "Sound to be played when notification is received on device. Default: pushover [<a href=\"https://pushover.net/api#sounds\" target=\"_blank\">More info</a>]",
              "placeholder": "pushover",
              "type": "string"
            },
            "cooldownTime": {
              "title": "Cooldown time (millis)",
              "description": "Minimum time before this message can be sent again. Default: off",
              "type": "integer"
            }
          },
          "required": ["name", "message"]
        }
      }
    },
    "required": ["name", "user", "token", "messages"]
  },
  "layout": [
    {
      "type": "fieldset",
      "title": "General Settings",
      "items": [
        "user",
        "token"
      ]
    },
    {
      "type": "array",
      "title": "Messages",
      "key": "messages",
      "items": [
        {
          "type": "section",
          "items": [
            "messages[].name",
            "messages[].title",
            "messages[].message",
            "messages[].priority",
            "messages[].retry",
            "messages[].expire",
            "messages[].sound",
            "messages[].cooldownTime"
          ]
        }
      ]
    }
  ]
}