Configuration JSON Schema

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