test ai commands

Author: n3roGit

Diff for: DPVController/beep.cpp

@@ -1,3 +1,4 @@
+// Includes for required header files
 #include "constants.h"
 #include "Blinker.h"
 #include "BlinkSequence.h"
@@ -6,61 +7,71 @@
 #include "motor.h"
 
 /**
-* CONSTANTS
+* CONSTANTS - Constants for beep durations
 */
-const long SHORT_BEEP_MS = 200;
-const long LONG_BEEP_MS = 600;
-const long PAUSE_MS = 400;
+const long SHORT_BEEP_MS = 200;  // Duration of short beep in milliseconds
+const long LONG_BEEP_MS = 600;   // Duration of long beep in milliseconds
+const long PAUSE_MS = 400;       // Duration of pause between beeps in milliseconds
 
 /**
-* VARIABLES
+* VARIABLES - Global timing variables
 */
-unsigned long lastBeepTime = 0;
-unsigned long lastLeakBeepTime = 0;
+unsigned long lastBeepTime = 0;       // Timestamp of last beep
+unsigned long lastLeakBeepTime = 0;   // Timestamp of last leak alarm
 
-void turnOnFunction(){digitalWrite(PIN_BEEP, HIGH);}
+// Helper functions to control the beeper
+void turnOnFunction(){digitalWrite(PIN_BEEP, HIGH);}  // Turns beeper on
 
-void turnOffFunction(){digitalWrite(PIN_BEEP, LOW);}
+void turnOffFunction(){digitalWrite(PIN_BEEP, LOW);}  // Turns beeper off
 
+// Creates a Blinker object with the on/off functions
 Blinker beepBlinker = Blinker(turnOnFunction, turnOffFunction);
 
-
+// Determines beep duration based on character
+// '1' = short beep, anything else = long beep
 long beepDuration(char c){
    return (c == '1') ? SHORT_BEEP_MS : LONG_BEEP_MS;
 }
 
+// Creates a sequence of beeps with defined pauses
 BlinkSequence beepSequence = BlinkSequence(beepBlinker, beepDuration, PAUSE_MS);
 
-
 /**
-* Perform a beep for the given time. Works asynchronously. 
+* Generates a single beep for the specified duration.
+* Works asynchronously (non-blocking).
+* @param length_ms Duration of beep in milliseconds
 */
 void beep(long length_ms){
   log("Beeping for ms", length_ms);
   beepBlinker.blink(length_ms);
 }
 
 /**
-* Perform a beep for each character in the string with a pause between beeps. 
-* a "1" in the string will be a short beep. All others long beeps. 
-* Works asynchronously(does not block).
+* Generates a sequence of beeps based on a string.
+* '1' generates a short beep, all other characters generate long beeps.
+* Works asynchronously (non-blocking).
+* @param sequence String containing the beep sequence
 */
 void beep(const String& sequence) {
   if(EnableDebugLog) Serial.println("beepSequence:"+sequence);
   beepSequence.blink(sequence);
 }
 
+// Main loop for beep functionality
 void beepLoop(){
   beepSequence.loop();
   beepBlinker.loop();
 }
 
