homebridge-shinobi/config.schema.json

A Homebridge plugin integrating Shinobi for motion detector cameras

{
  "pluginAlias": "Shinobi",
  "pluginType": "platform",
  "singular": false,
  "schema": {
    "type": "object",
    "required": [
      "shinobi_api",
      "api_key",
      "group_key",
      "monitors"
    ],
    "additionalProperties": true,
    "properties": {
      "shinobi_api": {
        "type": "string",
        "description": "The base URL for the Shinobi API (Refer to https://shinobi.video/docs/api)."
      },
      "api_key": {
        "type": "string",
        "description": "The Shinobi API key (configured in the Shinobi dashboard API menu)."
      },
      "group_key": {
        "type": "string",
        "description": "A Shinobi group key."
      },
      "monitors": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "monitor_id"
          ],
          "properties": {
            "monitor_id": {
              "type": "string",
              "description": "The Shinobi monitor ID."
            },
            "use_substream": {
              "type": "boolean",
              "default": false,
              "description": "Connect to sub-stream for monitor."
            }
          }
        }
      },
      "web_hook_port": {
        "type": "number",
        "description": "The port that the platform should listen on for motion event webhooks from Shinobi.",
        "default":  8080
      },
      "https_key_path": {
        "type": "string",
        "description": "If this AND https_cert_path are configured to point at valid files accessible by the platform the webhook server will use HTTPS e.g. /cert/privkey.pem"
      },
      "https_cert_path": {
        "type": "string",
        "description": "If this AND https_key_path are configured to point at valid files accessible by the platform the webhook server will use HTTPS e.g. /cert/fullchain.pem"
      },
      "ffmpeg_input_args": {
        "type": "string",
        "description": "These flags will be added to the ffmpeg command before the `-i` flag",
        "default": "-fflags +genpts"
      },
      "ffmpeg_process_args": {
        "type": "string",
        "description": "These flags will be added to the ffmpeg command after the source URL",
        "default": "-vsync drop -vcodec copy -an"
      }
    }
  }
}