Support for different boards (ESP32 and Lilygo) (#41)

* Initial commit

* Making code compile

* Adding board logic

* Updating docs

Author: BorisBrock

.github/workflows/build.yml

@@ -34,4 +34,4 @@ jobs:
         run: pip install --upgrade platformio
 
       - name: Build HeidelBridge
-        run: pio run -e heidelberg
+        run: pio run -e esp32

README.md

@@ -24,15 +24,15 @@ HeidelBridge is a firmware for ESP32 microcontrollers. It allows you to bring yo
 You only need two components for this project: an ESP32 microcontroller and a MAX485 module. Both are available in large quantities and at reasonable prices on the Internet. You will also need a breadboard and a few jumper wires. All in all, it shouldn't cost you more than 10€.
 
 Parts list:
-- ESP32 microcontroller*
+- ESP32 microcontroller board*
 - MAX485 breakout board
 - 6 jumper wires
 - A breadboard
 
 This should be enough for quickly putting together a fully functioning prototype.
 Of course a well designed PCB would be much nicer, but this is still work in progress. Once the design is ready, the schematics will be available *right here*.
 
-> *\* This project is currently based on the classic ESP32. It has not been built/tested for newer models, like the S2 and C6.*
+> *\* This project supports the classic ESP32. It has not been built/tested for newer models, like the S2 and C6. Additionally the LILYGO T-CAN485 board is supported, which already includes an on-board RS485 transceiver.*
 
 # Getting Started
 

docs/SoftwareSetup.md

@@ -56,3 +56,50 @@ Then follow these steps:
 - Now connect your ESP32 via USB.
 - Upload the file system image.
 - Upload the firmware.
+
+
+## Build Environments
+
+HeidelBridge supports multiple build environments to accommodate different hardware configurations:
+
+### Standard ESP32 + External RS485 Module (`esp32`)
+This is the default build environment for regular ESP32 development boards with an external RS485 module.
+
+**To compile:**
+```bash
+pio run -e esp32
+```
+
+**Pin configuration:**
+- GPIO18 → RS485 RO (Receiver Output)
+- GPIO19 → RS485 DI (Driver Input)  
+- GPIO21 → RS485 DE+RE
+
+### LilyGo T-Can485 Board (`lilygo`)
+This build environment is specifically designed for the LilyGo T-Can485 board, which has built-in RS485 capabilities and **does not require an external MAX485 module**.
+
+**To compile:**
+```bash
+pio run -e lilygo
+```
+
+**Pin configuration:**
+- GPIO21 → RS485 RO (Receiver Output)
+- GPIO22 → RS485 DI (Driver Input)
+- GPIO21 → RS485 DE+RE
+
+**Additional features:**
+- Automatic initialization of onboard RS485 transceivers
+- 5V power supply control
+- CAN bus support (hardware available but not used in current firmware)
+- **No external MAX485 module needed** - RS485 transceiver is built into the board
+
+For detailed wiring information and hardware setup for the LilyGo T-Can485 board, please refer to the [discussion thread](https://github.com/BorisBrock/HeidelBridge/discussions/4).
+
+### Dummy Wallbox (`dummy`)
+This build environment creates a simulation mode for testing without actual wallbox hardware.
+
+**To compile:**
+```bash
+pio run -e dummy
+```

platformio.ini

@@ -9,12 +9,10 @@
 ; https://docs.platformio.org/page/projectconf.html
 
 [platformio]
-default_envs = heidelberg
+default_envs = esp32
 
+# Common settings
 [env]
-platform = espressif32@^6.8.1
-board = esp32doit-devkit-v1
-upload_protocol = esptool
 upload_port = /dev/ttyUSB*
 framework = arduino
 board_build.partitions = partitions.csv
@@ -31,13 +29,34 @@ lib_deps =
   esphome/ESPAsyncWebServer-esphome @^3.3.0
   bblanchon/ArduinoJson @ ^7.4.1
 
-[env:heidelberg]
+# Build a dummy HeidelBridge with no real wallbox hardware attached.
+# This is for testing and simulation only.
+[env:dummy]
+platform = espressif32@^6.8.1
+board = esp32doit-devkit-v1
+upload_protocol = esptool
+build_flags = 
+  -O2
+  -D DUMMY_WALLBOX
+  -D BOARD_ESP32
+  -D LOGGING_LEVEL_DEBUG
+
+# Default environment for regular ESP32 boards.
+[env:esp32]
+platform = espressif32@^6.8.1
+board = esp32doit-devkit-v1
+upload_protocol = esptool
 build_flags = 
   -O2
+  -D BOARD_ESP32
   -D LOGGING_LEVEL_ERROR
 
-[env:dummy]
+# LILYGO T-CAN485, ESP32 board with on-board RS485
+[env:lilygo]
+platform = espressif32@^6.8.1
+board = esp32dev
+upload_protocol = esptool
 build_flags = 
   -O2
-  -D DUMMY_WALLBOX
-  -D LOGGING_LEVEL_DEBUG
+  -D BOARD_LILYGO
+  -D LOGGING_LEVEL_ERROR

src/Boards/Board.cpp

@@ -0,0 +1,26 @@
+#include <Arduino.h>
+#include "Board.h"
+
+// Constructor
+Board::Board(uint8_t pinRx, uint8_t pinTx, uint8_t pinRts)
+    : mPinRx(pinRx), mPinTx(pinTx), mPinRts(pinRts)
+{
+}
+
+// These functions return the pins used by this board
+uint8_t Board::GetPinRx()
+{
+  return mPinRx;
+}
+
+// These functions return the pins used by this board
+uint8_t Board::GetPinTx()
+{
+  return mPinTx;
+}
+
+// These functions return the pins used by this board
+uint8_t Board::GetPinRts()
+{
+  return mPinRts;
+}

src/Boards/Board.h

@@ -0,0 +1,23 @@
+#pragma once
+
+class Board
+{
+protected:
+  // Constructor
+  Board(uint8_t pinRx, uint8_t pinTx, uint8_t pinRts);
+
+public:
+  // Initializes the board
+  virtual void Init() = 0;
+
+  // Logs board name/information
+  virtual void Print() = 0;
+
+  // These functions return the pins used by this board
+  uint8_t GetPinRx();
+  uint8_t GetPinTx();
+  uint8_t GetPinRts();
+
+private:
+  uint8_t mPinRx, mPinTx, mPinRts;
+};

src/Boards/BoardFactory.cpp

@@ -0,0 +1,26 @@
+#include <Arduino.h>
+#include "Board.h"
+#include "BoardFactory.h"
+
+// All supported boards
+#include "ESP32/BoardESP32.h"
+#include "Lilygo/BoardLilygo.h"
+
+// Factory instance
+BoardFactory *BoardFactory::Instance()
+{
+  static BoardFactory factoryInstance;
+  return &factoryInstance;
+}
+
+// Gets the currently used board
+Board *BoardFactory::GetBoard()
+{
+#ifdef BOARD_ESP32
+  static BoardESP32 boardInstance;
+#elif BOARD_LILYGO
+  static BoardLilygo boardInstance;
+#endif
+
+  return &boardInstance;
+}

src/Boards/BoardFactory.h

@@ -0,0 +1,17 @@
+#pragma once
+
+// Forward declarations
+class Board;
+
+class BoardFactory
+{
+private:
+  BoardFactory() {};
+
+public:
+  // Factory instance
+  static BoardFactory *Instance();
+
+  // Gets the currently used board
+  static Board *GetBoard();
+};

src/Boards/ESP32/BoardESP32.cpp

@@ -0,0 +1,31 @@
+#include <Arduino.h>
+#include "Components/Logger/Logger.h"
+#include "../Board.h"
+#include "BoardESP32.h"
+
+// Pin connections:
+// ESP32 GPIO18 -> MAXRS485 RO (Receiver Output)
+// ESP32 GPIO19 -> MAXRS485 DI (Driver Input)
+// ESP32 GPIO21 -> MAXRS485 DE+RE
+constexpr uint8_t PinRX = GPIO_NUM_18;
+constexpr uint8_t PinTX = GPIO_NUM_19;
+constexpr uint8_t PinRTS = GPIO_NUM_21;
+
+// Constructor
+BoardESP32::BoardESP32()
+    : Board(PinRX, PinTX, PinRTS)
+{
+  // Nothing to do
+}
+
+// Initializes the board
+void BoardESP32::Init()
+{
+  // Nothing to do
+}
+
+// Logs board name/information
+void BoardESP32::Print()
+{
+  Logger::Print("ESP32");
+}

src/Boards/ESP32/BoardESP32.h

@@ -0,0 +1,14 @@
+#pragma once
+
+class BoardESP32 : public Board
+{
+public:
+  // Constructor
+  BoardESP32();
+
+  // Initializes the board
+  virtual void Init();
+
+  // Logs board name/information
+  virtual void Print();
+};