paperpi.example.toml

# PaperPi example config, made by "paperpi example-config". Save it as your config file
# (PaperPi reads /etc/paperpi/paperpi.toml unless you give --config) and change it there.
#
# The file only needs the settings that differ from the default. Every other setting is
# shown as a comment with its default: remove the # in front of it to change it.
# Each [[plugin]] block is one plugin on the screen; the same plugin type can be used
# more than once, with a different id. The weather blocks are not shown until you remove
# the # in front of "email" and fill in your own, real email address: met.no asks every
# program for a way to contact its user. Settings marked "(required)" must be filled in
# before a plugin is shown.

config_version = 1

[display]
# The kind of screen: "virtual" (writes PNG files) or "it8951" (Waveshare's IT8951 board)
type = "virtual"
# Turn the picture, in degrees. One of: 0, 90, 180, 270
# rotation = 0
# false: draw in gray, even on a color screen
# color = true
# Show a small clock when no plugin has anything to show (strongly recommended: without it, an empty
# screen looks like a broken one)
# fallback_clock = true
# At start, show PaperPi's version and web address this many seconds before the plugins (0: not at
# all). With no plugin ready to show, it is shown until one is
# splash_time = 60
# Virtual screen only: width in pixels
# width = 1200
# Virtual screen only: height in pixels
# height = 825
# Virtual screen only: what it can show. One of: "bw", "gray4", "gray16", "7color", "rgb"
# mode = "gray16"
# Real screens (required for it8951): the screen model. For it8951 its size in inches: "6", "7.8",
# "9.7" or "10.3"
# model = "9.7"
# it8951 only, and required: the voltage printed on the screen's ribbon cable, e.g. -1.9 (between
# -3.0 and -0.5). Each screen has its own; a wrong value gives poor contrast
# vcom = -1.9
# After this many fast refreshes in a row, the next one is a full refresh, which removes most
# leftovers of earlier images (0 = never force one)
# max_refresh = 4
# Seconds between cleaning refreshes, which flash the screen white to remove all leftovers of
# earlier images; also at the first write after a start (0 = never; else at least 600)
# clean_every = 3600
# When PaperPi is stopped on purpose (Ctrl+C, systemctl stop, shutdown): make the screen blank, or
# keep the last picture. After a crash the picture stays. One of: "clear", "keep"
# on_exit = "clear"

[web]
# false: no web interface
# enabled = true
# The network address the web interface listens on: "0.0.0.0" for every device on the home network,
# "127.0.0.1" for this Pi only
# address = "0.0.0.0"
# The web interface's port
# port = 8080
# false: no password; anyone on the home network can change the settings
# login = true
# The web interface saves the web password here as password_hash. For a new password: run sudo
# paperpi reset-password, restart or reload PaperPi, and open the web interface

# basic_clock: The time, and optionally the date, in large text.
# Layouts (values for "layout"): time, time_date, small
[[plugin]]
# Required. Unique ID of this plugin: up to 40 letters, digits, _ and - (when checking that it is
# unique, capitals don't count and - is the same as _). It names the plugin's storage folder, so
# changing it starts with an empty folder
id = "clock"
# Name shown in the web interface; leave it out to show the ID
name = "Clock"
type = "basic_clock"
# 12-hour (3:45 PM) or 24-hour (15:45) clock
# hours = 24
# --- Settings every plugin has ---
# Show this plugin
# enabled = true
# When it is shown: alert, interrupt or rotation
# level = "rotation"
# Seconds on screen per turn, when several plugins take turns
# display_time = 120
# Seconds between updates (at least 5). Leave it out to use the plugin's suggestion (shown below)
# refresh = 60
# Seconds one update may take before it is stopped
# time_limit = 60
# Which layout (see "Layouts" above). Leave it out to use the first
# layout = "time"
# Alert plugins only: seconds before a dismissed alert comes back, if the plugin still reports it
# alert_reminder = 3600
# Alert plugins only: seconds after which an alert is dismissed by itself, in case the plugin is
# stuck
# alert_max_time = 86400
# Most megabytes this plugin may keep in its storage folder; over it, the files changed longest ago
# are removed first. Leave it out to use the plugin's suggestion (shown below)
# storage_mb = 500
# Files the plugin has not changed for this many days are removed (0 = keep them). Leave it out to
# use the plugin's suggestion (shown below)
# storage_days = 30

# met_no: The weather for the next 12 hours from met.no: temperature, rain and wind.
# Layouts (values for "layout"): hours_12, small, steps_3h, now, portrait_hours, portrait_now
[[plugin]]
id = "weather_berlin"
name = "Weather Berlin"
type = "met_no"
# Latitude of the place, e.g. 52.52 (required)
lat = 52.52
# Longitude of the place, e.g. 13.40 (required)
lon = 13.4
# Name shown on the screen, e.g. Berlin (else lat, lon)
place = "Berlin"
# Height of the ground at the place, in whole metres, e.g. 34. Makes the temperatures more exact in
# hills and mountains (else met.no guesses it from its own map)
# altitude =
# Your own, real email address, sent only to met.no (their terms of service ask for one) (required)
# email = ""
# Degrees Celsius or Fahrenheit. One of: "C", "F"
# temperature = "C"
# Rain in millimetres or inches. One of: "mm", "inch"
# rain = "mm"
# --- Settings every plugin has (all of them are in the first block) ---
# Seconds between updates (at least 5). Leave it out to use the plugin's suggestion (shown below)
# refresh = 1800
# Which layout (see "Layouts" above). Leave it out to use the first
# layout = "hours_12"

# met_no: The weather for the next 12 hours from met.no: temperature, rain and wind.
# Layouts (values for "layout"): hours_12, small, steps_3h, now, portrait_hours, portrait_now
[[plugin]]
id = "weather_rio"
name = "Weather Rio"
type = "met_no"
# Latitude of the place, e.g. 52.52 (required)
lat = -22.91
# Longitude of the place, e.g. 13.40 (required)
lon = -43.17
# Name shown on the screen, e.g. Berlin (else lat, lon)
place = "Rio"
# Height of the ground at the place, in whole metres, e.g. 34. Makes the temperatures more exact in
# hills and mountains (else met.no guesses it from its own map)
# altitude =
# Your own, real email address, sent only to met.no (their terms of service ask for one) (required)
# email = ""
# Degrees Celsius or Fahrenheit. One of: "C", "F"
# temperature = "C"
# Rain in millimetres or inches. One of: "mm", "inch"
# rain = "mm"
# --- Settings every plugin has (all of them are in the first block) ---
# Seconds between updates (at least 5). Leave it out to use the plugin's suggestion (shown below)
# refresh = 1800
# Which layout (see "Layouts" above). Leave it out to use the first
# layout = "hours_12"