Configuration JSON Schema

Pi Portal v1.5 Config File Schema

type

object

properties

  • AWS_ACCESS_KEY_ID

The AWS access key credential with write access to the bucket.

type

string

  • AWS_SECRET_ACCESS_KEY

The AWS access secret key credential with write access to the bucket.

type

string

  • LOGZ_IO_CODE

A code generated by log.io, which will be injected into streamed logs to identify your account.

type

string

  • S3_BUCKET_NAME

The name of the AWS S3 bucket to upload captured videos to.

type

string

  • 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

  • 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

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