Documentation

Author: ArminJo

README.md

@@ -33,7 +33,7 @@ Not yet available as Arduino library.
 
 <br/>
 
-# Table of content
+# Table of contents
 * [SimpleEMAFilters](https://github.com/ArminJo/Arduino-Utils?tab=readme-ov-file#simpleemafilters)
 * [ADCUtils](https://github.com/ArminJo/Arduino-Utils?tab=readme-ov-file#adcutils)
 * [HCSR04](https://github.com/ArminJo/Arduino-Utils?tab=readme-ov-file#hcsr04)
@@ -77,7 +77,7 @@ Simplified formula for small alpha is CutoffFrequency = (SampleFrequency / (2&pi
 - 1/32 -> 5.13 Hz (160 Hz / 31)
 - 1/256 -> 0.624 Hz (160 Hz / 255)
 
-Using the [more exact formula](https://github.com/MakeMagazinDE/DigitaleFilter/blob/main/Filter-Berechnungen.xlsx), alpha = 1 - e ^ -((2&pi; * CutoffFrequency) / SampleFrequency)  
+Using the [more exact formula](https://github.com/MakeMagazinDE/DigitaleFilter/blob/main/Filter-Berechnungen.xlsx), alpha = 1 - e ^ -((2&pi; * CutoffFrequency) / SampleFrequency)
 => CutoffFrequency = (-ln(1-alpha) * SampleFrequency) / 2&pi; we get the values:
 - 110 Hz
 - 46 Hz
@@ -292,6 +292,8 @@ If you are using [Sloeber](https://eclipse.baeyens.it) as your IDE, you can easi
 
 # Revision History
 
+- Renamed printRAMInfo to printRAMAndStackInfo.
+
 ### Version 1.2.1
 - Improved Stack info, if stack is exhausted, added flush to HexDump, improved examples.
 

examples/AVRUtilsDemo/AVRUtilsDemo.ino

@@ -2,7 +2,7 @@
  *  AVRUtilsDemo.cpp
  *
  *  Demo of 2 seconds sleep with watchdog
- *  Demo of printRAMInfo() and printStackUnusedAndUsedBytes ()
+ *  Demo of printRAMAndStackInfo() and printStackUnusedAndUsedBytes ()
  *
  *  Copyright (C) 2020-2026  Armin Joachimsmeyer
  *  armin.joachimsmeyer@gmail.com

src/ADCUtils.hpp

@@ -29,7 +29,8 @@
 #if defined(ADC_UTILS_ARE_AVAILABLE) // set in ADCUtils.h, if supported architecture was detected
 #define ADC_UTILS_ARE_INCLUDED
 
-#if !defined(STR)
+// Helper macro for getting a macro definition as string
+#if !defined(STR_HELPER) && !defined(STR)
 #define STR_HELPER(x) #x
 #define STR(x) STR_HELPER(x)
 #endif
@@ -694,7 +695,7 @@ bool isVCCUSBPowered(Print *aSerial) {
 }
 
 /*
- * It checks every 10 seconds for 6 times, and then returns true if the undervoltage condition ( <3.4V ) still applies.
+ * It checks every 10 seconds for 6 times, and then returns once true if the undervoltage condition ( <3.4V ) still applies.
  * @ return true only once, when VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP (6) times voltage too low -> shutdown
  */
 bool isVCCUndervoltageMultipleTimes() {
@@ -732,7 +733,7 @@ bool isVCCUndervoltageMultipleTimes() {
                     sVCCTooLowCounter++;
 #  if defined(LOCAL_INFO)
                     Serial.print(sVCCVoltageMillivolt);
-                    Serial.print(F(" mV < " STR(VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) " mV undervoltage detected: "));
+                    Serial.print(F(" mV < " STR(VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) " mV -> undervoltage detected: "));
 
                     Serial.print(VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP - sVCCTooLowCounter);
                     Serial.println(F(" attempts left"));