Files
AvianVisitors/frame/config.example.toml
T

61 lines
2.7 KiB
TOML

# AvianVisitors e-ink frame. install.sh writes this for you; edit to taste.
# config.toml is gitignored. Nothing here is secret unless your whole site is
# behind basic-auth (see the bottom). This file is the full reference.
# --- Where the collage comes from -------------------------------------------
# Default: mirror the BirdNET-Pi on your network. This Pi screenshots it.
base_url = "http://birdnet.local"
shoot = true
# Or fetch a ready-made PNG instead of rendering here (lighter, but needs
# something that serves a frame image, e.g. a public Cloudflare Worker):
# shoot = false
# image_url = "https://bird.onethreenine.net/frame.png?k=YOUR_FRAME_KEY"
# Or read a PNG a sibling process drops next to us:
# image = "~/.birdframe/frame.png"
# Or render from BirdWeather for any ZIP, no mic (what install.sh --bird-weather
# writes). The panel still refreshes only when the local top birds change:
# species_source = "birdweather"
# zip = "94107"
# bw_days = 7 # BirdWeather lookback window, in days
# bw_country = "us" # geocoder country for the ZIP
# shoot = true # this Pi renders the collage
hours = 24 # window shown on the frame
# --- Titles and look (used when this Pi renders, i.e. shoot = true) ----------
shoot_title = "Avian Visitors"
shoot_subtitle = "Heard Today"
# shoot_headline_px = 42
# shoot_eyebrow_px = 18
# shoot_lowercase = false
# shoot_mat = 0.04
# shoot_small_floor = 0.04
# shoot_count_exp = 0.65 # tile size vs call count; higher = the loudest birds dominate more
# --- Panel ------------------------------------------------------------------
rotate = 90 # 90 or 270 if the frame hangs the other way up
saturation = 0.6 # Inky colour saturation, 0 to 1
mat = 0.0 # extra shrink of the content inside the A5 opening (0 = none)
# panel = "el133uf1" # force the 13.3" driver if auto-detect ever fails
# --- Refresh cadence --------------------------------------------------------
# The panel refreshes only when the species set or a count bracket changes,
# plus a daily heal. Quiet hours are off so nocturnal detections still show;
# set quiet_start/quiet_end to a window to mute overnight.
quiet_start = 0 # 0/0 = always refresh on change; e.g. 22 and 6 mutes 22:00-06:00
quiet_end = 0
heal_hours = 24 # force a refresh at least this often
# --- Paths ------------------------------------------------------------------
state = "~/.birdframe/state.json"
cache = "~/.birdframe"
timeout = 45
# --- Only if your WHOLE site is behind basic-auth ---------------------------
# The AvianVisitors default leaves the collage and detection API public, so
# usually leave these out.
# basic_user = "monalisa"
# basic_pass = "..."