Add priming and time not-yet-set checks.

Author: MHotchin

README.md

@@ -9,7 +9,7 @@ You can monitor and change most 'day-to-day' settings.  Notably absent right now
 
  ## Examples
 
-Cross platform networking is a bit of a mess for Arduino, so there are three different exaples that differ by how the network is declared and initialized.
+Cross platform networking is a bit of a mess for Arduino, so there are three different examples that differ by how the network is declared and initialized.
  - Mega_2560:  Assumes a Wiznet style shield or add-on board, controlled over SPI
  - Wemos D1 R1: ESP8266 based board in an Uno form factor.
  - Wemos D1 R32: ESP32 based board in an Uno form factor.

examples/Mega_2560/Mega_2560.ino

@@ -1,7 +1,7 @@
 
 
 #ifndef  ARDUINO_ARCH_AVR
-#error Wrong architecture, this code is for ESP8266 based boards.
+#error Wrong architecture, this code is for AVR (Uno / Mega 2560) based boards.
 #endif
 
 

library.properties

@@ -1,5 +1,5 @@
 name=Balboa Spa communications
-version=1.0.1
+version=1.0.2
 author=M Hotchin <github@hotchin.net>
 maintainer=M Hotchin <github@hotchin.net>
 sentence=Use Arduino to control your BalBoa Spa Pack.

src/BalBoaMessages.h

@@ -134,7 +134,11 @@ namespace BalBoa
 		byte : 0;                   //
 		byte _light : 2;            // 14
 		byte : 0;                   //
-		byte _r7[5];                // 15
+		byte _r7[3];                // 15->17
+		byte _r7a : 1;              // both 18 & 19, bit 2 seem related to time not
+		byte _timeUnset : 1;        // yet set.
+		byte : 0;
+		byte _r7b;                  // 19
 		byte _setTemp;              // 20
 		byte _r8 : 2;               // 21
 		byte _systemHold : 1;

src/BalBoaSpa.cpp

@@ -24,6 +24,8 @@ namespace
 {
 	EthernetClass &Networking = Ethernet;
 	typedef EthernetUDP SpaUdp;
+
+
 }
 #endif
 
@@ -464,6 +466,12 @@ BalBoa::BalBoaSpa::GetRunningFilter() const
 }
 
 
+BalBoa::TriState
+BalBoa::BalBoaSpa::IsTimeUnset() const
+{
+	return _timeUnset;
+}
+
 BalBoa::TriState
 BalBoa::BalBoaSpa::IsHeating() const
 {
@@ -504,6 +512,15 @@ BalBoa::BalBoaSpa::GetPanelMessages() const
 }
 
 
+BalBoa::TriState
+BalBoa::BalBoaSpa::IsPriming() const
+{
+	_changes &= ~scPriming;
+
+	return _priming;
+}
+
+
 void
 BalBoa::BalBoaSpa::SetTime(
 	const BalBoa::SpaTime &time)
@@ -582,32 +599,44 @@ void
 BalBoa::BalBoaSpa::CrackStatusMessage(const byte *_messageBuffer)
 {
 	const StatusMessage *pMessage = reinterpret_cast<const StatusMessage *>(_messageBuffer);
+	
+	
+	// Only mark this off if something changed.
+	// _waitingForMessages &= ~wfmStatus;
+
+	unsigned int newChanges = 0;
 
 	if (pMessage->_hour != _time.hour)
 	{
 		_time.hour = pMessage->_hour;
-		_changes |= scTime;
+		newChanges |= scTime;
 	}
 
 	if (pMessage->_minute != _time.minute)
 	{
 		_time.minute = pMessage->_minute;
-		_changes |= scTime;
+		newChanges |= scTime;
 	}
 
 	if (pMessage->_24hrTime != _time.displayAs24Hr)
 	{
 		_time.displayAs24Hr = pMessage->_24hrTime;
-		_changes |= scTime;
-		_changes |= scFilterTimes;  //  Because time format has changed.
+		newChanges |= scTime;
+		newChanges |= scFilterTimes;  //  Because time format has changed.
+	}
+
+	if (pMessage->_timeUnset != _timeUnset)
+	{
+		_timeUnset = static_cast<TriState>(pMessage->_timeUnset);
+		newChanges |= scTime;
 	}
 
 	if (pMessage->_currentTemp != _currentTemp.temp)
 	{
 		_currentTemp.temp = pMessage->_currentTemp;
 		_currentTemp.isCelsiusX2 = pMessage->_tempScaleCelsius;
 
-		_changes |= scTemp;
+		newChanges |= scTemp;
 	}
 
 
@@ -616,68 +645,78 @@ BalBoa::BalBoaSpa::CrackStatusMessage(const byte *_messageBuffer)
 		_setPoint.temp = pMessage->_setTemp;
 		_setPoint.isCelsiusX2 = pMessage->_tempScaleCelsius;
 
-		_changes |= scSetPoint;
+		newChanges |= scSetPoint;
 	}
 
 
 	if (static_cast<TriState>(pMessage->_tempRange) != _rangeHigh)
 	{
 		_rangeHigh = static_cast<TriState>(pMessage->_tempRange);
-		_changes |= scSetPoint;
+		newChanges |= scSetPoint;
 	}
 
 	if (static_cast<TriState>(pMessage->_tempScaleCelsius) != _tempCelsius)
 	{
 		_tempCelsius = static_cast<TriState>(pMessage->_tempScaleCelsius);
-		_changes |= (scTemp | scSetPoint);
+		newChanges |= (scTemp | scSetPoint);
 	}
 
 	if (pMessage->_pump1 != _pump1Speed)
 	{
 		_pump1Speed = static_cast<BalBoa::PumpSpeed>(pMessage->_pump1);
 
-		_changes |= scPump1;
+		newChanges |= scPump1;
 	}
 
 	if (pMessage->_pump2 != _pump2Speed)
 	{
 		_pump2Speed = static_cast<BalBoa::PumpSpeed>(pMessage->_pump2);
 
-		_changes |= scPump2;
+		newChanges |= scPump2;
 	}
 
 	if (static_cast<TriState>(pMessage->_light != 0) != _lights)
 	{
 		_lights = static_cast<TriState>(pMessage->_light != 0);
-		_changes |= scLights;
+		newChanges |= scLights;
 	}
 
 	if (static_cast<TriState>(pMessage->_heating != 0) != _heating)
 	{
 		_heating = static_cast<TriState>(pMessage->_heating != 0);
-		_changes |= scHeating;
+		newChanges |= scHeating;
 	}
 
