removed references to none-supported ping timer functions for the ESP8266 chip

Author: jshaw

NewPingESP8266.cpp

@@ -192,154 +192,6 @@ void NewPingESP8266::set_max_distance(unsigned int max_cm_distance) {
 }
 
 
-#if TIMER_ENABLED == true && DO_BITWISE == true
-
-// ---------------------------------------------------------------------------
-// Timer interrupt ping methods (won't work with non-AVR, ATmega128 and all ATtiny microcontrollers)
-// ---------------------------------------------------------------------------
-
-void NewPingESP8266::ping_timer(void (*userFunc)(void), unsigned int max_cm_distance) {
-	if (max_cm_distance > 0) set_max_distance(max_cm_distance); // Call function to set a new max sensor distance.
-
-	if (!ping_trigger()) return;         // Trigger a ping, if it returns false, return without starting the echo timer.
-	timer_us(ECHO_TIMER_FREQ, userFunc); // Set ping echo timer check every ECHO_TIMER_FREQ uS.
-}
-
-
-boolean NewPingESP8266::check_timer() {
-	if (micros() > _max_time) { // Outside the time-out limit.
-		timer_stop();           // Disable timer interrupt
-		return false;           // Cancel ping timer.
-	}
-
-#if URM37_ENABLED == false
-	if (!(*_echoInput & _echoBit)) { // Ping echo received.
-#else
-	if (*_echoInput & _echoBit) {    // Ping echo received.
-#endif
-		timer_stop();                // Disable timer interrupt
-		ping_result = (micros() - (_max_time - _maxEchoTime) - PING_TIMER_OVERHEAD); // Calculate ping time including overhead.
-		return true;                 // Return ping echo true.
-	}
-
-	return false; // Return false because there's no ping echo yet.
-}
-
-
-// ---------------------------------------------------------------------------
-// Timer2/Timer4 interrupt methods (can be used for non-ultrasonic needs)
-// ---------------------------------------------------------------------------
-
-// Variables used for timer functions
-void (*intFunc)();
-void (*intFunc2)();
-unsigned long _ms_cnt_reset;
-volatile unsigned long _ms_cnt;
-#if defined(__arm__) && defined(TEENSYDUINO)
-	IntervalTimer itimer;
-#endif
-
-
-void NewPingESP8266::timer_us(unsigned int frequency, void (*userFunc)(void)) {
-	intFunc = userFunc; // User's function to call when there's a timer event.
-	timer_setup();      // Configure the timer interrupt.
-
-#if defined (__AVR_ATmega32U4__) // Use Timer4 for ATmega32U4 (Teensy/Leonardo).
-	OCR4C = min((frequency>>2) - 1, 255); // Every count is 4uS, so divide by 4 (bitwise shift right 2) subtract one, then make sure we don't go over 255 limit.
-	TIMSK4 = (1<<TOIE4);                  // Enable Timer4 interrupt.
-#elif defined (__arm__) && defined (TEENSYDUINO) // Timer for Teensy 3.x
-	itimer.begin(userFunc, frequency);           // Really simple on the Teensy 3.x, calls userFunc every 'frequency' uS.
-#else
-	OCR2A = min((frequency>>2) - 1, 255); // Every count is 4uS, so divide by 4 (bitwise shift right 2) subtract one, then make sure we don't go over 255 limit.
-	TIMSK2 |= (1<<OCIE2A);                // Enable Timer2 interrupt.
-#endif
-}
-
-
-void NewPingESP8266::timer_ms(unsigned long frequency, void (*userFunc)(void)) {
-	intFunc = NewPingESP8266::timer_ms_cntdwn;  // Timer events are sent here once every ms till user's frequency is reached.
-	intFunc2 = userFunc;                 // User's function to call when user's frequency is reached.
-	_ms_cnt = _ms_cnt_reset = frequency; // Current ms counter and reset value.
-	timer_setup();                       // Configure the timer interrupt.
-
-#if defined (__AVR_ATmega32U4__) // Use Timer4 for ATmega32U4 (Teensy/Leonardo).
-	OCR4C = 249;           // Every count is 4uS, so 1ms = 250 counts - 1.
-	TIMSK4 = (1<<TOIE4);   // Enable Timer4 interrupt.
-#elif defined (__arm__) && defined (TEENSYDUINO)  // Timer for Teensy 3.x
-	itimer.begin(NewPingESP8266::timer_ms_cntdwn, 1000); // Set timer to 1ms (1000 uS).
-#else
-	OCR2A = 249;           // Every count is 4uS, so 1ms = 250 counts - 1.
-	TIMSK2 |= (1<<OCIE2A); // Enable Timer2 interrupt.
-#endif
-}
-
-
-void NewPingESP8266::timer_stop() { // Disable timer interrupt.
-#if defined (__AVR_ATmega32U4__) // Use Timer4 for ATmega32U4 (Teensy/Leonardo).
-	TIMSK4 = 0;
-#elif defined (__arm__) && defined (TEENSYDUINO) // Timer for Teensy 3.x
-	itimer.end();
-#else
-	TIMSK2 &= ~(1<<OCIE2A);
-#endif
-}
-
-
-// ---------------------------------------------------------------------------
-// Timer2/Timer4 interrupt method support functions (not called directly)
-// ---------------------------------------------------------------------------
-
-void NewPingESP8266::timer_setup() {
-#if defined (__AVR_ATmega32U4__) // Use Timer4 for ATmega32U4 (Teensy/Leonardo).
-	timer_stop(); // Disable Timer4 interrupt.
-	TCCR4A = TCCR4C = TCCR4D = TCCR4E = 0;
-	TCCR4B = (1<<CS42) | (1<<CS41) | (1<<CS40) | (1<<PSR4); // Set Timer4 prescaler to 64 (4uS/count, 4uS-1020uS range).
-	TIFR4 = (1<<TOV4);
-	TCNT4 = 0;    // Reset Timer4 counter.
-#elif defined (__AVR_ATmega8__) || defined (__AVR_ATmega16__) || defined (__AVR_ATmega32__) || defined (__AVR_ATmega8535__) // Alternate timer commands for certain microcontrollers.
-	timer_stop();                 // Disable Timer2 interrupt.
-	ASSR &= ~(1<<AS2);            // Set clock, not pin.
-	TCCR2 = (1<<WGM21 | 1<<CS22); // Set Timer2 to CTC mode, prescaler to 64 (4uS/count, 4uS-1020uS range).
-	TCNT2 = 0;                    // Reset Timer2 counter.
-#elif defined (__arm__) && defined (TEENSYDUINO)
-	timer_stop(); // Stop the timer.
-#else
-	timer_stop();        // Disable Timer2 interrupt.
-	ASSR &= ~(1<<AS2);   // Set clock, not pin.
-	TCCR2A = (1<<WGM21); // Set Timer2 to CTC mode.
-	TCCR2B = (1<<CS22);  // Set Timer2 prescaler to 64 (4uS/count, 4uS-1020uS range).
-	TCNT2 = 0;           // Reset Timer2 counter.
-#endif
-}
-
-
-void NewPingESP8266::timer_ms_cntdwn() {
-	if (!_ms_cnt--) {            // Count down till we reach zero.
-		intFunc2();              // Scheduled time reached, run the main timer event function.
-		_ms_cnt = _ms_cnt_reset; // Reset the ms timer.
-	}
-}
-
-#if defined (__AVR_ATmega32U4__) // Use Timer4 for ATmega32U4 (Teensy/Leonardo).
-ISR(TIMER4_OVF_vect) {
-	intFunc(); // Call wrapped function.
-}
-#elif defined (__AVR_ATmega8__) || defined (__AVR_ATmega16__) || defined (__AVR_ATmega32__) || defined (__AVR_ATmega8535__) // Alternate timer commands for certain microcontrollers.
-ISR(TIMER2_COMP_vect) {
-	intFunc(); // Call wrapped function.
-}
-#elif defined (__arm__)
-// Do nothing...
-#else
-ISR(TIMER2_COMPA_vect) {
-	intFunc(); // Call wrapped function.
-}
-#endif
-
-
-#endif
-
-
 // ---------------------------------------------------------------------------
 // Conversion methods (rounds result to nearest cm or inch).
 // ---------------------------------------------------------------------------

NewPingESP8266.h

@@ -150,7 +150,6 @@
 #define ONE_PIN_ENABLED true    // Set to "false" to disable one pin mode which saves around 14-26 bytes of binary size. Default=true
 #define ROUNDING_ENABLED false  // Set to "true" to enable distance rounding which also adds 64 bytes to binary size. Default=false
 #define URM37_ENABLED false     // Set to "true" to enable support for the URM37 sensor in PWM mode. Default=false
-#define TIMER_ENABLED true      // Set to "false" to disable the timer ISR (if getting "__vector_7" compile errors set this to false). Default=true
 
 // Probably shouldn't change these values unless you really know what you're doing.
 #define NO_ECHO 0               // Value returned if there's no ping echo within the specified MAX_SENSOR_DISTANCE or max_cm_distance. Default=0
@@ -181,19 +180,11 @@
 	#define PING_OVERHEAD 1
 	#undef  PING_TIMER_OVERHEAD
 	#define PING_TIMER_OVERHEAD 1
-	#undef  TIMER_ENABLED
-	#define TIMER_ENABLED false
 	#define DO_BITWISE false
 #else
 	#define DO_BITWISE true
 #endif
 
-// Disable the timer interrupts when using ATmega128 and all ATtiny microcontrollers.
-#if defined (__AVR_ATmega128__) || defined (__AVR_ATtiny24__) || defined (__AVR_ATtiny44__) || defined (__AVR_ATtiny84__) || defined (__AVR_ATtiny25__) || defined (__AVR_ATtiny45__) || defined (__AVR_ATtiny85__) || defined (__AVR_ATtiny261__) || defined (__AVR_ATtiny461__) || defined (__AVR_ATtiny861__) || defined (__AVR_ATtiny43U__)
-	#undef  TIMER_ENABLED
-	#define TIMER_ENABLED false
-#endif
-
 // Define timers when using ATmega8, ATmega16, ATmega32 and ATmega8535 microcontrollers.
 #if defined (__AVR_ATmega8__) || defined (__AVR_ATmega16__) || defined (__AVR_ATmega32__) || defined (__AVR_ATmega8535__)
 	#define OCR2A OCR2
@@ -210,22 +201,10 @@ class NewPingESP8266 {
 		unsigned long ping_median(uint32_t it = 5, unsigned int max_cm_distance = 0);
 		static unsigned int convert_cm(unsigned int echoTime);
 		static unsigned int convert_in(unsigned int echoTime);
-#if TIMER_ENABLED == true
-		void ping_timer(void (*userFunc)(void), unsigned int max_cm_distance = 0);
-		boolean check_timer();
-		unsigned long ping_result;
-		static void timer_us(unsigned int frequency, void (*userFunc)(void));
-		static void timer_ms(unsigned long frequency, void (*userFunc)(void));
-		static void timer_stop();
 #endif
 	private:
 		boolean ping_trigger();
 		void set_max_distance(unsigned int max_cm_distance);
-#if TIMER_ENABLED == true
-		boolean ping_trigger_timer(unsigned int trigger_delay);
-		boolean ping_wait_timer();
-		static void timer_setup();
-		static void timer_ms_cntdwn();
 #endif
 #if DO_BITWISE == true
 		uint32_t _triggerBit;

examples/NewPingExample/NewPingExample.pde examples/NewPingESP8266Example/NewPingESP8266Example.pde

@@ -1,14 +1,14 @@
 // ---------------------------------------------------------------------------
-// Example NewPing library sketch that does a ping about 20 times per second.
+// Example NewPingESP8266 library sketch that does a ping about 20 times per second.
 // ---------------------------------------------------------------------------
 
-#include <NewPing.h>
+#include <NewPingESP8266.h>
 
 #define TRIGGER_PIN  12  // Arduino pin tied to trigger pin on the ultrasonic sensor.
 #define ECHO_PIN     11  // Arduino pin tied to echo pin on the ultrasonic sensor.
 #define MAX_DISTANCE 200 // Maximum distance we want to ping for (in centimeters). Maximum sensor distance is rated at 400-500cm.
 
-NewPing sonar(TRIGGER_PIN, ECHO_PIN, MAX_DISTANCE); // NewPing setup of pins and maximum distance.
+NewPingESP8266 sonar(TRIGGER_PIN, ECHO_PIN, MAX_DISTANCE); // NewPingESP8266 setup of pins and maximum distance.
 
 void setup() {
   Serial.begin(115200); // Open serial monitor at 115200 baud to see ping results.