Make a functioning firmware

2021-12-15 01:10:25 -05:00
parent 7c6177cd40
commit 5f26731a3f
8 changed files with 230 additions and 107 deletions
--- a/window_control/firmware/Makefile
+++ b/window_control/firmware/Makefile
@@ -0,0 +1,116 @@
+# Kitsune Scientific
+
+# What project to build
+PROJ := firmware
+
+
+# What board to build for and its core
+CORE     ?= esp8266:esp8266
+FQBN     ?= esp8266:esp8266:generic
+
+# Tools, their links and versions
+ARDUINO_CLI_VERSION :=
+ARDUINO_CLI_URL := https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh
+ARDUINO_LINT_VERSION :=
+ARDUINO_LINT_URL := https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh
+
+# The version and time we're compiling from
+GIT_VERSION := "$(shell git describe --abbrev=4 --dirty --always --tags)"
+COMPILED_DATE := "$(shell date)"
+
+# Treat all warnings as errors.
+BUILDPROP := compiler.warning_flags.all='-Wall -Wextra -Werror'
+
+# Locations
+ROOT := $(PWD)
+BINDIR := $(ROOT)/_build/bin
+BUILDDIR := $(ROOT)/_build
+
+# What port to build on
+ifndef SERIAL_DEV
+  ifneq (,$(wildcard /dev/ttyUSB0))
+    SERIAL_DEV = /dev/ttyUSB0
+  else ifneq (,$(wildcard /dev/ttyACM0))
+    SERIAL_DEV = /dev/ttyACM0
+  else
+    SERIAL_DEV = unknown
+  endif
+endif
+
+
+.PHONY: all help build upload version release requirements
+
+# Do everything
+all: tools requirements version build
+
+
+help:
+	@echo
+	@echo "Targets:"
+	@echo "   lint       	De-lint the software."
+	@echo "   build      	Build the software."
+	@echo "   upload     	Upload the software."
+	@echo "   requirements	Fetch all requirements."
+	@echo
+
+
+# Set VERBOSE=1 to not run in --silent
+
+ifndef VERBOSE
+.SILENT:
+endif
+
+# Only build the code
+build: version $(PROJ).ino
+	$(BINDIR)/arduino-cli core install $(CORE)
+	$(BINDIR)/arduino-cli compile -b $(FQBN) $(PROJ)
+
+# Make binaries
+bin: tools requirements version $(PROJ).ino
+	$(BINDIR)/arduino-cli core install $(CORE)
+	$(BINDIR)/arduino-cli compile -b $(FQBN) $(PROJ) -e
+	
+	# Clean and rename (could be optimized)
+	mv build/* _build
+	rm -rv build
+
+# Only upload the software
+upload: version build $(PROJ).ino
+	$(BINDIR)/arduino-cli upload -b $(FQBN) $(PROJ) -p $(SERIAL_DEV)
+
+# Only update the version
+version:
+	echo "#define VERSION \"$(GIT_VERSION)\"" > version.h
+	echo "#define COMPILED_ON \"$(COMPILED_DATE)\"" >> version.h
+
+# Generate an artifact
+release: build $(PROJ).ino
+	$(BINDIR)/arduino-cli compile -b $(FQBN) $(PROJ) --output-dir $(BUILDDIR)
+
+# Only fetch the requirements
+requirements:
+	@if [ -e requirements.txt ]; \
+	then while read -r i ; do echo ; \
+		echo "---> Installing " '"'$$i'"' ; \
+		$(BINDIR)/arduino-cli lib install "$$i" ; \
+	done < requirements.txt ; \
+	else echo "---> MISSING requirements.txt file"; \
+	fi
+
+# Monitor the serial (debug) output.
+# Requires minicom
+monitor: upload
+	minicom -D $(SERIAL_DEV) -b 115200
+
+lint: tools
+	$(BINDIR)/arduino-lint --compliance strict
+
+# Fetches all the tools required
+tools:
+	mkdir -p $(BINDIR)
+	curl -fsSL $(ARDUINO_CLI_URL) | BINDIR=$(BINDIR) sh -s $(ARDUINO_CLI_VERSION)
+	curl -fsSL $(ARDUINO_LINT_URL) | BINDIR=$(BINDIR) sh -s $(ARDUINO_LINT_VERSION)
+
+# Messy, come back and fix?
+clean:
+	rm -rv _build/arduino.avr.mega