[atoms3] Add version info and version_request packet

Author: iory

firmware/atom_s3_i2c_display/extra_script.py

@@ -1,5 +1,6 @@
 # flake8: noqa
 import os
+import subprocess
 
 from SCons.Script import Import
 
@@ -23,6 +24,17 @@ def validate_i2c_address(addr):
 
 Import("env")
 
+try:
+    riberry_version = subprocess.check_output(
+        ["git", "log", "-1", "--pretty=format:%h"],
+        universal_newlines=True
+    ).strip()
+    env.Append(CPPDEFINES=[f"RIBERRY_VERSION=\\\"{riberry_version}\\\""])
+except subprocess.CalledProcessError:
+    print("\033[91mWarning: Failed to get git commit hash. Using default RIBERRY_VERSION.\033[0m")
+    env.Append(CPPDEFINES=["RIBERRY_VERSION=\\\"unknown\\\""])
+
+
 USE_GROVE = os.getenv("USE_GROVE")
 LCD_ROTATION = os.getenv("LCD_ROTATION")
 I2C_ADDR = os.getenv("I2C_ADDR")

firmware/atom_s3_i2c_display/lib/com/communication_base.cpp

@@ -2,6 +2,7 @@
 #include <communication_base.h>
 
 #include "firmware_update.h"
+#include "riberry_config.h"
 
 CommunicationBase* CommunicationBase::instance = nullptr;
 Stream* CommunicationBase::_stream = nullptr;
@@ -229,6 +230,12 @@ void CommunicationBase::processPacket(const String& str, int offset) {
             instance->pairing.setDataToSend(dataToSend);
             break;
         }
+        case FIRMWARE_VERSION_REQUEST: {
+            _stream->flush();
+            String version = VERSION;
+            write(version, version.length());
+            break;
+        }
         case FIRMWARE_UPDATE_MODE: {
             stopStream();
             instance->lcd.lockLcd();

firmware/atom_s3_i2c_display/lib/com/packet.h

@@ -15,5 +15,6 @@ enum PacketType : uint8_t {
     SET_IP_REQUEST = 0x13,
     SPEECH_TO_TEXT_MODE = 0x14,
 
+    FIRMWARE_VERSION_REQUEST = 0xFD,
     FIRMWARE_UPDATE_MODE = 0xFF,
 };

firmware/atom_s3_i2c_display/lib/lcd/primitive_lcd.cpp

@@ -1,5 +1,8 @@
 #include <primitive_lcd.h>
 
+#include "color.h"
+#include "riberry_config.h"
+
 PrimitiveLCD::PrimitiveLCD() : LGFX(), qrCodeData("") {
     init();
     lcdMutex = xSemaphoreCreateRecursiveMutex();
@@ -273,7 +276,10 @@ void PrimitiveLCD::printWaitMessage(int i2cAddress) {
 void PrimitiveLCD::drawNoDataReceived() {
     fillScreen(color565(255, 0, 0));  // Fill the screen with red
     setCursor(0, 0);
-    printColorText("No data received.\n");
+    char log_msg[50];
+    sprintf(log_msg, "No data received.\n%sV:%s\n%s", Color::Foreground::YELLOW, VERSION,
+            Color::Foreground::RESET);
+    printColorText(log_msg);
 }
 
 void PrimitiveLCD::drawBlack() {

firmware/atom_s3_i2c_display/lib/utils/riberry_config.h

@@ -0,0 +1,12 @@
+#ifndef RIBERRY_CONFIG_H
+#define RIBERRY_CONFIG_H
+
+#include <Arduino.h>
+
+#ifdef RIBERRY_VERSION
+constexpr const char VERSION[] = RIBERRY_VERSION;
+#else
+constexpr const char VERSION[] = "v0.0.0";  // OK
+#endif
+
+#endif  // RIBERRY_CONFIG_H

riberry/com/base.py

@@ -24,6 +24,7 @@ class PacketType(IntEnum):
     SET_IP_REQUEST = 0x13
     SPEECH_TO_TEXT_MODE = 0x14
 
+    FIRMWARE_VERSION_REQUEST = 0xFD
     FIRMWARE_UPDATE_MODE = 0xFF
 
 class ComBase: