env.example

# TRMNL Image Webhook Configuration

# REQUIRED: Your TRMNL webhook URL
# Get this from your TRMNL plugin settings page
WEBHOOK_URL=https://trmnl.com/api/plugin_settings/YOUR-UUID/image

# Path to your images directory
IMAGES_PATH=./images

# Device model - auto-configures display size, bit depth, and output mode
# Run: python generate_examples.py  to see all 41 supported models
# Examples: og_png, og_plus, og_bwry, v2, openframe, tidbyt, amazon_kindle_2024
DEVICE_MODEL=og_png

# Layout orientation: auto, landscape, portrait
# auto = Use EXIF orientation from photo (default)
# landscape = Force landscape (800x480)
# portrait = Force portrait (480x800)
LAYOUT=auto

# Orientation filter: any, landscape, portrait
# any = Show all images (default)
# landscape = Only show landscape/wide images
# portrait = Only show portrait/tall images
# Useful to skip images that don't fit your display orientation
ORIENTATION_FILTER=any

# Border style: white, black, blur
# white = Plain white borders (default, clean look)
# black = Black borders (classic framing)
# blur = Blurred/faded edges of the image as border
BORDER_STYLE=white

# Gamma correction to fix "dark" dithered images.
# 1.0 = Original. 1.5-1.8 = Brighter midtones (Recommended for e-ink).
GAMMA=1.5

# Output mode - auto-selected when DEVICE_MODEL is set
# grayscale = Dithered grayscale (default for most e-ink)
# color     = Full RGB (auto for 24-bit devices: openframe, tidbyt, raspberry_pi_touch_2)
# bwry      = 4-color palette: black/white/red/yellow (auto for og_bwry, waveshare_7_5_bwry)
#OUTPUT_MODE=grayscale

# Image fit mode: contain or fill
# contain = Fit entire image (default, may have borders)
# fill = Fill entire display (may crop image edges)
IMAGE_FIT=contain

# Margin size in pixels (0-100, default: 0)
# Adds a border around the image for a framed picture look
# Recommended: 20-40 for subtle frame, 60-80 for bold frame
# Works best in landscape mode
MARGIN=0

# Frame border style: none, line, rounded (only visible when MARGIN > 0)
FRAME_BORDER=none

# Frame border width in pixels (1-10, default: 2)
FRAME_BORDER_WIDTH=2

# Upload interval in minutes
INTERVAL_MINUTES=60

# Selection mode: random, sequential, shuffle, newest, oldest
SELECTION_MODE=random

# Include subfolders (recommended: true)
INCLUDE_SUBFOLDERS=true

# Apply Floyd-Steinberg dithering (recommended: true)
# Creates dot pattern for smooth gradients on 1-bit e-ink display
USE_DITHERING=true

# Image label: none, filename, path
# Shows text overlay on image
IMAGE_LABEL=none

# Dry run mode - don't upload, just save to data/
DRY_RUN=false