← Back to downloads
============================================================
ProjectUNION Core Library v0.3.4 Reusable Foundation for ESP32 Model
Railway Projects
============================================================

INTRODUCTION

During the development of many ESP32-based model railway projects, it
became clear that the same software was being written repeatedly.

Every project required WiFi configuration, multilingual web pages, OTA
firmware updates, mDNS hostnames, configuration storage and a consistent
user interface.

ProjectUNION was created to collect these common functions into reusable
libraries so new projects can focus only on their own unique
functionality.

PROJECTUNION PLATFORM

ProjectUNION currently consists of three libraries:

-   ProjectUNION Core
-   ProjectUNION MQTT
-   ProjectUNION DCC

These libraries may be used individually or combined depending on the
project requirements.

WHY PROJECTUNION?

Spend your time developing new ideas instead of rewriting the same
infrastructure.

MAIN FEATURES

-   Responsive web interface
-   Danish, English and German language support
-   WiFi configuration
-   Hostname configuration
-   mDNS (.local)
-   OTA firmware update
-   Configuration storage using Preferences
-   Status page
-   Firmware upload
-   Common HTML components
-   Consistent ProjectUNION user interface

SYSTEM REQUIREMENTS

-   Arduino IDE 2.x
-   ESP32 Arduino Core
-   ESP32 Dev Module
-   4 MB Flash recommended

ARDUINO IDE SETTINGS

Board: ESP32 Dev Module

Flash Size: 4 MB

CPU Frequency: 240 MHz

Flash Mode: QIO

Flash Frequency: 80 MHz

PSRAM: Disabled

Partition Scheme: Minimal SPIFFS (1.9 MB APP with OTA / 128 KB SPIFFS)

IMPORTANT: All ProjectUNION libraries and examples are developed using
this partition scheme.

INSTALLATION

1.  Close Arduino IDE.

2.  Copy the ProjectUNION folder into:

    Documents/Arduino/libraries

3.  Restart Arduino IDE.

4.  Open one of the included examples.

5.  Compile and upload.

INCLUDED EXAMPLE

Example_01_ProjectUNION_Starter

Demonstrates: - WiFi configuration - Language selection - OTA firmware
update - Status page - ProjectUNION web interface

WORKING WITH ADDITIONAL LIBRARIES

After learning ProjectUNION Core you can continue with:

-   ProjectUNION MQTT
-   ProjectUNION DCC

RECOMMENDED LEARNING ORDER

1.  ProjectUNION Core
2.  ProjectUNION MQTT
3.  ProjectUNION DCC
4.  Project Examples

VERSION HISTORY

Version 0.3.4

-   Language improvements
-   General fixes
-   Current production release

LICENSE

ProjectUNION is intended for hobby and educational use.

No warranty or support is provided.

Use the software entirely at your own risk.