MyStation

ESP32-powered e-paper display showing real-time public transport departures and weather information

✨ Features

• 🚌 Real-time departures from German public transport (RMV API)
• 🌤️ Weather information from German Weather Service (DWD)
• 📱 Mobile-friendly web configuration - no app installation needed
• 🔋 Ultra-low power with deep sleep (months of battery life)
• 📡 WiFi connectivity with automatic location detection
• 🔒 Privacy-focused - all processing happens locally on device
• 🎨 E-paper display - outdoor-readable, low power consumption
• 🔘 Physical buttons - quickly switch display modes
• 🔄 OTA updates - update firmware over WiFi

🎯 Supported Hardware

• ESP32-C3 Super Mini - Compact, cost-effective
• ESP32-S3 - Enhanced performance, battery monitoring
• 7.5" E-Paper Display (800x480) - GDEY075T7 or compatible

🚀 Quick Start

1. Hardware Assembly

Wire your ESP32 to the e-paper display. See detailed pin connections:

• Hardware Assembly Guide - Wiring diagrams for ESP32-C3 and ESP32-S3

2. Firmware Setup

# Clone repository
git clone https://github.com/yourusername/mystation.git
cd mystation

# Build and upload with PlatformIO
pio run --target upload
pio run --target uploadfs

3. Device Configuration

1. Power on your device
2. Connect to MyStation-XXXXXXXX WiFi network
3. Open browser and configure:
   • Your home WiFi network (2.4 GHz only)
   • Preferred transport station
   • Display preferences

📖 Complete Quick Start Guide

📚 Documentation

For Users

• 📖 User Guide - Setup, usage, and troubleshooting
• 🚀 Quick Start - Get running in 15 minutes
• 🔘 Button Controls - Using physical buttons
• 📱 Understanding Display - Display modes explained
• 🔧 Troubleshooting - Common issues and solutions

For Developers

• 💻 Developer Guide - Architecture and development
• 🔧 Hardware Assembly - Pin connections and wiring
• ⚙️ Development Setup - Build environment
• 🧪 Testing - Testing procedures
• 📋 Run Book - Operational procedures
• 🔑 API Integration - Setting up API keys
• 🎨 Display System - Display architecture
• 🔄 Boot Process - Device boot flow

Reference

• 📚 Configuration Keys - All configuration options

🏗️ Architecture

MyStation is designed for simplicity and efficiency:

• ESP32 Controller - Manages WiFi, deep sleep, and data fetching
• E-Paper Display - Low-power outdoor-readable screen
• Web Interface - Easy configuration via WiFi
• APIs - Google Geolocation, RMV Transport, DWD Weather
• Deep Sleep - Battery-optimized operation

Data Flow

flowchart LR
    ESP32[ESP32 Device] -->|Location| Google[Google API]
    ESP32 -->|Departures| RMV[RMV API]
    ESP32 -->|Weather| DWD[DWD API]
    ESP32 -->|Display| EPD[E-Paper]
    User((User)) -->|WiFi Config| ESP32

Loading

📖 Detailed Architecture

🎨 Display Modes

MyStation supports three display modes:

• Half & Half - Weather + Departures side-by-side (landscape)
• Weather Only - Full screen weather information
• Departures Only - Full screen departure board

Switch modes using physical buttons or web interface.

📖 Display System Documentation

🔋 Power & Battery

• Deep Sleep: <50μA between updates
• Active Mode: ~100mA during data fetch
• Battery Life: 2-4 months with 2500mAh battery (5-minute updates)
• Smart Scheduling: Reduced updates during night hours

📖 Boot Process & Power Management

🌍 Coverage

• Transport: Hesse, Germany (RMV network)
  • Frankfurt, Wiesbaden, Kassel, Darmstadt, etc.
  • Trains, buses, trams, S-Bahn
• Weather: Germany and surrounding areas (DWD)
• Extensible: Adapt for other regions/APIs

🛠️ Development

Prerequisites

• PlatformIO IDE (VS Code recommended)
• ESP32-C3 or ESP32-S3 development board
• API keys (Google, RMV)

Project Structure

├── docs/                   # Documentation
├── include/               # Header files
│   ├── api/              # API interfaces
│   ├── config/           # Configuration
│   └── util/             # Utilities
├── src/                  # Source code
│   ├── api/             # API implementations
│   ├── config/          # Configuration management
│   ├── display/         # Display rendering
│   └── main.cpp         # Main application
├── test/                # Unit tests
└── platformio.ini       # Build configuration

Contributing

1. Fork the repository
2. Create feature branch
3. Test thoroughly
4. Submit pull request

📖 Development Guide

📄 License

This project is licensed under the GNU Lesser General Public License v3.0 (LGPL-3.0).

What this means:

• ✅ You can use this software for personal or commercial purposes
• ✅ You can modify the code to fit your needs
• ✅ You can distribute the software and modifications
• ⚠️ If you modify this code, you must release your modifications under LGPL-3.0
• ⚠️ If you distribute, you must include the source code or provide access to it
• ✅ You can link this library with proprietary software without making your entire application LGPL

Key Points:

• Modifications to this code must remain open source (LGPL-3.0)
• Applications using this library can remain proprietary
• Commercial use is permitted
• Patent grant and protection included

See LICENSE for the full license text.

Third-Party Licenses

This project uses the following open-source libraries:

• GxEPD2 - GPL-3.0 (E-paper display driver)
• ArduinoJson - MIT
• WiFiManager - MIT
• ESPAsyncWebServer - LGPL-3.0
• U8g2 - BSD

---

🚀 Ready to build your own departure board? Start with the Quick Start Guide →