Refactoring

Author: ArminJo

examples/WhistleSwitch/ATtinyUtils.cpp

@@ -1,10 +1,10 @@
 /*
  * ATtinyUtils.cpp
  *
- *  Copyright (C) 2018-2020  Armin Joachimsmeyer
+ *  Copyright (C) 2016-2020  Armin Joachimsmeyer
  *  Email: armin.joachimsmeyer@gmail.com
  *
- *  This file is part of ArduinoUtils https://github.com/ArminJo/ArduinoUtils.
+ *  This file is part of Arduino-Utils https://github.com/ArminJo/Arduino-Utils.
  *
  *  ArduinoUtils is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -61,39 +61,8 @@ inline void pinModeFastPortB(uint8_t aOutputPinNumber, uint8_t aMode) {
     (aMode ? DDRB |= (1 << aOutputPinNumber) /* OUTPUT */: DDRB &= ~(1 << aOutputPinNumber));
 }
 
-void __attribute__((weak)) delayMilliseconds(unsigned int aMillis) {
-    for (unsigned int i = 0; i < aMillis; ++i) {
-        delayMicroseconds(1000);
-    }
-}
-
 #if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
 
-/*
- * Like tone(), but use output B - OCR1B (PB4) + !OCR1B (PB3)
- * Assumes port mode already set to output
- */
-void PWMtone(unsigned int aFrequency, unsigned int aDurationMillis) {
-    // Determine which prescaler to use
-    uint8_t tPrescaler = 0x01;
-    uint16_t tOCR = F_CPU / aFrequency;
-    while (tOCR > 0x100 && tPrescaler < 0x0F) {
-        tPrescaler++;
-        tOCR >>= 1;
-
-    }
-    OCR1C = tOCR - 1; // The frequency of the PWM will be Timer Clock 1 Frequency divided by (OCR1C value + 1).
-    OCR1B = OCR1C / 2; // set PWM to 50%
-    GTCCR = (1 << PWM1B) | (1 << COM1B0); // Switch to PWM Mode with OC1B (PB4) + !OC1B (PB3) outputs enabled
-    TCCR1 = (tPrescaler << CS10);
-
-    delayMilliseconds(aDurationMillis);
-    TCCR1 = 0; // Select no clock
-    GTCCR = 0; // Disconnect OC1B + !OC1B
-    digitalWriteFast(PB3, 0);
-    digitalWriteFast(PB4, 0);
-}
-
 /*
  * initialize outputs and use PWM Mode
  * if aUseOutputB == false output frequency at Pin6/5 - PB1/PB0 - OCR1A/!OCR1A

examples/WhistleSwitch/ATtinyUtils.h

@@ -6,7 +6,7 @@
  *
  *  This file is part of ArduinoUtils https://github.com/ArminJo/ArduinoUtils.
  *
- *  ArduinoUtils is free software: you can redistribute it and/or modify
+ *  Arduino-Utils is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
@@ -39,32 +39,27 @@
 #include <avr/io.h>
 
 #if defined(ARDUINO_AVR_DIGISPARK)
-#undef LED_BUILTIN
 #define LED_BUILTIN PB1
 #elif defined(ARDUINO_AVR_DIGISPARKPRO)
-// On a Digispark Pro we have PB1 / D9 / PCB pin 1
-#undef LED_BUILTIN
-#define LED_BUILTIN (9)
+#define LED_BUILTIN (9) // On a Digispark Pro we have PB1 / D9 / PCB pin 1
 #endif
 
-
-
 #if (F_CPU == 1000000)
-#define TIMER0_CLOCK_DIVIDER_FOR_64_MICROS ((1 << CS01) | (1 << CS00))
+#define TIMER0_CLOCK_DIVIDER_FOR_64_MICROS (_BV(CS01) | _BV(CS00))
 
-#define TIMER1_CLOCK_DIVIDER_FOR_8_MICROS (1 << CS12)
-#define TIMER1_CLOCK_DIVIDER_FOR_4_MICROS ((1 << CS11) | (1 << CS10))
-#define TIMER1_CLOCK_DIVIDER_FOR_2_MICROS (1 << CS11)
-#define TIMER1_CLOCK_DIVIDER_FOR_1_MICRO (1 << CS10)
+#define TIMER1_CLOCK_DIVIDER_FOR_8_MICROS _BV(CS12)
+#define TIMER1_CLOCK_DIVIDER_FOR_4_MICROS (_BV(CS11) | _BV(CS10))
+#define TIMER1_CLOCK_DIVIDER_FOR_2_MICROS _BV(CS11)
+#define TIMER1_CLOCK_DIVIDER_FOR_1_MICRO _BV(CS10)
 #endif
 
 #if (F_CPU == 8000000)
-#define TIMER0_CLOCK_DIVIDER_FOR_128_MICROS ((1 << CS02) | (1 << CS00))
+#define TIMER0_CLOCK_DIVIDER_FOR_128_MICROS (_BV(CS02) | _BV(CS00))
 
-#define TIMER1_CLOCK_DIVIDER_FOR_8_MICROS ((1 << CS12) | (1 << CS11)| (1 << CS10))
-#define TIMER1_CLOCK_DIVIDER_FOR_4_MICROS ((1 << CS12) | (1 << CS11))
-#define TIMER1_CLOCK_DIVIDER_FOR_2_MICROS ((1 << CS12) | (1 << CS10))
-#define TIMER1_CLOCK_DIVIDER_FOR_1_MICRO (1 << CS12)
+#define TIMER1_CLOCK_DIVIDER_FOR_8_MICROS (_BV(CS12) | _BV(CS11)| _BV(CS10))
+#define TIMER1_CLOCK_DIVIDER_FOR_4_MICROS (_BV(CS12) | _BV(CS11))
+#define TIMER1_CLOCK_DIVIDER_FOR_2_MICROS (_BV(CS12) | _BV(CS10))
+#define TIMER1_CLOCK_DIVIDER_FOR_1_MICRO _BV(CS12)
 #endif
 
 /*
@@ -87,7 +82,6 @@ inline void delay4CyclesInlineExact(uint16_t a4Microseconds) {
     );
 }
 #if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
-void PWMtone(unsigned int aFrequency, unsigned int aDurationMillis = 0);
 void toneWithTimer1PWM(uint16_t aFrequency, bool aUseOutputB = false);
 #endif
 

examples/WhistleSwitch/WhistleSwitch.ino

@@ -111,17 +111,24 @@
  *
  */
 