-	if (static_cast<TriState>(pMessage->_filter1Running) != _filter1Running)
+	if (static_cast<TriState>(pMessage->_filter1Running != 0) != _filter1Running)
 	{
-		_filter1Running = static_cast<TriState>(pMessage->_filter1Running);
-		_changes |= scFilterRunning;
+		_filter1Running = static_cast<TriState>(pMessage->_filter1Running != 0);
+		newChanges |= scFilterRunning;
 	}
 
-	if (static_cast<TriState>(pMessage->_filter2Running) != _filter2Running)
+	if (static_cast<TriState>(pMessage->_filter2Running != 0) != _filter2Running)
 	{
-		_filter2Running = static_cast<TriState>(pMessage->_filter2Running);
-		_changes |= scFilterRunning;
+		_filter2Running = static_cast<TriState>(pMessage->_filter2Running != 0);
+		newChanges |= scFilterRunning;
 	}
 
 	if (pMessage->_panelMessage != _messages)
 	{
 		_messages = pMessage->_panelMessage;
-		_changes |= scPanelMessages;
+		newChanges |= scPanelMessages;
 	}
 
-	_waitingForMessages &= ~wfmStatus;
+	if (static_cast<TriState>(pMessage->_priming != 0) != _priming)
+	{
+		_priming = static_cast<TriState>(pMessage->_priming != 0);
+		newChanges |= scPriming;
+	}
 
+	if (newChanges)
+	{
+		_waitingForMessages &= ~wfmStatus;
+
+		_changes |= newChanges;
+	}
 
 	//  Look to see how the 'unknown' areas change, maybe we can figure some more stuff
 	//  out.  
@@ -694,6 +733,7 @@ BalBoa::BalBoaSpa::CrackStatusMessage(const byte *_messageBuffer)
 	pMess->_panelMessage     &= 0b11110001;
 	pMess->_24hrTime         = 0;
 	pMess->_tempRange        = 0;
+	pMess->_timeUnset        = 0;
 	pMess->_heating          = 0;
 	pMess->_pump1            = 0;
 	pMess->_pump2            = 0;
@@ -834,6 +874,7 @@ BalBoa::BalBoaSpa::ResetInfo()
 	_pump1Speed     = psUNKNOWN;
 	_pump2Speed     = psUNKNOWN;
 	_recirc         = psUNKNOWN;
+	_timeUnset      = tsUnknown;
 	_lights         = tsUnknown;
 	_heating        = tsUnknown;
 	_filter1Running = tsUnknown;

src/BalBoaSpa.h

@@ -38,7 +38,8 @@ namespace BalBoa
 		scVersion = 1 << 9,        //  Balboa software version
 		scFilterRunning = 1 << 10, //  What filter cycle is currently running
 		scPanelMessages = 1 << 11, //  Message displayed on panel
-		scMASK = (1 << 12) - 1
+		scPriming = 1 << 12,       //  Hot-tub is priming (power-on start-up)
+		scMASK = (1 << 13) - 1
 	};
 
 
@@ -148,12 +149,13 @@ namespace BalBoa
 		PumpSpeed GetPump2Speed() const;         // scPump2
 		const FilterInfo &GetFilterInfo() const; // scFilterTimes
 		RunningFilter GetRunningFilter() const;  // scFilterRunning
+		TriState IsTimeUnset() const;
 		TriState IsHeating() const;              // scHeating
 		TriState IsLightOn() const;              // scLights
 		TriState IsHighRange() const;            // scSetPoint
 		const VersionInfo &GetVersion() const;   // scVersion
 		uint8_t GetPanelMessages() const;        // scPanelMessages
-
+		TriState IsPriming() const;              // scPriming
 		void SendFilterConfigRequest();
 
 		//  Calling any of these will likely cause change notifications to come back.  So,
@@ -222,13 +224,15 @@ namespace BalBoa
 		PumpSpeed          _pump1Speed;
 		PumpSpeed          _pump2Speed;
 		PumpSpeed          _recirc;
+		TriState           _timeUnset;
 		TriState           _lights;
 		TriState           _heating;
 		mutable FilterInfo _filters;
 		TriState           _filter1Running;
 		TriState           _filter2Running;
 		VersionInfo        _version;
 		uint8_t            _messages;
+		TriState           _priming;
 	};
 #endif
 }