Improve docs and logging

firmware/main/XGZP.cpp

@@ -111,8 +111,8 @@ bool XGZP::read(float * reading) {
 			if (count == 3) { // got data
 				XGZPC_Value = Wire.read() * 65536.0 + Wire.read() * 256.0 + Wire.read();
 				XGZPC_Value = XGZPC_Value / 8.0;
-				Serial.print("Pa Value: ");
+				//Serial.print("Pa Value: ");
-				Serial.println(XGZPC_Value);
+				//Serial.println(XGZPC_Value);
 
 				XGZPC_Value = XGZPC_Value / 6895.0;
 

firmware/main/hardware.cpp

@@ -4,7 +4,7 @@
 #include "hardware.h"
 #include "XGZP.h"
 
-bool simulating = false;
+bool simulating = true;
 double simulatedPressure = 0.0;
 double inflatePSIPerSecond = 0.0;
 double deflatePSIPerSecond = 0.0;

firmware/main/hardware.h

@@ -7,8 +7,8 @@
 #define SOLENOID_INFLATE 1
 #define SOLENOID_DEFLATE 2
 
-#define RELAY1_PIN 7
+#define RELAY1_PIN 11
-#define RELAY2_PIN 11
+#define RELAY2_PIN 7
 
 #define PRESSURE_SENSOR_PIN A0
 

firmware/main/main.ino

@@ -1,11 +1,20 @@
+// Tire Inflation Firmware
+//
+// Board: Adafruit Feather nRF52832
+// Setup: https://learn.adafruit.com/bluefruit-nrf52-feather-learning-guide/arduino-bsp-setup
+
 #include <Wire.h>
 #include <Adafruit_GFX.h>
 #include <Adafruit_SSD1306.h>
-#include <Adafruit_FeatherOLED.h>
+#include <Adafruit_FeatherOLED.h>  // make sure to add:
+                                   // #define VBATPIN 0
+                                   // #define VBAT_MULTIPLIER 0
+                                   // to Adafruit_FeatherOLED.cpp
+                                   // or Adafruit_FeatherOLED_SH110X.cpp
 
 #include "hardware.h"
 
-//#define SIMULATE 1
+#define SIMULATE 1
 #define DEBUG 0
 
 #define TIMEOUT_TIME 7000
@@ -36,7 +45,7 @@ enum buttonStates {
 	NUM_BUTTONSTATES
 };
 
-enum screenStates {
+enum machineStates {
 	BOOT_UP,
 	PRESSURE,
 	SET_POINT,
@@ -71,7 +80,7 @@ enum buttonStates upButton = OPEN;
 enum buttonStates enterButton = OPEN;
 enum buttonStates downButton = OPEN;
 
-enum screenStates screenState = BOOT_UP;
+enum machineStates machineState = BOOT_UP;
 double pressureValue = 0.0;
 int pressureSetPoint = 0;
 double initialPressure = 0.0;
@@ -108,9 +117,9 @@ void setup()
 
 #ifdef SIMULATE
 	initSimulation();
-#endif
+#else
-
 	initHardware();
+#endif
 
 	resamplePressure(pressureValue);
 }
@@ -118,7 +127,7 @@ void setup()
 void loop() {
 	measurePressure(pressureValue);
 	pollButtons();
-	runUI();
+	runStateMachine();
 	logData();
 
 #ifdef SIMULATE
@@ -130,7 +139,9 @@ void logData() {
 	static unsigned long lastLogTime = millis();
 
 	if (millis() > lastLogTime + 100) {
-		Serial.print("pressure: ");
+		//Serial.print("millis: ");
+		//Serial.print(millis());
+		Serial.print(", pressure: ");
 		Serial.print(pressureValue);
 #ifdef SIMULATE
 		Serial.print(", simulated: ");
@@ -138,20 +149,20 @@ void logData() {
 #endif
 		Serial.print(", sampled: ");
 		Serial.print(sampledPressure);
-		Serial.print(", rate (inv): ");
+		//Serial.print(", rate (inv): ");
-		Serial.print(runningRateInv);
+		//Serial.print(runningRateInv);
 		Serial.print(", setpoint: ");
 		Serial.print(pressureSetPoint);
 		Serial.print(", state: ");
-		Serial.print(stateLabels[screenState]);
+		Serial.print(stateLabels[machineState]);
 		Serial.println("");
 
 		lastLogTime = millis();
 	}
 }
 
-void runUI() {
+void runStateMachine() {
-	static enum screenStates nextState = BOOT_UP;
+	static enum machineStates nextState = BOOT_UP;
 
 	static unsigned long timer = millis();
 
@@ -165,10 +176,10 @@ void runUI() {
 
 	oled.clearDisplay();
 
-	switch (screenState) {
+	switch (machineState) {
 		case BOOT_UP:
 			if (millis() >= timer + 2000) {
-				screenState = PRESSURE;
+				machineState = PRESSURE;
 			}
 
 			oled.setCursor(0,0);
@@ -184,25 +195,25 @@ void runUI() {
 
 		case PRESSURE:
 			if (enterButton == PRESSED) {
-				screenState = SAY_HOLD;
+				machineState = SAY_HOLD;
 				nextState = PRESSURE;
 				timer = millis();
 			} else if (enterButton == HELD) {
 				;  // settings?
 			} else if (upButton == PRESSED) {
-				screenState = SET_POINT;
+				machineState = SET_POINT;
 				pressureSetPoint = debouncedPressureValue+1;
 				timer = millis();
 			} else if (downButton == PRESSED) {
-				screenState = SET_POINT;
+				machineState = SET_POINT;
 				pressureSetPoint = debouncedPressureValue-1;
 				timer = millis();
 			} else if (upButton == HELD) {
-				screenState = SET_POINT;
+				machineState = SET_POINT;
 				pressureSetPoint = debouncedPressureValue+1;
 				timer = millis();
 			} else if (downButton == HELD) {
-				screenState = SET_POINT;
+				machineState = SET_POINT;
 				pressureSetPoint = debouncedPressureValue-1;
 				timer = millis();
 			}
@@ -217,12 +228,12 @@ void runUI() {
 
 		case SET_POINT:
 			if (enterButton == PRESSED) {
-				screenState = SAY_HOLD;
+				machineState = SAY_HOLD;
 				nextState = SET_POINT;
 				timer = millis();
 			} else if (enterButton == HELD) {
 				timer = millis();
-				screenState = INIT_RUN;
+				machineState = INIT_RUN;
 			} else if (upButton == PRESSED) {
 				timer = millis();
 				pressureSetPoint++;
@@ -238,7 +249,7 @@ void runUI() {
 				pressureSetPoint--;
 				delay(75);
 			} else if (millis() >= timer + TIMEOUT_TIME) {
-				screenState = SAY_TIMEOUT;
+				machineState = SAY_TIMEOUT;
 				nextState = PRESSURE;
 				timer = millis();
 			}
@@ -258,7 +269,7 @@ void runUI() {
 			initialPressure = pressureValue;
 			startTime = millis();
 			timer = millis();
-			screenState = BEGIN_RUN;
+			machineState = BEGIN_RUN;
 
 			oled.setCursor(0,0);
 			oled.setTextSize(1);
@@ -276,7 +287,7 @@ void runUI() {
 				isInflating = false;
 			} else {
 				setSoleniod(SOLENOID_STOP);
-				screenState = SAY_DONE;
+				machineState = SAY_DONE;
 				nextState = PRESSURE;
 			}
 
@@ -288,7 +299,7 @@ void runUI() {
 			if (millis() >= timer + 5000) {
 				//runningPressure = pressureValue;
 				setSoleniod(SOLENOID_STOP);
-				screenState = MEASURING;
+				machineState = MEASURING;
 				timer = millis();
 				stopTime = millis();
 			}
@@ -296,44 +307,45 @@ void runUI() {
 			break;
 
 		case MEASURING:
+			if (millis() < timer + 500) {
+				// wait for solenoids to settle before averaging
+				resamplePressure(pressureValue);
+
+			}
+
 			if (millis() >= timer + 3000) {
 				sampledPressure = pressureValue;
 
 				runningRateInv = (stopTime - startTime) / (sampledPressure - initialPressure);
 
-				Serial.print("stopTime: ");
+				//Serial.print("stopTime: ");
-				Serial.print(stopTime);
+				//Serial.print(stopTime);
-				Serial.print(", startTime: ");
+				//Serial.print(", startTime: ");
-				Serial.print(startTime);
+				//Serial.print(startTime);
-				Serial.print(", sampledPressure: ");
+				//Serial.print(", sampledPressure: ");
-				Serial.print(sampledPressure);
+				//Serial.print(sampledPressure);
-				Serial.print(", initialPressure: ");
+				//Serial.print(", initialPressure: ");
-				Serial.print(initialPressure);
+				//Serial.print(initialPressure);
-				Serial.print(", rate: ");
+				//Serial.print(", rate: ");
-				Serial.print(runningRateInv);
+				//Serial.print(runningRateInv);
-				Serial.println("");
+				//Serial.println("");
 
 				initialPressure = sampledPressure;
 
 				if (isInflating && (int) sampledPressure >= pressureSetPoint) {
-					screenState = SAY_DONE;
+					machineState = SAY_DONE;
 					nextState = PRESSURE;
 				} else if (isDeflating && (int) sampledPressure <= pressureSetPoint) {
-					screenState = SAY_DONE;
+					machineState = SAY_DONE;
 					nextState = PRESSURE;
 				} else {
-					screenState = RUNNING;
+					machineState = RUNNING;
 				}
 
 				timer = millis();
 				startTime = millis();
 			}
 
-			if (millis() < timer + 500) {
-				// wait for solenoids to settle before averaging
-				resamplePressure(pressureValue);
-			}
-
 			setSoleniod(SOLENOID_STOP);
 
 			oled.setCursor(0,0);
@@ -348,27 +360,27 @@ void runUI() {
 		case RUNNING:
 			if (enterButton == PRESSED) {
 				setSoleniod(SOLENOID_STOP);
-				screenState = SAY_CANCEL;
+				machineState = SAY_CANCEL;
 				nextState = PRESSURE;
 				timer = millis();
 			} else if (upButton == PRESSED) {
 				setSoleniod(SOLENOID_STOP);
-				screenState = SAY_CANCEL;
+				machineState = SAY_CANCEL;
 				nextState = PRESSURE;
 				timer = millis();
 			} else if (downButton == PRESSED) {
 				setSoleniod(SOLENOID_STOP);
-				screenState = SAY_CANCEL;
+				machineState = SAY_CANCEL;
 				nextState = PRESSURE;
 				timer = millis();
 			}
 
 			if (isInflating && millis() >= timer + 20000) {
-				screenState = MEASURING;
+				machineState = MEASURING;
 				timer = millis();
 				stopTime = millis();
 			} else if (isDeflating && millis() >= timer + 10000) {
-				screenState = MEASURING;
+				machineState = MEASURING;
 				timer = millis();
 				stopTime = millis();
 			}
@@ -403,7 +415,7 @@ void runUI() {
 
 		case SAY_DONE:
 			if (millis() >= timer + 3000) {
-				screenState = nextState;
+				machineState = nextState;
 				timer = millis();
 			}
 
@@ -417,7 +429,7 @@ void runUI() {
 
 		case SAY_CANCEL:
 			if (millis() >= timer + 1000) {
-				screenState = nextState;
+				machineState = nextState;
 				timer = millis();
 			}
 
@@ -431,7 +443,7 @@ void runUI() {
 
 		case SAY_HOLD:
 			if (millis() >= timer + 500) {
-				screenState = nextState;
+				machineState = nextState;
 				timer = millis();
 			}
 
@@ -445,7 +457,7 @@ void runUI() {
 
 		case SAY_TIMEOUT:
 			if (millis() >= timer + 1000) {
-				screenState = nextState;
+				machineState = nextState;
 				timer = millis();
 			}