Merge pull request #10 from PagoPlus/feature/aovx-protocol

[FEAT] Add aovx protocol

Author: fermuch

.gitignore

@@ -1,2 +1,3 @@
 .pio
 .vscode/c_cpp_properties.json
+.aider*

platformio.ini

@@ -29,6 +29,8 @@ framework = arduino
 test_build_src = true
 build_unflags = -std=gnu++11
 build_flags = 
+  -DDEBUGLOG_DEFAULT_LOG_LEVEL_TRACE
+  -D__PLATFORMIO_BUILD_DEBUG__=1
 	-DPIO_UNIT_TESTING=1
   -std=gnu++17
 lib_deps =

src/PPNet.cpp

@@ -2,6 +2,7 @@
 #include "utils/adler.h"
 
 #include <variant>
+#include <Arduino.h>
 
 using namespace PPNetwork;
 using namespace PPNetwork::Message;
@@ -20,6 +21,7 @@ constexpr bool validateWriteTargetType(WriteTargetType type)
   {
   case WriteTargetType::RAW:
   case WriteTargetType::SUNTECH:
+  case WriteTargetType::AOVX:
     return true;
   default:
     return false;
@@ -68,7 +70,6 @@ size_t PPNet::WriteMessage(AnyMessage msg)
 
   // calculate package size (1=code, 4=checksum, rest=payload)
   auto totalSize = 1 + 4 + this->packer.size();
-  assert(totalSize < 255);
 
   auto checksum = PPNetwork::Utils::adler32(packer.data(), packer.size());
   uint8_t checksum_arr[4] = {0};
@@ -77,18 +78,36 @@ size_t PPNet::WriteMessage(AnyMessage msg)
   switch (this->targetType)
   {
   case WriteTargetType::RAW:
+    assert(totalSize < 255);
     this->output->write(static_cast<uint8_t>(type));
     this->output->write(checksum_arr, 4);
     this->output->write(packer.data(), packer.size());
     this->output->flush();
     break;
   case WriteTargetType::SUNTECH:
+    assert(totalSize < 255);
     this->output->write(static_cast<uint8_t>(type));
     this->output->write(checksum_arr, 4);
     this->output->write(packer.data(), packer.size());
     this->output->write("\r\n");
     this->output->flush();
     break;
+  case WriteTargetType::AOVX:
+    assert(totalSize < 511);
+    {
+      unsigned long currentTime = millis();
+      unsigned long elapsedTime = currentTime - this->lastMessageTime;
+      if (elapsedTime < 120) {
+        delay(120 - elapsedTime);
+      }
+      this->output->write(static_cast<uint8_t>(type));
+      this->output->write(checksum_arr, 4);
+      this->output->write(packer.data(), packer.size());
+      this->output->write("\n");
+      this->output->flush();
+      this->lastMessageTime = millis(); // Update the last message timestamp
+    }
+    break;
   }
 
   return totalSize;

src/PPNet.h

@@ -141,7 +141,8 @@ namespace PPNetwork
   enum class WriteTargetType : uint8_t
   {
     RAW = 0x01,
-    SUNTECH = 0x02
+    SUNTECH = 0x02,
+    AOVX = 0x03
   };
 
   /**
@@ -165,6 +166,7 @@ namespace PPNetwork
     Stream *output;
     WriteTargetType targetType;
     MsgPack::Packer packer;
+    unsigned long lastMessageTime = 0; // New member to store the last message timestamp
   };
 }
 

test/test-message-encoding.cpp

@@ -85,3 +85,25 @@ TEST_F(MessageEncodingTest, encode_SingleCounterMessage)
   ASSERT_DATA_EQUALS(serial.getTransmittedData(), {0x02, 0x31, 0xfe, 0x06, 0xc5, 0x94, 0xa3, 0x7a, 0x61, 0x7a, 0x2a, 0xce, 0x02, 0x87, 0x57, 0xb2, 0xcd, 0x05, 0xdc});
   serial.clearTransmittedData();
 }
+
+TEST_F(MessageEncodingTest, encode_AOVXMessage)
+{
+  FakeSerial serial;
+  PPNetwork::PPNet ppnet(&serial, PPNetwork::WriteTargetType::AOVX);
+  PPNetwork::Message::HelloMessage msg;
+  memset(&msg, 0x00, sizeof(msg));
+
+  msg.uniqueId = "TestRunner";
+  msg.boardIdentifier = "Tester";
+  msg.version = 0x1234;
+  msg.boardVersion = 0x4321;
+  msg.bootId = 0x5353456;
+  msg.ppnetVersion = 0x00;
+  ASSERT_EQ(ppnet.WriteMessage(msg), 36); // 35 bytes + 1 byte for newline
+  ASSERT_DATA_EQUALS(serial.getTransmittedData(), {0x01,
+                                                   0xda, 0x12, 0x0c, 0x4f,
+                                                   0x96, 0xaa, 0x54, 0x65, 0x73, 0x74, 0x52, 0x75, 0x6e, 0x6e, 0x65, 0x72, 0xa6, 0x54, 0x65, 0x73,
+                                                   0x74, 0x65, 0x72, 0xcd, 0x12, 0x34, 0xcd, 0x43, 0x21, 0xce, 0x05, 0x35, 0x34, 0x56,
+                                                   0x01, 0x0a}); // 0x0a is the newline character
+  serial.clearTransmittedData();
+}