KID-FAX/.env.example at main · patricktrack/KID-FAX · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# ================================
# Kid Fax Telegram Bot Configuration
# ================================

# Telegram Bot Settings (Required)
# Get this from @BotFather on Telegram after creating your bot
TELEGRAM_BOT_TOKEN=123456789:ABCdefGHIjklMNOpqrsTUVwxyz1234567890

# Telegram Security & Contacts
# ALLOWLIST: Comma-separated Telegram chat IDs (kid safety - only these can send messages)
# Run `python -m kidfax.discover_chats` to find chat IDs
ALLOWLIST=123456789,987654321

# CONTACTS: Friendly name mapping (name:chat_id pairs)
# Run `python -m kidfax.discover_chats` to generate this
CONTACTS=grandma:123456789,uncle:987654321

# Telegram Polling Configuration
TELEGRAM_POLL_TIMEOUT=30  # Long polling timeout in seconds (recommended: 30)

# Photo Support
TELEGRAM_DOWNLOAD_PHOTOS=true  # Auto-download and print photos from Telegram
TELEGRAM_MAX_PHOTO_SIZE=5      # Max photo download size in MB

# ================================
# Printer Configuration
# ================================

# Printer Type: usb, serial, network, bluetooth, dummy
PRINTER_TYPE=usb

# USB Printer Settings (if PRINTER_TYPE=usb)
# Run 'lsusb' on your Raspberry Pi to find these values
# Format: 0x0416 (vendor), 0x5011 (product)
USB_VENDOR=0x0416
USB_PRODUCT=0x5011

# Serial Printer Settings (if PRINTER_TYPE=serial)
SERIAL_PORT=/dev/ttyUSB0
SERIAL_BAUD=19200

# Network Printer Settings (if PRINTER_TYPE=network)
NETWORK_HOST=192.168.1.100
NETWORK_PORT=9100

# ================================
# Kid Fax Display Settings
# ================================

KIDFAX_HEADER=Kid Fax
KIDFAX_SUBTITLE=Messages from family
KIDFAX_STATE_FILE=/home/pi/.kidfax_state.json
KIDFAX_STATE_LIMIT=5000

# ================================
# Printer Hardware Settings
# ================================

PRINTER_LINE_WIDTH=32
PRINTER_ENCODING=cp437
ALLOW_DUMMY_PRINTER=false

# ================================
# Optional E-ink Status Display
# ================================

EINK_STATUS_ENABLED=false
EINK_DRIVER_PACKAGE=e-Paper.RaspberryPi_JetsonNano.python.lib.waveshare_epd
EINK_DRIVER_MODULE=epd2in9d

# ================================
# Interactive Keyboard Mode
# ================================
# Run with: python -m kidfax.interactive_keyboard
# Requires Raspberry Pi 400 or keyboard with F1-F12 function keys

# Message character limit (Telegram allows up to 4096 characters)
# SMS_CHAR_LIMIT=160  # Legacy SMS limit (no longer applicable for Telegram)

# Print confirmation receipts after sending (requires printer)
PRINT_SEND_RECEIPTS=false

# Note: CONTACTS mapping above determines F-key assignments
# F1 = first contact, F2 = second contact, etc. (max 12 contacts)
# Example: If CONTACTS=grandma:123456789,uncle:987654321
# Then F1 = grandma, F2 = uncle

# ================================
# Admin Web Interface
# ================================
# Run with: python -m kidfax.admin_web
# Access at: http://localhost:5000/admin

# Password for accessing admin UI (required for security)
ADMIN_PASSWORD=your_secure_password_here

# Optional: Change host/port if needed
# ADMIN_HOST=127.0.0.1  # Default: localhost only (recommended)
# ADMIN_PORT=5000       # Default: 5000

# ================================
# Avatar Configuration
# ================================

# Enable avatar printing on message receipts
AVATAR_ENABLED=true

# Avatar storage directory (absolute path)
# Default: /home/pi/.kidfax_avatars
# AVATAR_DIR=/home/pi/.kidfax_avatars

# Avatar size in pixels (64, 96, or 128)
# Larger = more detail but slower print and more paper
AVATAR_SIZE=96

# Max avatar file size in MB
AVATAR_MAX_FILE_SIZE=5