Simplify Arduino EEPROM read / write

README.md

@@ -11,6 +11,7 @@
   - [TCP/UDP Settings](#tcpudp-settings)
   - [P1P2 Settings](#p1p2-settings)
   - [Packet Filter](#packet-filter)
+  - [Tools](#tools)
 * [Integration](#integration)
   - [Loxone](#loxone)
   - [Other systems](#other-systems)
@@ -66,7 +67,9 @@ Here is my HW setup (cheap Arduino Uno clone + W5500 Ethernet shield from Keyest
 
 You can either:
 - **Download and flash my pre-compiled firmware** from "Releases".
-- **Compile your own firmware**. Download this repository (all *.ino files) and open arduino-altherma-controller.ino in Arduino IDE. Download all required libraries (they are available in "library manager"). If you want, you can check the default factory settings (can be later changed via web interface) and advanced settings (can only be changed in the sketch). Compile and upload your program to Arduino.
+- **Compile your own firmware**. Download this repository (all *.ino files) and open arduino-altherma-controller.ino in Arduino IDE. If you want, you can check advanced_settings.h for advanced settings (can only be changed in the sketch) and for default factory settings (can be later changed via web interface). Download all required libraries, compile and upload your program to Arduino. The program uses the following external libraries (all are available in Arduino IDE's "library manager"):
+ - CircularBuffer (https://github.com/rlogiacco/CircularBuffer)
+ - StreamLib (https://github.com/jandrassy/StreamLib)
 
 Connect your Arduino to ethernet and use your web browser to access the web interface on default IP:  http://192.168.1.254
 
@@ -81,12 +84,10 @@ This controller has a built-in webserver which allows you to configure the contr
 
 <img src="pics/daikin1.png" alt="daikin1" style="zoom:100%;" />
 
-**Load Default Settings**. Loads default settings (see DEFAULT_CONFIG in advanced settings). MAC address is retained.
-
-**Reboot**.
-
 **EEPROM Health**. Keeps track of EEPROM write cycles (this counter is persistent, never cleared during factory resets). Replace your Arduino once you reach 100 000 write cycles (with 6 hours EEPROM_INTERVAL you have more than 50 years lifespan).
 
+**Ethernet Chip**. Wiznet chip on the ethernet shield.
+
 **MAC Address**. First 3 bytes are fixed 90:A2:DA, remaining 3 bytes are random. You can also set manual MAC in IP Settings.
 
 ## P1P2 Status
@@ -100,7 +101,7 @@ This controller has a built-in webserver which allows you to configure the contr
 * **Connected**. The controller is connected to the P1/P2 bus (to the main Daikin controller). Once connected, the controller can also:
   - show Altherma model in **Daikin Unit**
   - periodically request, read (and send via UDP) Altherma counters
-  - control Altherma by sending **Write Packet** through the web interface
+  - control Altherma by sending **Write Command** through the web interface
   - control Altherma by sending commands via UDP
 * **Not Supported by the Pump**. The controller failed to connect to the P1/P2 bus (to the main Daikin controller) because it is not supported by the heat pump. The controller will not reconnect even if it is in the Auto Connect mode (see P1P2 Settings) but the user can still try to (re)connect manually. The **Not Supported by the Pump** status occurs when:
   - The heat pump (the main Daikin controller) does not support external controllers.
@@ -111,25 +112,26 @@ This controller has a built-in webserver which allows you to configure the contr
 
 **Date**. Shows internal date and time of the heat pump.
 
-**Daikin EEPROM Writes**. Every time you send **Write Packet** through the web interface or a commands via UDP, settings of the main Daikin controller (= controller on your heat pump) change and new values are written to its internal EEPROM. **<ins>Your main Daikin controller's EEPROM has a limited number of writes, so keep an eye on this counter in order to prevent EEPROM wear! It is adviced to do max 7000 writes per year (19 writes/day on average)</ins>**.
-* **Total**. Total number of writes made by this Arduino controller since its first connection to the heat pump.
-* **Average per Day**. Average number of write cycles, should be bellow 19. Calculated from internal date of the heat pump, so if you change the date in heat pump settings, it is recommended to reset the Daikin EEPROM Writes counter.
+**Daikin EEPROM Writes**. Every time you send **Write Command** through the web interface or a command via UDP, settings of the main Daikin controller (= controller on your heat pump) change and new values are written to its internal EEPROM. **<ins>Your main Daikin controller's EEPROM has a limited number of writes, so keep an eye on this counter in order to prevent EEPROM wear! It is adviced to do max 7000 writes per year (19 writes/day on average)</ins>**.
+* **Stats since ...**. Date and time since when **Daikin EEPROM Writes** are recorded. If you significantly change the date on the heat pump, reset the stats (so that **Average per Day** is calculated properly).
+* **Total Commands**. Total number of writes made by this Arduino controller since the date and time recorded in **Stats since ...**.
+* **Average per Day**. Daily average EEPROM writes, should be bellow 19. Calculated from internal date of the heat pump, so if you change the date in heat pump settings, it is recommended to reset the Daikin EEPROM Writes counter.
 * **Yesterday**. Number of writes made yesterday, updated at midnight. Should not significantly exceed average writes per day.
+* **Today**. Number of writes made today / out of daily **EEPROM Write Quota**. If you reach the quota and you really need more, you can temporarily (!) increase it in the **P1P2 Settings**
 
-**Write Packet**. Send a P1/P2 write command directly from web interface. For testing or reverse-engineering P1/P2 write commands. The format of the write command send via web interface is identical to the command sent via UDP:
-* **Type**. The first byte is the packet type. Only supported packet types are listed in the drop-down select menu.
+**Write Command**. You can send a P1/P2 write command directly from web interface, for testing or reverse-engineering P1/P2 write commands. The format of the write command send via web interface is identical to the command sent via UDP:
+* **Packet Type**. The first byte is the packet type. Only supported packet types are listed in the drop-down menu.
 * **Param**. Parameter number, two bytes **<ins>in little endian format</ins>**! For example, parameter number 03 is inserted as `03` `00`.
 * **Value**. Parameter value, the number of bytes differs for various packet types. See PACKET_PARAM_VAL_SIZE in advanced settings for the correct number of bytes. Value is also **<ins>in little endian format</ins>**!
 
 **P1P2 Packets**. Counters for packets read from the P1/P2 bus or written to the P1/P2 bus, counters for various read and write errors. If any of the counters rolls over the unsigned long maximum (4,294,967,295), all counters will reset to 0.
 * **Bus Read OK**. Number of packets read from the P1/P2 bus, without errors. Not all of them are sent via UDP (see the **Packet Filter** settings). Packets are read from the P1/P2 bus (and sent via UDP) even if the controller is not connected to the P1/P2 bus.
 * **Bus Write OK**. Number of packets written to the P1/P2 bus. Includes both packets written automatically by the controller (requests for the counters packets), write commands from the web interface and write commands received via UDP. Writing to the P1/P2 bus is only possible if the controller is connected to the P1/P2 bus (to the main Daikin controller).
 * **EEPROM Write Quota Reached**. Daily EEPROM Write Quota (configured in **P1P2 Settings**) was reached. The command (received via UDP or from the web interface) was dropped.
-* **Write Queue Full**. Internal queue (circular buffer) for commands is full. The command (received via UDP or from the web interface) was dropped.
+* **Write Command Queue Full**. Internal queue (circular buffer) for commands is full. The command (received via UDP or from the web interface) was dropped.
 * **Write Command Invalid**. Command received via UDP or from the web interface was invalid, it was dropped. Possible reasons:
   - Packet type (first byte) is not supported (PACKET_PARAM_VAL_SIZE in advanced settings is set to zero).
   - Incorrect packet length. Command should have 1 byte for type, 2 bytes for parameter number and the correct numer of bytes for the parameter value (see PACKET_PARAM_VAL_SIZE in advanced settings).
-
 * **Parity Read Error**.
 * **Too Long Read Error**. Packet received is longer than the read buffer.
 * **Start Bit Write Error**. Start bit error during write.
@@ -180,11 +182,13 @@ This controller has a built-in webserver which allows you to configure the contr
 * **Manual Connect** (default). Same as disabled, but manual connection to the P1/P2 bus is possible (see the P1P2 Status page). The controller does not reconnect to the P1/P2 bus after reboot or if the connection is interrupted (see **Connection Timeout**).
 * **Auto Connect** (advanced). The controller tries to (re)connect to the P1/P2 bus (to the main Daikin controller) after (re)start, or if the connection is interrupted (see **Connection Timeout**). No attempts to reconnect are made if the controller is **Not Supported by the Pump** (see the P1P2 Status page). Enable **Auto Connect** at your own risk and only after you have successfuly connected manually! **Check the P1P2 Status page for P1/P2 errors and monitor Daikin EEPROM Writes in order to minimize Daikin controller EEPROM wear!**
 
+**EEPROM Write Quota**. Daily quota for writes to the EEPROM of the main Daikin controller. Every command sent via web interface (**Write Command** on **P1P2 Status** page) or via UDP = write cycle to the Daikin EEPROM. If the daily quota is reached, the command is dropped.
+
 **Connection Timeout**.
 * In **Manual Connect** mode, an attempt to connect to the P1/P2 bus (to the main Daikin controller) fails if connection is not established within the **Connection Timeout**. After timeout, the controller will show **Disconnected** state on the Status Page. Also, the controller disconnects from the P1/P2 bus if regular communication with the heat pump (with the main Daikin controller) is interrupted for a period longer than the **Connection Timeout**.
 * In **Auto Connect** mode, the controller will transition to **Connecting...** state if regular communication with the heat pump (with the main Daikin controller) is interrupted for a period longer than the **Connection Timeout**.
 
-**Target Temp. Hysteresis**. Hysteresis for writing target temperature or target setpoint commands (packet type 0x36). Applies for write commands received via UDP. The purpose is to minimize Daikin controller EEPROM wear.
+**Target Temperature Hysteresis**. Hysteresis for writing target temperature or target setpoint commands (packet type 0x36). Applies for write commands received via UDP. The purpose is to minimize Daikin controller EEPROM wear.
 
 ## Packet Filter
 
@@ -194,11 +198,21 @@ The **Packet Filter** page lists all packet types observed on the P1/P2 bus. Som
 
 **Send All Packet Types**. All packets read from the P1/P2 bus are sent via UDP (including packet types which were not yet observed). There is a lot of communication going on on the P1/P2 bus, so use with caution!
 
-**Counter Packet**. Counter packet is periodically requested by the controller (only works if the controller is connected to the P1/P2 bus). Set the period for the counter packet requests.
+**Counters Packet**. Counter packet is periodically requested by the controller (only works if the controller is connected to the P1/P2 bus). Set the period for the counter packet requests.
 
 **Data Packets**.
 * **Always Send (~770ms cycle)**. Data packets are always sent via UDP, whenever they are read from the P1/P2 bus. Data packets are regularly exchanged between the heat pump and the main Daikin controller every 770ms.
-* **Send If Payload Changed**. The controller stores data packet payloads in its RAM. Data packets are sent via UDP only if their payload changes.
+* **If Payload Changed or When Counters Requested**. The controller stores data packet payloads in its RAM. Data packets are sent via UDP:
+  - if their payload changed
+  - or when the counters packet is requested (see the counters packet request period)
+* **Only If Payload Changed**. Data packets are sent via UDP only if their payload changed.
+
+## Tools
+<img src="pics/daikin7.png" alt="daikin7" style="zoom:100%;" />
+
+**Load Default Settings**. Loads default settings (see DEFAULT_CONFIG in advanced settings). MAC address is retained.
+
+**Reboot**.
 
 # Integration
 

arduino-altherma-controller/01-interfaces.ino

@@ -49,19 +49,19 @@ void startEthernet() {
     delay(ETH_RESET_DELAY);
   }
 #ifdef ENABLE_DHCP
-  if (localConfig.enableDhcp) {
-    dhcpSuccess = Ethernet.begin(mac);
+  if (data.config.enableDhcp) {
+    dhcpSuccess = Ethernet.begin(data.mac);
   }
-  if (!localConfig.enableDhcp || dhcpSuccess == false) {
-    Ethernet.begin(mac, localConfig.ip, localConfig.dns, localConfig.gateway, localConfig.subnet);
+  if (!data.config.enableDhcp || dhcpSuccess == false) {
+    Ethernet.begin(data.mac, data.config.ip, data.config.dns, data.config.gateway, data.config.subnet);
   }
 #else  /* ENABLE_DHCP */
-  Ethernet.begin(mac, localConfig.ip, {}, localConfig.gateway, localConfig.subnet);  // No DNS
+  Ethernet.begin(data.mac, data.config.ip, {}, data.config.gateway, data.config.subnet);  // No DNS
 #endif /* ENABLE_DHCP */
   W5100.setRetransmissionTime(TCP_RETRANSMISSION_TIMEOUT);
   W5100.setRetransmissionCount(TCP_RETRANSMISSION_COUNT);
-  webServer = EthernetServer(localConfig.webPort);
-  Udp.begin(localConfig.udpPort);
+  webServer = EthernetServer(data.config.webPort);
+  Udp.begin(data.config.udpPort);
   webServer.begin();
 #if MAX_SOCK_NUM > 4
   if (W5100.getChip() == 51) maxSockNum = 4;  // W5100 chip never supports more than 4 sockets
@@ -72,7 +72,7 @@ void (*resetFunc)(void) = 0;  //declare reset function at address 0
 
 #ifdef ENABLE_DHCP
 void maintainDhcp() {
-  if (localConfig.enableDhcp && dhcpSuccess == true) {  // only call maintain if initial DHCP request by startEthernet was successfull
+  if (data.config.enableDhcp && dhcpSuccess == true) {  // only call maintain if initial DHCP request by startEthernet was successfull
     byte maintainResult = Ethernet.maintain();
     if (maintainResult == 1 || maintainResult == 3) {  // renew failed or rebind failed
       dhcpSuccess = false;
@@ -102,13 +102,13 @@ const uint32_t ROLLOVER = 0xFFFFFF00;
 bool rollover() {
   // synchronize roll-over of run time, data counters and modbus stats to zero, at 0xFFFFFF00
   for (byte i = 0; i < P1P2_LAST; i++) {
-    if (p1p2Count[i] > ROLLOVER) {
+    if (data.p1p2Cnt[i] > ROLLOVER) {
       return true;
     }
   }
 #ifdef ENABLE_EXTRA_DIAG
   for (byte i = 0; i < UDP_LAST; i++) {
-    if (udpCount[i] > ROLLOVER) {
+    if (data.udpCnt[i] > ROLLOVER) {
       return true;
     }
   }
@@ -119,52 +119,37 @@ bool rollover() {
   return false;
 }
 
+// resets counters to 0: data.p1p2Cnt, data.udpCnt
 void resetStats() {
-  memset(p1p2Count, 0, sizeof(p1p2Count));
+  memset(data.statsDate, 0, sizeof(data.statsDate));
+  memset(data.p1p2Cnt, 0, sizeof(data.p1p2Cnt));
 #ifdef ENABLE_EXTRA_DIAG
-  memset(udpCount, 0, sizeof(udpCount));
+  memset(data.udpCnt, 0, sizeof(data.udpCnt));
   remaining_seconds = -(millis() / 1000);
 #endif /* ENABLE_EXTRA_DIAG */
-  updateEeprom();
 }
 
 void resetEepromStats() {
-  uint32_t tempArduinoEeprom = eepromCount.eepromWrites;
-  memset(&eepromCount, 0, sizeof(struct_eeprom));
-  eepromCount.eepromWrites = tempArduinoEeprom;
-  updateEeprom();
+  memset(&data.eepromDaikin, 0, sizeof(eeprom_t));
 }
 
-
+// generate new MAC (bytes 0, 1 and 2 are static, bytes 3, 4 and 5 are generated randomly)
 void generateMac() {
   // Marsaglia algorithm from https://github.com/RobTillaart/randomHelpers
   seed1 = 36969L * (seed1 & 65535L) + (seed1 >> 16);
   seed2 = 18000L * (seed2 & 65535L) + (seed2 >> 16);
   uint32_t randomBuffer = (seed1 << 16) + seed2; /* 32-bit random */
-  memcpy(mac, MAC_START, 3);                     // set first 3 bytes
+  memcpy(data.mac, MAC_START, 3);                // set first 3 bytes
   for (byte i = 0; i < 3; i++) {
-    mac[i + 3] = randomBuffer & 0xFF;  // random last 3 bytes
+    data.mac[i + 3] = randomBuffer & 0xFF;  // random last 3 bytes
     randomBuffer >>= 8;
   }
 }
 
 void updateEeprom() {
   eepromTimer.sleep(EEPROM_INTERVAL * 60UL * 60UL * 1000UL);  // EEPROM_INTERVAL is in hours, sleep is in milliseconds!
-  eepromCount.eepromWrites++;                                 // we assume that at least some bytes are written to EEPROM during EEPROM.update or EEPROM.put
-  byte address = CONFIG_START;
-  EEPROM.put(address, eepromCount);
-  address += sizeof(eepromCount);
-  EEPROM.put(address, VERSION[0]);
-  address += 1;
-  EEPROM.put(address, mac);
-  address += 6;
-  EEPROM.put(address, localConfig);
-  address += sizeof(localConfig);
-  EEPROM.put(address, p1p2Count);
-#ifdef ENABLE_EXTRA_DIAG
-  address += sizeof(p1p2Count);
-  EEPROM.put(address, udpCount);
-#endif /* ENABLE_EXTRA_DIAG */
+  data.eepromWrites++;                                        // we assume that at least some bytes are written to EEPROM during EEPROM.update or EEPROM.put
+  EEPROM.put(DATA_START, data);
 }
 
 #if MAX_SOCK_NUM == 8
@@ -223,7 +208,7 @@ void manageSockets() {
               W5100.execCmdSn(s, Sock_DISCON);  //  send DISCON command...
               lastSocketUse[s] = millis();      //   record time at which it was sent...
                                                 // status becomes LAST_ACK for short time
-            } else if ((W5100.readSnPORT(s) == localConfig.webPort && sockAge > WEB_IDLE_TIMEOUT) && sockAge > maxAge) {
+            } else if ((W5100.readSnPORT(s) == data.config.webPort && sockAge > WEB_IDLE_TIMEOUT) && sockAge > maxAge) {
               oldest = s;        //     record the socket number...
               maxAge = sockAge;  //      and make its age the new max age.
             }
@@ -263,22 +248,22 @@ void disconSocket(byte s) {
 }
 
 void manageController() {
-  if ((controllerState == NOT_SUPPORTED) != localConfig.notSupported) {
-    localConfig.notSupported = (controllerState == NOT_SUPPORTED);
+  if ((controllerState == NOT_SUPPORTED) != data.config.notSupported) {
+    data.config.notSupported = (controllerState == NOT_SUPPORTED);
     updateEeprom();
   }
   switch (controllerState) {
     case DISABLED:
     case DISCONNECTED:
     case NOT_SUPPORTED:
-      connectionTimer.sleep(localConfig.connectTimeout * 1000UL);
+      connectionTimer.sleep(data.config.connectTimeout * 1000UL);
       controllerId = 0x00;
       FxAbsentCnt[0] = -1;
       FxAbsentCnt[1] = -1;
       cmdQueue.clear();
       indoorInQueue = false;
       outdoorInQueue = false;
-      if (localConfig.controllerMode == CONTROL_AUTO && controllerState == DISCONNECTED) {
+      if (data.config.controllerMode == CONTROL_AUTO && controllerState == DISCONNECTED) {
         controllerState = CONNECTING;
       }
       break;
@@ -292,10 +277,13 @@ void manageController() {
         }
       }
       if (counterRequestTimer.isOver()) {
-        counterRequestTimer.sleep(localConfig.counterPeriod * 60UL * 1000UL);
+        counterRequestTimer.sleep(data.config.counterPeriod * 60UL * 1000UL);
         cmdQueue.push(2);
         cmdQueue.push(PACKET_TYPE_COUNTER);
         cmdQueue.push(0);
+        if (data.config.sendDataPackets == DATA_CHANGE_AND_REQUEST) {
+          memset(savedPackets, 0xFF, sizeof(savedPackets));  // reset saved packets
+        }
       }
       if (daikinIndoor[0] == '\0' && indoorInQueue == false) {
         cmdQueue.push(2);