Merge branch 'ticker_api'

Author: dok-net

libraries/Ticker/examples/Arguments/Arguments.ino

@@ -23,8 +23,7 @@ void toggle() {
   if (isBlinking) {
     blinker.detach();
     isBlinking = false;
-  }
-  else {
+  } else {
     blinker.attach(blinkerPace, blink);
     isBlinking = true;
   }
@@ -38,5 +37,5 @@ void setup() {
 }
 
 void loop() {
-  
+
 }

libraries/Ticker/examples/Blinker/Blinker.ino

@@ -0,0 +1,49 @@
+/*
+  Basic Ticker usage
+
+  Ticker is an object that will call a given function with a certain period.
+  Each Ticker calls one function. You can have as many Tickers as you like,
+  memory being the only limitation.
+
+  A function may be attached to a ticker and detached from the ticker.
+  There are two variants of the attach function: attach and attach_ms.
+  The first one takes period in seconds, the second one in milliseconds.
+
+  The built-in LED will be blinking.
+*/
+
+#include <Ticker.h>
+
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 13
+#endif
+
+Ticker flipper;
+
+int count = 0;
+
+void flip() {
+  int state = digitalRead(LED_BUILTIN);  // get the current state of GPIO1 pin
+  digitalWrite(LED_BUILTIN, !state);     // set pin to the opposite state
+
+  ++count;
+  // when the counter reaches a certain value, start blinking like crazy
+  if (count == 20) {
+    flipper.attach(0.1, flip);
+  }
+  // when the counter reaches yet another value, stop blinking
+  else if (count == 120) {
+    flipper.detach();
+  }
+}
+
+void setup() {
+  pinMode(LED_BUILTIN, OUTPUT);
+  digitalWrite(LED_BUILTIN, LOW);
+
+  // flip the pin every 0.3s
+  flipper.attach(0.3, flip);
+}
+
+void loop() {
+}

libraries/Ticker/examples/TickerBasic/TickerBasic.ino

@@ -0,0 +1,39 @@
+/*
+  Passing paramters to Ticker callbacks
+
+  Apart from void(void) functions, the Ticker library supports
+  functions taking one argument. This argument's size has to be less or
+  equal to 4 bytes (so char, short, int, float, void*, char* types will do).
+
+  This sample runs two tickers that both call one callback function,
+  but with different arguments.
+
+  The built-in LED will be pulsing.
+*/
+
+#include <Ticker.h>
+
+#ifndef LED_BUILTIN
+#define LED_BUILTIN 13
+#endif
+
+Ticker tickerSetHigh;
+Ticker tickerSetLow;
+
+void setPin(int state) {
+  digitalWrite(LED_BUILTIN, state);
+}
+
+void setup() {
+  pinMode(LED_BUILTIN, OUTPUT);
+  digitalWrite(1, LOW);
+
+  // every 25 ms, call setPin(0)
+  tickerSetLow.attach_ms(25, setPin, 0);
+
+  // every 26 ms, call setPin(1)
+  tickerSetHigh.attach_ms(26, setPin, 1);
+}
+
+void loop() {
+}

libraries/Ticker/examples/TickerParameter/TickerParameter.ino

@@ -8,7 +8,14 @@ Ticker	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
+attach_scheduled	KEYWORD2
 attach	KEYWORD2
+attach_ms_scheduled	KEYWORD2
 attach_ms	KEYWORD2
+once_scheduled	KEYWORD2
 once	KEYWORD2
+once_ms_scheduled	KEYWORD2
+once_ms	KEYWORD2
 detach	KEYWORD2
+active	KEYWORD2
+

libraries/Ticker/keywords.txt

@@ -1,8 +1,8 @@
-/* 
+/*
   Ticker.cpp - esp32 library that calls functions periodically
 
   Copyright (c) 2017 Bert Melis. All rights reserved.
-  
+
   Based on the original work of:
   Copyright (c) 2014 Ivan Grokhotkov. All rights reserved.
   The original version is part of the esp8266 core for Arduino environment.
@@ -24,35 +24,63 @@
 
 #include "Ticker.h"
 
-Ticker::Ticker() :
-  _timer(nullptr) {}
+Ticker::Ticker()
+	: _timer(nullptr)
+{
+}
+
+Ticker::~Ticker()
+{
+	detach();
+}
+
+void Ticker::_attach_s(float seconds, bool repeat, callback_with_arg_t callback, void* arg)
+{
+	_attach_us(1000000 * seconds, repeat, callback, arg);
+}
 
-Ticker::~Ticker() {
-  detach();
+void Ticker::_attach_ms(uint32_t milliseconds, bool repeat, callback_with_arg_t callback, void* arg)
+{
+	_attach_us(1000 * milliseconds, repeat, callback, arg);
 }
 
-void Ticker::_attach_ms(uint32_t milliseconds, bool repeat, callback_with_arg_t callback, uint32_t arg) {
-  esp_timer_create_args_t _timerConfig;
-  _timerConfig.arg = reinterpret_cast<void*>(arg);
-  _timerConfig.callback = callback;
-  _timerConfig.dispatch_method = ESP_TIMER_TASK;
-  _timerConfig.name = "Ticker";
-  if (_timer) {
-    esp_timer_stop(_timer);
-    esp_timer_delete(_timer);
-  }
-  esp_timer_create(&_timerConfig, &_timer);
-  if (repeat) {
-    esp_timer_start_periodic(_timer, milliseconds * 1000);
-  } else {
-    esp_timer_start_once(_timer, milliseconds * 1000);
-  }
+void Ticker::_attach_us(uint32_t micros, bool repeat, callback_with_arg_t callback, void* arg)
+{
+	esp_timer_create_args_t _timerConfig;
+	_timerConfig.arg = reinterpret_cast<void*>(arg);
+	_timerConfig.callback = callback;
+	_timerConfig.dispatch_method = ESP_TIMER_TASK;
+	_timerConfig.name = "Ticker";
+	if (_timer) {
+		esp_timer_stop(_timer);
+		esp_timer_delete(_timer);
+	}
+	esp_timer_create(&_timerConfig, &_timer);
+	if (repeat) {
+		esp_timer_start_periodic(_timer, micros);
+	}
+	else {
+		esp_timer_start_once(_timer, micros);
+	}
 }
 
 void Ticker::detach() {
-  if (_timer) {
-    esp_timer_stop(_timer);
-    esp_timer_delete(_timer);
-    _timer = nullptr;
-  }
+	if (_timer) {
+		esp_timer_stop(_timer);
+		esp_timer_delete(_timer);
+		_timer = nullptr;
+		_callback_function = nullptr;
+	}
+}
+
+bool Ticker::active() const
+{
+	return _timer;
+}
+
+void Ticker::_static_callback(void* arg)
+{
+	Ticker* _this = reinterpret_cast<Ticker*>(arg);
+	if (_this && _this->_callback_function)
+		_this->_callback_function();
 }