config_schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Pi Portal Config File Schema v1.11",
  "definitions": {
    "constantOnOff": {
      "type": "string",
      "pattern": "^on|off$"
    }
  },
  "type": "object",
  "properties": {
    "ARCHIVAL": {
      "description": "Archival integration configuration.",
      "type": "object",
      "properties": {
        "AWS": {
          "description": "The AWS archival integration configuration.",
          "type": "object",
          "properties": {
            "AWS_ACCESS_KEY_ID": {
              "type": "string",
              "description": "The AWS access key credential with write access to the buckets."
            },
            "AWS_SECRET_ACCESS_KEY": {
              "type": "string",
              "description": "The AWS access secret key credential with write access to the buckets."
            },
            "AWS_S3_BUCKETS": {
              "type": "object",
              "properties": {
                "LOGS": {
                  "type": "string",
                  "description": "The name of the AWS S3 bucket to upload archived logs to."
                },
                "VIDEOS": {
                  "type": "string",
                  "description": "The name of the AWS S3 bucket to upload captured videos to."
                }
              },
              "required": [
                "LOGS",
                "VIDEOS"
              ]
            }
          },
          "required": [
            "AWS_ACCESS_KEY_ID",
            "AWS_SECRET_ACCESS_KEY",
            "AWS_S3_BUCKETS"
          ]
        }
      },
      "anyOf": [
        {
          "required": [
            "AWS"
          ]
        }
      ]
    },
    "CHAT": {
      "description": "Chat ops logging integration configuration.",
      "type": "object",
      "properties": {
        "SLACK": {
          "description": "Configuration for the Slack chat ops integration.",
          "type": "object",
          "properties": {
            "SLACK_APP_SIGNING_SECRET": {
              "type": "string",
              "description": "The secret value generated by Slack to validate messages from your bot."
            },
            "SLACK_APP_TOKEN": {
              "type": "string",
              "description": "The app token generated by Slack to allow your bot use websockets."
            },
            "SLACK_BOT_TOKEN": {
              "type": "string",
              "description": "The token generated by Slack when you created a bot app."
            },
            "SLACK_CHANNEL": {
              "type": "string",
              "description": "The plain human readable name of the Slack channel where messages should be posted."
            },
            "SLACK_CHANNEL_ID": {
              "type": "string",
              "description": "The ID of the slack channel.  Can be found at the bottom of the dialogue for 'View Channel Details > About'."
            },
            "SLACK_FILE_TRANSFER_TIMEOUT": {
              "type": "integer",
              "description": "The number of seconds to wait before timing out a file transfer."
            }
          },
          "required": [
            "SLACK_APP_SIGNING_SECRET",
            "SLACK_APP_TOKEN",
            "SLACK_BOT_TOKEN",
            "SLACK_CHANNEL",
            "SLACK_CHANNEL_ID",
            "SLACK_FILE_TRANSFER_TIMEOUT"
          ]
        }
      },
      "anyOf": [
        {
          "required": [
            "SLACK"
          ]
        }
      ]
    },
    "LOGS": {
      "description": "Logging integration configuration.",
      "type": "object",
      "properties": {
        "LOGZ_IO": {
          "description": "Configuration for the LogzIO logging integration.",
          "type": "object",
          "properties": {
            "LOGZ_IO_TOKEN": {
              "type": "string",
              "description": "A token generated by log.io, which will be injected into streamed logs to identify your account."
            }
          },
          "required": [
            "LOGZ_IO_TOKEN"
          ]
        }
      },
      "anyOf": [
        {
          "required": [
            "LOGZ_IO"
          ]
        }
      ]
    },
    "CAMERA": {
      "description": "Camera configuration.",
      "type": "object",
      "properties": {
        "DISK_SPACE_MONITOR": {
          "description": "Disk space monitor configuration.",
          "type": "object",
          "properties": {
            "THRESHOLD": {
              "description": "The amount of free space remaining (in megabytes) that prompts the camera to shutoff.",
              "type": "number"
            }
          },
          "required": [
            "THRESHOLD"
          ]
        },
        "MOTION": {
          "description": "Motion image capture configuration.",
          "type": "object",
          "properties": {
            "AUTHENTICATION": {
              "description": "Localhost http authentication for camera control.",
              "type": "object",
              "properties": {
                "USERNAME": {
                  "description": "The authentication username.",
                  "type": "string"
                },
                "PASSWORD": {
                  "description": "The authentication password.",
                  "type": "string"
                }
              },
              "required": [
                "USERNAME",
                "PASSWORD"
              ]
            },
            "CAMERAS": {
              "description": "Configuration for each hardware camera.",
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "DEVICE": {
                    "description": "The video device your camera is mounted as.",
                    "pattern": "^/dev/video[0-9]+$",
                    "type": "string"
                  },
                  "IMAGE": {
                    "description": "The image configuration settings for your camera.",
                    "type": "object",
                    "properties": {
                      "FRAME_RATE": {
                        "description": "Maximum number of frames to be captured per second. (0=disable)",
                        "maximum": 100,
                        "minimum": 2,
                        "type": "number"
                      },
                      "WIDTH": {
                        "description": "Image width (pixels). Valid range: Camera dependent.",
                        "type": "number"
                      },
                      "HEIGHT": {
                        "description": "Image height (pixels). Valid range: Camera dependent.",
                        "type": "number"
                      },
                      "AUTO_BRIGHTNESS": {
                        "description": "Let motion regulate the brightness of a video device.",
                        "$ref": "#/definitions/constantOnOff"
                      },
                      "BRIGHTNESS": {
                        "description": "Set the initial brightness of a video device.  This is the average value if AUTO_BRIGHTNESS is enabled.",
                        "maximum": 255,
                        "minimum": 0,
                        "type": "number"
                      },
                      "CONTRAST": {
                        "description": "Set the contrast of a video device.  0 is disabled.",
                        "maximum": 255,
                        "minimum": 0,
                        "type": "number"
                      },
                      "SATURATION": {
                        "description": "Set the saturation of a video device.  0 is disabled.",
                        "maximum": 255,
                        "minimum": 0,
                        "type": "number"
                      },
                      "HUE": {
                        "description": "Set the hue of a video device (NTSC feature). 0 is disabled.",
                        "maximum": 255,
                        "minimum": 0,
                        "type": "number"
                      }
                    },
                    "required": [
                      "FRAME_RATE",
                      "WIDTH",
                      "HEIGHT",
                      "AUTO_BRIGHTNESS",
                      "BRIGHTNESS",
                      "CONTRAST",
                      "SATURATION",
                      "HUE"
                    ]
                  }
                },
                "required": [
                  "DEVICE",
                  "IMAGE"
                ]
              }
            },
            "DETECTION": {
              "description": "General motion detection configuration.",
              "type": "object",
              "properties": {
                "THRESHOLD": {
                  "description": "Threshold for number of changed pixels in an image that triggers motion detection.",
                  "type": "number"
                },
                "EVENT_GAP": {
                  "description": "The seconds of no motion detection that triggers the end of an event.",
                  "type": "number"
                }
              },
              "required": [
                "THRESHOLD",
                "EVENT_GAP"
              ]
            },
            "MOVIES": {
              "description": "Recorded movie configuration.",
              "type": "object",
              "properties": {
                "LOCATE_MOTION_MODE": {
                  "description": "Locate and draw a box around the moving object.",
                  "$ref": "#/definitions/constantOnOff"
                }
              },
              "required": [
                "LOCATE_MOTION_MODE"
              ]
            },
            "SNAPSHOTS": {
              "description": "Snapshot image configuration.",
              "type": "object",
              "properties": {
                "QUALITY": {
                  "description": "The quality (in percent) to be used by the jpeg and webp compression.",
                  "maximum": 100,
                  "minimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "QUALITY"
              ]
            }
          },
          "required": [
            "AUTHENTICATION",
            "CAMERAS",
            "DETECTION",
            "MOVIES",
            "SNAPSHOTS"
          ]
        }
      },
      "anyOf": [
        {
          "required": [
            "DISK_SPACE_MONITOR",
            "MOTION"
          ]
        }
      ]
    },
    "SWITCHES": {
      "description": "Configured switches.",
      "type": "object",
      "properties": {
        "CONTACT_SWITCHES": {
          "description": "Configured contact switches.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "NAME": {
                "description": "The name of the switch as it will appear in notifications and logs (ie. Front Door).",
                "type": "string"
              },
              "GPIO": {
                "description": "The GPIO number this contact switch connects to.",
                "type": "number"
              }
            },
            "required": [
              "NAME",
              "GPIO"
            ]
          }
        }
      },
      "required": [
        "CONTACT_SWITCHES"
      ]
    },
    "TEMPERATURE_SENSORS": {
      "description": "Configured temperature sensors.",
      "type": "object",
      "properties": {
        "DHT11_SENSORS": {
          "description": "Configured DHT11 temperature sensors.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "NAME": {
                "type": "string",
                "description": "The name of the sensor as it will appear in notifications and logs (ie. Living Room)."
              },
              "GPIO": {
                "type": "number",
                "description": "The GPIO number this DHT11 sensor connects to."
              }
            },
            "required": [
              "NAME",
              "GPIO"
            ]
          }
        }
      },
      "required": [
        "DHT11"
      ]
    }
  },
  "required": [
    "ARCHIVAL",
    "CAMERA",
    "CHAT",
    "LOGS",
    "SWITCHES",
    "TEMPERATURE_SENSORS"
  ]
}