WIP: branch working on adding support for an external display.

Makefile

@@ -0,0 +1,127 @@
+# -*- make -*-
+
+PROJ = $(notdir $(PWD))
+SOURCES = $(wildcard *.ino *.cpp *.h)
+FSDIR = data
+FILES = $(wildcard $(FSDIR)/*)
+
+# Don't use -DATOMIC_FS_UPDATE
+CFLAGS_DEFAULT = -DNO_GLOBAL_HTTPUPDATE
+CFLAGS = $(CFLAGS_DEFAULT)
+
+CLI := arduino-cli
+PLATFORM := esp8266:esp8266
+CFGFILE := arduino-cli.yaml
+ESP8266URL := https://github.com/esp8266/Arduino/releases/download/2.7.4/package_esp8266com_index.json
+LIBRARIES := libraries/WiFiManager libraries/ArduinoJson libraries/pubsubclient libraries/TelnetStream libraries/Acetime libraries/Time libraries/OneWire libraries/DallasTemperature libraries/U8g2
+BOARDS := arduino/package_esp8266com_index.json
+# PORT can be overridden by the environment or on the command line. E.g.:
+# export PORT=/dev/ttyUSB2; make upload, or: make upload PORT=/dev/ttyUSB2
+PORT ?= /dev/ttyUSB0
+BAUD ?= 460800
+
+INO = $(PROJ).ino
+MKFS = $(wildcard arduino/packages/esp8266/tools/mklittlefs/*/mklittlefs)
+TOOLS = $(wildcard arduino/packages/esp8266/hardware/esp8266/*/tools)
+ESPTOOL = python3 $(TOOLS)/esptool/esptool.py
+BOARD = $(PLATFORM):d1_mini
+FQBN = $(BOARD):eesz=4M1M
+IMAGE = build/$(subst :,.,$(BOARD))/$(INO).bin
+FILESYS = filesys.bin
+
+export PYTHONPATH = $(TOOLS)/pyserial
+
+binaries: $(IMAGE)
+
+publish: $(PROJ)-fs.bin $(PROJ)-fw.bin
+
+platform: $(BOARDS)
+
+clean:
+	find $(FSDIR) -name '*~' -exec rm {} +
+
+$(CFGFILE):
+	$(CLI) config init --dest-file $(CFGFILE)
+	$(CLI) config set board_manager.additional_urls $(ESP8266URL)
+	$(CLI) config set directories.data $(PWD)/arduino
+	$(CLI) config set directories.downloads $(PWD)/staging
+	$(CLI) config set directories.user $(PWD)
+	$(CLI) config set sketch.always_export_binaries true
+	$(CLI) config set library.enable_unsafe_install true
+
+$(BOARDS): | $(CFGFILE)
+	$(CLI) core update-index
+	$(CLI) core install $(PLATFORM)
+
+refresh: | $(CFGFILE)
+	$(CLI) lib update-index
+
+flush: | $(CFGFILE)
+	$(CLI) cache clean
+
+libraries/WiFiManager: | $(BOARDS)
+	$(CLI) lib install [email protected]
+
+libraries/ArduinoJson:
+	$(CLI) lib install [email protected]
+
+libraries/pubsubclient:
+	$(CLI) lib install [email protected]
+
+libraries/TelnetStream:
+	$(CLI) lib install [email protected]
+
+libraries/Acetime:
+	$(CLI) lib install [email protected]
+
+libraries/U8g2:
+	$(CLI) lib install [email protected] 
+
+libraries/Time:
+	$(CLI) lib install --git-url https://github.com/PaulStoffregen/Time
+	# https://github.com/PaulStoffregen/Time/archive/refs/tags/v1.6.1.zip
+
+libraries/OneWire:
+	$(CLI) lib install [email protected]
+
+libraries/DallasTemperature:
+	$(CLI) lib install [email protected]
+
+$(IMAGE): $(BOARDS) $(LIBRARIES) $(SOURCES)
+	$(CLI) compile --config-file $(CFGFILE) --fqbn=$(FQBN) --warnings default --verbose --build-property compiler.cpp.extra_flags="$(CFLAGS)"
+
+$(FILESYS): $(FILES) $(CONF) | $(BOARDS) clean
+	$(MKFS) -p 256 -b 8192 -s 1024000 -c $(FSDIR) $@
+
+$(PROJ)-fs.bin: $(FILES) $(CONF) | $(BOARDS) clean
+	$(MKFS) -p 256 -b 8192 -s 1024000 -c $(FSDIR) $@
+
+$(PROJ)-fw.bin: $(IMAGE)
+	cp $(IMAGE) $@
+
+$(PROJ).zip: $(PROJ)-fw.bin $(PROJ)-fs.bin
+	rm -f $@
+	zip $@ $^
+
+# Build the image with debugging output
+debug: CFLAGS = $(CFLAGS_DEFAULT) -DDEBUG
+debug: $(IMAGE)
+
+# Load only the sketch into the device
+upload: $(IMAGE)
+	$(ESPTOOL) --port $(PORT) -b $(BAUD) write_flash 0x0 $(IMAGE)
+
+# Load only the file system into the device
+upload-fs: $(FILESYS)
+	$(ESPTOOL) --port $(PORT) -b $(BAUD) write_flash 0x300000 $(FILESYS)
+
+# Load both the sketch and the file system into the device
+install: $(IMAGE) $(FILESYS)
+	$(ESPTOOL) --port $(PORT) -b $(BAUD) write_flash 0x0 $(IMAGE) 0x300000 $(FILESYS)
+
+.PHONY: binaries platform publish clean upload upload-fs install debug
+
+### Allow customization through a local Makefile: Makefile-local.mk
+
+# Include the local make file, if it exists
+-include Makefile-local.mk

OTGW-Display.h

@@ -0,0 +1,70 @@
+#ifndef OTGW_DISPLAY
+#define OTGW_DISPLAY
+#include <Arduino.h>
+#include <U8g2lib.h>
+
+/**
+ * A small module that can use a small external display
+ * to provide some useful feedback to the user.
+ * For example:
+ * * Current IP address.
+ * * Current OTGW Version.
+ * * Uptime
+ * * Boiler status
+ * * etc.
+ *
+ * To use this class, instantiate it. Call the begin function
+ * after the iic is setup. Then periodically call tick() to draw a new page.
+ */
+class OTGW_Display
+{
+
+  public:
+     // The different pages we can display.
+    enum class Pages {
+      DISPLAY_IP,
+      DISPLAY_TIME,
+      DISPLAY_UPTIME,
+      DISPLAY_VERSION,
+      DISPLAY_MESSAGE
+    };
+    // Constructor
+    OTGW_Display ();
+    // Destructor
+    ~OTGW_Display ();
+
+    // Start
+    void begin();
+
+    // Function to periodically call to update itself.
+    void tick ();
+
+    // Put a message over top.
+    // This will also force an update.
+    void message ( const String &str = "" );
+
+  private:
+    // The welcome screen.
+    void draw_welcome();
+
+    // Pages::DISPLAY_IP
+    void draw_display_page_ip();
+    // Pages::DISPLAY_TIME
+    void draw_display_page_time();
+    // Pages::DISPLAY_UPTIME
+    void draw_display_page_uptime();
+    // Pages::DISPLAY_VERSION
+    void draw_display_page_version();
+    // Pages::DISPLAY_MESSAGE
+    void draw_display_page_message();
+
+  private:
+    // U8g2 Object used for interaction with Oled.
+    U8G2 *u8g2 = nullptr;
+    // A message that can be set from the code.
+    String _message = "";
+    // Current page.
+    Pages page = Pages::DISPLAY_IP;
+};
+
+#endif // OTGW_DISPLAY