Makefile

.PHONY: clean test

# use this so we can call make again robustly if needed
THIS_FILE := $(lastword $(MAKEFILE_LIST))

# use this so we can run NVM for tests
NVM = [[ -s $$HOME/.nvm/nvm.sh ]] && . $$HOME/.nvm/nvm.sh

FIRMWARE_DIR = ./firmware
BUILD_DIR = $(FIRMWARE_DIR)/build
BIN_DIR = $(FIRMWARE_DIR)/bin
SRC_DIR = $(FIRMWARE_DIR)/src
LIBS_DIR = $(SRC_DIR)/libs

help:
	@echo "Development actions:"
	@echo "--------------------"
	@echo "clean:            Cleans up everything"
	@echo "clean-node:       Cleans all of the node modules up"
	@echo "clean-build:      Cleans up all of the build folders"
	@echo "clean-compiled:   Cleans up all of the compiled files"
	@echo "install:          Installs all of the packages"
	@echo "lint:             Runs the linter"
	@echo "test:             Runs all of the tests"
	@echo "test [12,14]:     Runs the tests for a particular node target"
	@echo ""
	@echo "Build actions:"
	@echo "--------------"
	@echo "build:            Builds all of the codebase"
	@echo "compile:          Compiles all of the binaries"
	@echo "compile <tgt>:    Compiles the binaries for a particular target board eg uno, nano"
	@echo ""
	@echo "Release actions:"
	@echo "----------------"
	@echo "release-test:     Does a dry run version of the release"
	@echo "release:          Builds a version, create tags and update changelog"
	@echo "publish:          Pushes tags to github and publish to npm"
	@echo ""
	@echo "CI actions:"
	@echo "----------------"
	@echo "test-ci:          Runs the test suite against local node version for CI matrix builds"
	@echo ""

clean: clean-node clean-build clean-compiled
	@echo "Run npm install to get started"

clean-node:
	# remove node files
	rm -rf node_modules/

clean-build-backpack:
	@# remove the firmware build items
	rm -rf $(BUILD_DIR)/backpack

clean-build-firmata:
	@# remove the firmware build items
	rm -rf $(BUILD_DIR)/node_pixel_firmata

clean-build: clean-build-backpack clean-build-firmata
	@# remove the compiled bins
	rm -rf $(BIN_DIR)/firmata/*
	rm -rf $(BIN_DIR)/backpack/*

clean-compiled:
	@# removes all of the compilation intermediate files
	for f in $(BIN_DIR)/*/*/*; \
	do \
    	if [[ $${f} != *.ino.hex ]]; \
		then \
			rm -rf $${f}; \
        fi; \
	done

	@# remove the intermediate build files from the build directory too
	rm -rf $(BUILD_DIR)/backpack/build
	rm -rf $(BUILD_DIR)/node_pixel_firmata/build

install: clean
	@echo "Installing all of the packages needed"
	npm install

lint:
	npm run lint

# What node versions do we want to have support for
NODE_TARGETS = 12 14

$(NODE_TARGETS):
	@echo "Testing Node $@"
	@$(NVM) && nvm use $@ && npm run test

test: $(NODE_TARGETS)

test-ci:
	npm run test

# make the Firmata build process to copy the files to the right place
FIRMATA_DEST_DIR = $(BUILD_DIR)/node_pixel_firmata
FIRMATA_DIR = $(LIBS_DIR)/firmata/arduino

build-firmata: clean-build-firmata
	@echo "Creating firmata build files"
	mkdir $(FIRMATA_DEST_DIR)
	cp $(FIRMATA_DIR)/*.h $(FIRMATA_DEST_DIR)/
	cp $(FIRMATA_DIR)/*.cpp $(FIRMATA_DEST_DIR)/
	cp $(LIBS_DIR)/ws2812/* $(FIRMATA_DEST_DIR)/
	cp $(LIBS_DIR)/lightws2812/* $(FIRMATA_DEST_DIR)/
	cp $(SRC_DIR)/controller_src/firmata/* $(FIRMATA_DEST_DIR)/
	@echo "Firmata build files ready"


# Make the backpack build process to copy the files to the right place
BACKPACK_DEST_DIR = $(BUILD_DIR)/backpack

build-backpack: clean-build-backpack
	@echo "Creating backpack build files"
	mkdir $(BACKPACK_DEST_DIR)
	cp $(LIBS_DIR)/ws2812/* $(BACKPACK_DEST_DIR)/
	cp $(LIBS_DIR)/lightws2812/* $(BACKPACK_DEST_DIR)/
	cp $(SRC_DIR)/controller_src/backpack/* $(BACKPACK_DEST_DIR)/
	@echo "Backpack build files ready"

build: build-backpack build-firmata
	@echo "run make compile to compile"


# Set out all of the targets and info to build the bins from
BOARD_TGTS = uno nano pro-mini mega diecimila leonardo micro
PKG_uno = "arduino:avr:uno"
PKG_nano = "arduino:avr:nano:cpu=atmega328"
PKG_pro-mini = "arduino:avr:pro:cpu=16MHzatmega328"
PKG_mega = "arduino:avr:mega:cpu=atmega2560"
PKG_diecimila = "arduino:avr:diecimila:cpu=atmega328"
PKG_leonardo = "arduino:avr:leonardo"
PKG_micro = "arduino:avr:micro"

FIRMATA_INO = $(FIRMATA_DEST_DIR)/node_pixel_firmata.ino
BACKPACK_INO = $(BACKPACK_DEST_DIR)/backpack.ino

compile: build-backpack build-firmata $(BOARD_TGTS)
	@# clean up all of the garbage files
	@$(MAKE) -f $(THIS_FILE) clean-compiled

$(BOARD_TGTS):
	@# make the firmata bin for this target board
	arduino-cli compile --verbose -b $(PKG_$@) \
		--build-path=$$PWD/$(BIN_DIR)/firmata/$@ $(FIRMATA_INO)

	@# make the firmata bin for this target board
	arduino-cli compile --verbose -b $(PKG_$@) \
		--build-path=$$PWD/$(BIN_DIR)/backpack/$@ $(BACKPACK_INO)


test-release:
	npm run release -- --dry-run

release:
	npm run release

publish:
	git push --follow-tags origin master && npm publish