Update samples to use improved timer API and add timers module to HostTests

Author: mikee47

docs/source/information/timers.rst

@@ -146,6 +146,10 @@ range 10 - 10000 microseconds (or whichever time unit you've selected). It doesn
 code to the application. If the code compiles, then you can be confident that the timer
 will function as expected and you don't need to check return values.
 
+You can see these checks in action in the :sample:`LiveDebug` sample, which uses the HardwareTimer
+with a /16 prescaler. If you change *BLINK_INTERVAL_MS* to 2000 then the code will not compile.
+
+
 Clocks
 ------
 

samples/HttpServer_WebSockets/app/application.cpp

@@ -55,13 +55,13 @@ void wsMessageReceived(WebsocketConnection& socket, const String& message)
 
 		// Don't shutdown immediately, wait a bit to allow messages to propagate
 		auto timer = new SimpleTimer;
-		timer->setCallback(
+		timer->initializeMs<1000>(
 			[](void* timer) {
 				delete static_cast<SimpleTimer*>(timer);
 				server.shutdown();
 			},
 			timer);
-		timer->startMs(1000);
+		timer->startOnce();
 		return;
 	}
 

samples/LiveDebug/app/application.cpp

@@ -17,19 +17,27 @@ const unsigned MAX_COMMAND_LENGTH = 64;
 /*
  * This example uses the hardware timer for best timing accuracy. There is only one of these on the ESP8266,
  * so it may not be available if another module requires it.
- * Most timing applications can use a SimpleTimer, which is good for intervals of up to about 268 seconds.
- * For longer intervals, use a Timer.
+ *
+ * Most software timing applications can use a `SimpleTimer`, which is good for intervals of up to about
+ * 429 seconds, or around 2 hours if you compile with USE_US_TIMER=0.
+ *
+ * For longer intervals and delegate callback support use a `Timer`.
  */
 #define TIMER_TYPE TIMERTYPE_HARDWARE
 
+/*
+ * We use the timer to blink the LED at this rate
+ */
+#define BLINK_INTERVAL_MS 1000
+
 /*
  * HardwareTimer defaults to non-maskable mode, so the timer callback cannot be interrupted even by the
  * debugger. To use break/watchpoints we must set the timer to use maskable mode.
  */
 #define HWTIMER_TYPE eHWT_Maskable
 
 #if TIMER_TYPE == TIMERTYPE_HARDWARE
-HardwareTimer procTimer(HWTIMER_TYPE);
+HardwareTimer1<TIMER_CLKDIV_16, HWTIMER_TYPE> procTimer;
 // Hardware timer callbacks must always be in IRAM
 #define CALLBACK_ATTR IRAM_ATTR
 #elif TIMER_TYPE == TIMERTYPE_SIMPLE
@@ -660,6 +668,16 @@ extern "C" void gdb_on_attach(bool attached)
 	}
 }
 
+static void printTimerDetails()
+{
+	Serial.print(procTimer);
+	Serial.print(", maxTicks = ");
+	Serial.print(procTimer.maxTicks());
+	Serial.print(", maxTime = ");
+	Serial.print(procTimer.micros().ticksToTime(procTimer.maxTicks()).value());
+	Serial.println();
+}
+
 void GDB_IRAM_ATTR init()
 {
 	Serial.begin(SERIAL_BAUD_RATE);
@@ -677,10 +695,7 @@ void GDB_IRAM_ATTR init()
 	}
 
 	pinMode(LED_PIN, OUTPUT);
-#if TIMER_TYPE == TIMERTYPE_SIMPLE
-	procTimer.setCallback(SimpleTimerCallback(blink));
-	procTimer.startMs(1000, true);
-#else
-	procTimer.initializeMs(1000, blink).start();
-#endif
+	procTimer.initializeMs<BLINK_INTERVAL_MS>(blink).start();
+
+	printTimerDetails();
 }

samples/LiveDebug/component.mk

@@ -7,11 +7,18 @@ ENABLE_GDB_CONSOLE ?= 1
 ifeq ($(ENABLE_GDB_CONSOLE), 1)
 USER_CFLAGS := -DGDBSTUB_ENABLE_SYSCALL
 
-all:
+App-build: gdb-console-warning 
+
+.PHONY: gdb-console-warning
+gdb-console-warning:
 	$(warning WARNING! Enabling the GDB console may interfere with visual debuggers, like eclipse)
 	$(warning If required, please build with `make ENABLE_GDB_CONSOLE=0`)
 endif
 
 
 # Emulate UART 0
 ENABLE_HOST_UARTID := 0
+
+# Sample doesn't use network so don't bother initialising it
+# Also add a short delay so telnet client has time to start before we start printing stuff
+HOST_NETWORK_OPTIONS = --nonet --pause=1

samples/Wifi_Sniffer/app/application.cpp

@@ -11,11 +11,6 @@ const unsigned scanTimeoutMs = 2000; ///< End scan on channel if no new devices
 WifiSniffer sniffer;
 SimpleTimer timer;
 
-static void restartTimer()
-{
-	timer.startMs(scanTimeoutMs, false);
-}
-
 static void printBeacon(const BeaconInfo& beacon)
 {
 	if(beacon.err != 0) {
@@ -68,7 +63,7 @@ static void onBeacon(const BeaconInfo& beacon)
 	if(knownAPs.indexOf(beacon.bssid) < 0) {
 		knownAPs.add(beacon);
 		printBeacon(beacon);
-		restartTimer();
+		timer.restart();
 	}
 }
 
@@ -77,7 +72,7 @@ static void onClient(const ClientInfo& client)
 	if(knownClients.indexOf(client.station) < 0) {
 		knownClients.add(client);
 		printClient(client);
-		restartTimer();
+		timer.restart();
 	}
 }
 
@@ -88,8 +83,8 @@ static void scanChannel(void* param)
 		// Scan the next channel
 		debugf("Set channel: %u", channel);
 		sniffer.setChannel(channel);
-		timer.setCallback(scanChannel, reinterpret_cast<void*>(channel + 1));
-		restartTimer();
+		timer.initializeMs<scanTimeoutMs>(scanChannel, reinterpret_cast<void*>(channel + 1));
+		timer.startOnce();
 	} else {
 		// Stop sniffing and display final scan results
 		sniffer.end();

tests/HostTests/app/application.cpp

@@ -14,7 +14,7 @@
 #include <malloc_count.h>
 
 Vector<TestGroupFactory> groupFactories;
-static Timer taskTimer;
+static SimpleTimer taskTimer;
 static unsigned taskIndex;
 
 #define XX(t) extern void REGISTER_TEST(t);
@@ -36,7 +36,7 @@ static void runNextGroup()
 		System.restart();
 #else
 		taskIndex = 0;
-		taskTimer.setIntervalMs(RESTART_DELAY);
+		taskTimer.setIntervalMs<RESTART_DELAY>();
 		taskTimer.startOnce();
 #endif
 	} else {
@@ -68,7 +68,7 @@ void TestGroup::complete()
 		m_printf(_F("\r\n** Test Group '%s' OK **\r\n"), name.c_str());
 	}
 	delete this;
-	taskTimer.setIntervalMs(TEST_GROUP_INTERVAL);
+	taskTimer.setIntervalMs<TEST_GROUP_INTERVAL>();
 	taskTimer.startOnce();
 }
 

tests/HostTests/app/modules.h

@@ -5,4 +5,5 @@
 	XX(json6)                                                                                                          \
 	XX(files)                                                                                                          \
 	XX(rational)                                                                                                       \
-	XX(clocks)
+	XX(clocks)                                                                                                         \
+	XX(timers)