+#include <Arduino.h>
+#include "FrequencyDetector.h"
+
 #define VERSION_EXAMPLE "7.3"
 
 #if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__)
 #error "Code size of this example is too large to fit in an ATtiny 25 or 45."
 #endif
 
 #if defined(__AVR_ATtiny85__)
+
 //#define MEASURE_TIMING // not activated yet since there is no timing pin left
+
 //#define TRACE
 //#define DEBUG
 //#define INFO
+#include "DebugLevel.h" // to propagate debug levels
+
 #include "ATtinyUtils.h" // for changeDigisparkClock()
 #  if ! defined(ARDUINO_AVR_DIGISPARK)
 #define INFO // needs around 1600 bytes FLASH - 4450 to 6060 bytes
@@ -132,13 +139,13 @@
 #else
 //#define ARDUINO_PLOTTER
 //#define MEASURE_TIMING
+
 //#define TRACE
 //#define DEBUG
 #define INFO
-#endif // defined(__AVR_ATtiny85__)
+#include "DebugLevel.h" // to propagate debug levels
 
-#include <Arduino.h>
-#include "FrequencyDetector.h"
+#endif // defined(__AVR_ATtiny85__)
 
 /*
  * I can whistle from 550 to 1900 Hz (and do it easy from 950 - 1800)
@@ -779,7 +786,9 @@ uint16_t getFreeRam(void) {
  * Setup section
  *******************************************************************************************/
 void setup() {
+#ifdef INFO
     uint8_t tMCUSRStored = MCUSR; // content of MCUSR register at startup
+#endif
     MCUSR = 0; // to prepare for next reset or power on
 
     /*
@@ -1359,7 +1368,7 @@ ISR(PCINT0_vect) {
         PCICR = 0; // disable new PCINT's, since we allow nested interrupts
         PCIFR = _BV(PCIF2); // Must clear interrupt flag in order to avoid to call this ISR again, when enabling interrupts below.
 #elif defined(__AVR_ATtiny85__)
-    GIMSK &= ~ _BV(PCIE); // disable new PCINT's, since we allow nested interrupts
+    GIMSK &= ~_BV(PCIE); // disable new PCINT's, since we allow nested interrupts
     GIFR = _BV(PCIF); // Must clear interrupt flag in order to avoid to call this ISR again, when enabling interrupts below.
 #endif
 

src/DebugLevel.h

@@ -0,0 +1,52 @@
+/*
+ * DebugLevel.h
+ * Include to propagate debug levels
+ *
+ *  Copyright (C) 2016-2020  Armin Joachimsmeyer
+ *  Email: armin.joachimsmeyer@gmail.com
+ *
+ *  This file is part of Arduino-Utils https://github.com/ArminJo/Arduino-Utils.
+ *
+ *  Arduino-Utils is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/gpl.html>.
+ *
+ */
+
+#ifndef DEBUGLEVEL_H_
+#define DEBUGLEVEL_H_
+
+// Propagate debug level
+#ifdef TRACE
+#  ifndef DEBUG
+#define DEBUG
+#  endif
+#endif
+#ifdef DEBUG
+#  ifndef INFO
+#define INFO
+#  endif
+#endif
+#ifdef INFO
+#  ifndef WARN
+#define WARN
+#  endif
+#endif
+#ifdef WARN
+#  ifndef ERROR
+#define ERROR
+#  endif
+#endif
+
+#endif /* DEBUGLEVEL_H_ */
+
+#pragma once

src/FrequencyDetector.cpp

@@ -9,7 +9,7 @@
  * The value of millis() is adjusted after reading.
  * The alternative to disabling the interrupt is getting partially invalid results!
  *
- *  Copyright (C) 2014  Armin Joachimsmeyer
+ *  Copyright (C) 2014-2020  Armin Joachimsmeyer
  *  Email: armin.joachimsmeyer@gmail.com
  *
  *  This file is part of Arduino-FrequencyDetector https://github.com/ArminJo/Arduino-FrequencyDetector.
@@ -41,15 +41,18 @@
 
 #include <Arduino.h>
 
+#include "FrequencyDetector.h"
+
 //#define INFO
 //#define DEBUG
 //#define TRACE
+#include "DebugLevel.h" // to propagate debug levels
 
 #if (defined(INFO) || defined(DEBUG) || defined(TRACE)) && (defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__))
-#include "ATtinySerialOut.h"
+#include "ATtinySerialOut.h" // Available as Arduino library and contained in WhistleSwitch example.
 #endif
 
-#include "FrequencyDetector.h"
+#include "MillisUtils.h" // for timer0_millis
 
 #define maximumAllowableCountOf(aPeriodCountTotal) (aPeriodCountTotal / 8)
 

src/FrequencyDetector.h

@@ -38,20 +38,6 @@
 #define FREQUENCY_RANGE_DEFAULT
 //#define FREQUENCY_RANGE_HIGH // use it for frequencies above approximately 3000 Hz
 
-// Propagate debug level
-#ifdef TRACE
-#define DEBUG
-#endif
-#ifdef DEBUG
-#define INFO
-#endif
-#ifdef INFO
-#define WARN
-#endif
-#ifdef WARN
-#define ERROR
-#endif
-
 /*
  * Global settings which are needed at compile time
  */
@@ -148,14 +134,6 @@
 // number of needed valid readings (FrequencyRaw > SIGNAL_MAX_ERROR_CODE) before any (lower, match, higher) match - to avoid short flashes at random signal input
 #define MIN_NO_DROPOUT_COUNT_BEFORE_ANY_MATCH_DEFAULT ((MIN_NO_DROPOUT_MILLIS_BEFORE_ANY_MATCH_DEFAULT * 1000L) / MICROS_PER_BUFFER_READING)
 
-/*
- * storage for millis value to enable compensation for interrupt disable at signal acquisition etc.
- */
-#if ( defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) )
-#define timer0_millis millis_timer_millis // The ATTinyCore libraries use other variable name in wiring.c
-#endif
-extern volatile unsigned long timer0_millis;
-
 // FrequencyRaw error values
 #define SIGNAL_NO_TRIGGER 0
 #define SIGNAL_STRENGTH_LOW 1