-
+/**
+* Monitors leak sensor and outputs warning tone if needed
+* Checks sensor status every 10 seconds and beeps if leak detected
+* Part of DPV safety system for water ingress detection
+*/
 void BeepForLeak() {
-  if (leakSensorState == 1 && micros() - lastBeepTime >= (10 * 1000 * 1000)) {  // Every 10 seconds
-    beep("12121212");                                                              // Here is the desired sequence for the sound
+  if (leakSensorState == 1 && micros() - lastBeepTime >= (10 * 1000 * 1000)) {  // Check every 10 seconds
+    beep("12121212");                                                            // Alternates short/long for warning
     log("WARNING LEAK", 12121212, true);
-    lastLeakBeepTime = micros();  // update the time of the last call
+    lastLeakBeepTime = micros();  // Updates timestamp
   }
 }
-

Diff for: DPVController/ledBar.cpp

@@ -3,63 +3,71 @@
 #include "constants.h"
 
 /**
-* Code that controls the two led strips
+* Code for controlling the two LED strips.
+* Enables display of various states like speed,
+* battery level and warnings through LED animations.
 */
 
 /*
 *  CONSTANTS
 */
-const int LedBar_Num = 10;          // Number of LEDs in the strip
-const int LEDBar_Brightness = 15;
-const int LEDBar_BrightnessSecond = 3;
+const int LedBar_Num = 10;          // Number of LEDs per strip
+const int LEDBar_Brightness = 15;    // Default brightness for active LEDs
+const int LEDBar_BrightnessSecond = 3; // Reduced brightness for secondary displays
 
 /*
 * GLOBAL VARIABLES 
 */
+// NeoPixel object for both LED strips
 Adafruit_NeoPixel strip = Adafruit_NeoPixel(LedBar_Num + LedBar2_Num, PIN_LEDBAR, NEO_GRB + NEO_KHZ800);
 
-unsigned long lastOverrideTime = 0;
-bool isOverridden = false;
-int lastSpeedValue = 0;
-const unsigned long OVERRIDE_TIMEOUT = 30000; // 30 Sekunden in Millisekunden
+unsigned long lastOverrideTime = 0;   // Timestamp of last override
+bool isOverridden = false;            // Flag for active override
+int lastSpeedValue = 0;               // Stores last speed value
+const unsigned long OVERRIDE_TIMEOUT = 30000; // Timeout for overrides (30 seconds)
 
+/**
+* Initializes the LED strips and sets them to standby mode
+*/
 void ledBarSetup(){
-  //Neopixel
   strip.begin();
-  strip.show();  // Alle LEDs ausschalten
+  strip.show();  // Turn off all LEDs
   setBarStandby();
 }
 
-
+/**
+* Sets the LEDs of a strip with defined colors and brightness
+* @param stripNumber Number of LED strip (1 or 2)
+* @param numLEDsOn Number of active LEDs
+* @param hexColorOn Hex color code for active LEDs
+* @param brightnessOn Brightness of active LEDs (0-100)
+* @param hexColorOff Hex color code for inactive LEDs
+* @param brightnessOff Brightness of inactive LEDs (0-100)
+*/
 void setBar(int stripNumber, int numLEDsOn, String hexColorOn, int brightnessOn, String hexColorOff, int brightnessOff) {
-  // Make sure that stripNumber is valid (1 for the first strip, 2 for the second strip)
   if (stripNumber != 1 && stripNumber != 2) {
-    return; // Unauthorized value, do nothing
+    return; // Invalid value, abort function
   }
 
-  // Berechne den Startindex basierend auf stripNumber
   int startIndex = (stripNumber == 1) ? 0 : LedBar_Num;
-
-  // Calculate the end index based on stripNumber
   int endIndex = (stripNumber == 1) ? LedBar_Num : LedBar_Num + LedBar2_Num;
 
-  // Convert the hex color value to RGB color values for the switched-on color
+  // Convert hex color code to RGB for active LEDs
   long numberOn = (long)strtol(&hexColorOn[1], NULL, 16);
   int redOn = numberOn >> 16;
   int greenOn = (numberOn >> 8) & 0xFF;
   int blueOn = numberOn & 0xFF;
 
-  // Set the LEDs according to the specified brightness and colors
+  // Set active LEDs
   for (int i = startIndex; i < startIndex + numLEDsOn; i++) {
     int dimmed_color_r = redOn * brightnessOn / 100;
     int dimmed_color_g = greenOn * brightnessOn / 100;
     int dimmed_color_b = blueOn * brightnessOn / 100;
     strip.setPixelColor(i, strip.Color(dimmed_color_r, dimmed_color_g, dimmed_color_b));
   }
 
-  // Set the LEDs for the side that is switched off
+  // Set inactive LEDs
   for (int i = startIndex + numLEDsOn; i < endIndex; i++) {
-    // Convert the hex color value to RGB color values for the switched off color
     long numberOff = (long)strtol(&hexColorOff[1], NULL, 16);
     int redOff = numberOff >> 16;
     int greenOff = (numberOff >> 8) & 0xFF;
@@ -70,29 +78,46 @@ void setBar(int stripNumber, int numLEDsOn, String hexColorOn, int brightnessOn,
   strip.show();  // Update LED strips
 }
 
+/**
+* Sets LED strips to standby mode
+*/
 void setBarStandby() {
     setBar(1,10,"#e38f09", LEDBar_BrightnessSecond, "#000000", 0);
 }
 
+/**
+* Checks and handles timeouts of overrides
+*/
 void handleBarOverride() {
     if (isOverridden && (millis() - lastOverrideTime > OVERRIDE_TIMEOUT)) {
         isOverridden = false;
-        setBarSpeed(lastSpeedValue); // Stelle Speed-Anzeige wieder her
+        setBarSpeed(lastSpeedValue); // Restore speed display
     }
 }
 
+/**
+* Displays current speed on LED strip
+* @param num Number of LEDs to activate (speed)
+*/
 void setBarSpeed(int num) {
-    lastSpeedValue = num; // Speichern des letzten Speed-Wertes
+    lastSpeedValue = num;
     if (!isOverridden) {
         setBar(1,num,"#cb1bf2", LEDBar_Brightness, "#000000", 0);
     }
 }
 
+/**
+* Displays battery level on second LED strip
+* @param num Battery level (0-10)
+*/
 void setBarBattery(int num) {
   int calc = LedBar_Num-num;
   setBar(2,calc,"#e30b0b", LEDBar_BrightnessSecond, "#0a9e08", LEDBar_Brightness);
 }
 
+/**
+* Shows leak warnings through LED animations
+*/
 void setBarLeak() {
     int frontLeakState = digitalRead(PIN_LEAK_FRONT);
     int backLeakState = digitalRead(PIN_LEAK_BACK);
@@ -102,34 +127,46 @@ void setBarLeak() {
         lastOverrideTime = millis();
 
         if (backLeakState == LOW && frontLeakState == LOW) {
-            setBar(1,10,"#0000FF", LEDBar_Brightness, "#0000FF", 0);
+            setBar(1,10,"#0000FF", LEDBar_Brightness, "#0000FF", 0); // Both leaks
         } else if (backLeakState == LOW) {
-            setBar(1,5,"#0000FF", LEDBar_Brightness, "#0000FF", 0);
+            setBar(1,5,"#0000FF", LEDBar_Brightness, "#0000FF", 0);  // Back leak
         } else if(frontLeakState == LOW) {
-            setBar(1,5,"#0000FF", 0, "#0000FF", LEDBar_Brightness);
+            setBar(1,5,"#0000FF", 0, "#0000FF", LEDBar_Brightness); // Front leak
         }
     }
 }
 
+/**
+* Shows powerbank status
+* @param status true for active, false for inactive
+*/
 void setBarPowerBank(bool status) {
     isOverridden = true;
     lastOverrideTime = millis();
 
     if (status){
-        setBar(1,9,"#000000", 0, "#036ffc", LEDBar_Brightness);
+        setBar(1,9,"#000000", 0, "#036ffc", LEDBar_Brightness); // Blue for active
     }
     else {
-        setBar(1,9,"#000000", 0, "#ff0000", LEDBar_Brightness);
+        setBar(1,9,"#000000", 0, "#ff0000", LEDBar_Brightness); // Red for inactive
     }  
 }
 
+/**
+* Sets a specific number of LEDs to white
+* @param num Number of white LEDs
+*/
 void setBarLED(int num) {
     isOverridden = true;
     lastOverrideTime = millis();
     int calc = LedBar_Num-num;
     setBar(1,calc,"#000000", 0, "#FFFFFF", LEDBar_Brightness);
 }
 
+/**
+* Activates/Deactivates flasher mode
+* @param status true for active, false for inactive
+*/
 void setBarFlasher(bool status) {
     if (status){
         isOverridden = true;