diff --git a/docs/generated/docs/_react_e_s_p_8cpp.html b/docs/generated/docs/_react_e_s_p_8cpp.html new file mode 100644 index 0000000..c96b14f --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8cpp.html @@ -0,0 +1,182 @@ + + +
+ + + + +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
#include "ReactESP.h"
#include <Arduino.h>
#include <FunctionalInterrupt.h>
#include <string.h>
Go to the source code of this file.
++Functions | |
void | setup (void) |
void | loop (void) |
void loop | +( | +void | +) | ++ |
Definition at line 109 of file ReactESP.cpp.
+void setup | +( | +void | +) | ++ |
Definition at line 107 of file ReactESP.cpp.
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
#include <Arduino.h>
#include <forward_list>
#include <functional>
#include <queue>
Go to the source code of this file.
++Classes | |
class | Reaction |
Reactions are code to be called when a given condition is fulfilled. More... | |
class | TimedReaction |
TimedReactions are called based on elapsing of time. More... | |
struct | TriggerTimeCompare |
class | DelayReaction |
Reaction that is triggered after a certain time delay. More... | |
class | RepeatReaction |
Reaction that is triggered repeatedly. More... | |
class | UntimedReaction |
Reactions that are triggered based on something else than time. More... | |
class | StreamReaction |
Reaction that is triggered when there is input available at the given Arduino Stream. More... | |
class | TickReaction |
Reaction that is triggered unconditionally at each execution loop. More... | |
class | ISRReaction |
Reaction that is triggered on an input pin change. More... | |
class | ReactESP |
Main class of a ReactESP program. More... | |
+Typedefs | |
typedef std::function< void()> | react_callback |
typedef void(* | isr_react_callback) (void *) |
typedef void(* isr_react_callback) (void *) | +
Definition at line 11 of file ReactESP.h.
+ +typedef std::function<void()> react_callback | +
Definition at line 10 of file ReactESP.h.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
CDelayReaction | Reaction that is triggered after a certain time delay |
CISRReaction | Reaction that is triggered on an input pin change |
CReactESP | Main class of a ReactESP program |
CReaction | Reactions are code to be called when a given condition is fulfilled |
CRepeatReaction | Reaction that is triggered repeatedly |
CStreamReaction | Reaction that is triggered when there is input available at the given Arduino Stream |
CTickReaction | Reaction that is triggered unconditionally at each execution loop |
CTimedReaction | TimedReactions are called based on elapsing of time |
CTriggerTimeCompare | |
CUntimedReaction | Reactions that are triggered based on something else than time |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for DelayReaction, including all inherited members.
+add() | TimedReaction | virtual |
callback | Reaction | protected |
DelayReaction(const uint32_t delay, const react_callback callback) | DelayReaction | |
DelayReaction(const uint64_t delay, const react_callback callback) | DelayReaction | |
enabled | TimedReaction | protected |
getTriggerTime() | TimedReaction | inline |
getTriggerTimeMicros() | TimedReaction | inline |
interval | TimedReaction | protected |
isEnabled() | TimedReaction | inline |
last_trigger_time | TimedReaction | protected |
operator<(const TimedReaction &other) | TimedReaction | |
Reaction(react_callback callback) | Reaction | inline |
remove() | TimedReaction | virtual |
tick() | DelayReaction | virtual |
TimedReaction(const uint32_t interval, const react_callback callback) | TimedReaction | inline |
TimedReaction(const uint64_t interval, const react_callback callback) | TimedReaction | inline |
~DelayReaction() | DelayReaction | inlinevirtual |
~TimedReaction() | TimedReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reaction that is triggered after a certain time delay. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
DelayReaction (const uint32_t delay, const react_callback callback) | |
Construct a new Delay Reaction object. More... | |
DelayReaction (const uint64_t delay, const react_callback callback) | |
Construct a new Delay Reaction object. More... | |
virtual | ~DelayReaction () |
void | tick () |
![]() | |
TimedReaction (const uint32_t interval, const react_callback callback) | |
Construct a new Timed Reaction object. More... | |
TimedReaction (const uint64_t interval, const react_callback callback) | |
Construct a new Timed Reaction object. More... | |
virtual | ~TimedReaction () |
bool | operator< (const TimedReaction &other) |
Return the current time since the device restart in microseconds. More... | |
void | add () |
void | remove () |
uint32_t | getTriggerTime () |
uint64_t | getTriggerTimeMicros () |
bool | isEnabled () |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Additional Inherited Members | |
![]() | |
const uint64_t | interval |
uint64_t | last_trigger_time |
bool | enabled |
![]() | |
const react_callback | callback |
Reaction that is triggered after a certain time delay.
+ +Definition at line 92 of file ReactESP.h.
+DelayReaction::DelayReaction | +( | +const uint32_t | +delay, | +
+ | + | const react_callback | +callback | +
+ | ) | ++ |
Construct a new Delay Reaction object.
+delay | Delay, in milliseconds |
callback | Function to be called after the delay |
Definition at line 34 of file ReactESP.cpp.
+ +DelayReaction::DelayReaction | +( | +const uint64_t | +delay, | +
+ | + | const react_callback | +callback | +
+ | ) | ++ |
Construct a new Delay Reaction object.
+delay | Delay, in microseconds |
callback | Function to be called after the delay |
Definition at line 39 of file ReactESP.cpp.
+ +
+
|
+ +inlinevirtual | +
Definition at line 108 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements TimedReaction.
+ +Definition at line 44 of file ReactESP.cpp.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for ISRReaction, including all inherited members.
+add() | ISRReaction | virtual |
callback | Reaction | protected |
ISRReaction(uint8_t pin_number, int mode, const react_callback callback) | ISRReaction | inline |
Reaction(react_callback callback) | Reaction | inline |
remove() | ISRReaction | virtual |
tick() | ISRReaction | inlinevirtual |
~ISRReaction() | ISRReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reaction that is triggered on an input pin change. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
ISRReaction (uint8_t pin_number, int mode, const react_callback callback) | |
Construct a new ISRReaction object. More... | |
virtual | ~ISRReaction () |
void | add () |
void | remove () |
void | tick () |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Additional Inherited Members | |
![]() | |
const react_callback | callback |
Reaction that is triggered on an input pin change.
+ +Definition at line 185 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new ISRReaction object.
+pin_number | GPIO pin number to which the interrupt is attached |
mode | Interrupt mode. One of RISING, FALLING, CHANGE |
callback | Interrupt callback. Keep this function short and add the ICACHE_RAM_ATTR attribute. |
Definition at line 204 of file ReactESP.h.
+ +
+
|
+ +inlinevirtual | +
Definition at line 233 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements Reaction.
+ +Definition at line 85 of file ReactESP.cpp.
+
+
|
+ +virtual | +
Implements Reaction.
+ +Definition at line 94 of file ReactESP.cpp.
+ +
+
|
+ +inlinevirtual | +
Implements Reaction.
+ +Definition at line 236 of file ReactESP.h.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for ReactESP, including all inherited members.
+app | ReactESP | static |
ISRReaction class | ReactESP | friend |
onAvailable(Stream &stream, const react_callback cb) | ReactESP | |
onDelay(const uint32_t t, const react_callback cb) | ReactESP | |
onDelayMicros(const uint64_t t, const react_callback cb) | ReactESP | |
onInterrupt(const uint8_t pin_number, int mode, const react_callback cb) | ReactESP | |
onRepeat(const uint32_t t, const react_callback cb) | ReactESP | |
onRepeatMicros(const uint64_t t, const react_callback cb) | ReactESP | |
onTick(const react_callback cb) | ReactESP | |
ReactESP(const react_callback cb) | ReactESP | inline |
Reaction class | ReactESP | friend |
RepeatReaction class | ReactESP | friend |
setup(void) | ReactESP | inline |
tick(void) | ReactESP | |
TimedReaction class | ReactESP | friend |
UntimedReaction class | ReactESP | friend |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Main class of a ReactESP program. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
ReactESP (const react_callback cb) | |
Construct a new ReactESP object. More... | |
void | setup (void) |
void | tick (void) |
DelayReaction * | onDelay (const uint32_t t, const react_callback cb) |
Create a new DelayReaction. More... | |
DelayReaction * | onDelayMicros (const uint64_t t, const react_callback cb) |
Create a new DelayReaction. More... | |
RepeatReaction * | onRepeat (const uint32_t t, const react_callback cb) |
Create a new RepeatReaction. More... | |
RepeatReaction * | onRepeatMicros (const uint64_t t, const react_callback cb) |
Create a new RepeatReaction. More... | |
StreamReaction * | onAvailable (Stream &stream, const react_callback cb) |
Create a new StreamReaction. More... | |
ISRReaction * | onInterrupt (const uint8_t pin_number, int mode, const react_callback cb) |
Create a new ISRReaction (interrupt reaction) More... | |
TickReaction * | onTick (const react_callback cb) |
Create a new TickReaction. More... | |
+Static Public Attributes | |
static ReactESP * | app = NULL |
Static singleton reference to the instantiated ReactESP object. More... | |
+Friends | |
class | Reaction |
class | TimedReaction |
class | RepeatReaction |
class | UntimedReaction |
class | ISRReaction |
Main class of a ReactESP program.
+ +Definition at line 245 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new ReactESP object.
+cb | Setup function to be called. This is equivalent to the regular Arduino setup() function and should perform any initial setup the program requires. |
Definition at line 260 of file ReactESP.h.
+ +StreamReaction * ReactESP::onAvailable | +( | +Stream & | +stream, | +
+ | + | const react_callback | +cb | +
+ | ) | ++ |
Create a new StreamReaction.
+stream | Arduino Stream object to monitor |
cb | Callback function |
Definition at line 176 of file ReactESP.cpp.
+DelayReaction * ReactESP::onDelay | +( | +const uint32_t | +t, | +
+ | + | const react_callback | +cb | +
+ | ) | ++ |
Create a new DelayReaction.
+t | Delay, in milliseconds |
cb | Callback function |
Definition at line 150 of file ReactESP.cpp.
+DelayReaction * ReactESP::onDelayMicros | +( | +const uint64_t | +t, | +
+ | + | const react_callback | +cb | +
+ | ) | ++ |
Create a new DelayReaction.
+t | Delay, in microseconds |
cb | Callback function |
Definition at line 156 of file ReactESP.cpp.
+ISRReaction * ReactESP::onInterrupt | +( | +const uint8_t | +pin_number, | +
+ | + | int | +mode, | +
+ | + | const react_callback | +cb | +
+ | ) | ++ |
Create a new ISRReaction (interrupt reaction)
+pin_number | GPIO pin number |
mode | One of CHANGE, RISING, FALLING |
cb | Interrupt handler to call. This should be a very simple function, ideally setting a flag variable or incrementing a counter. The function should be defined with ICACHE_RAM_ATTR. |
Definition at line 182 of file ReactESP.cpp.
+RepeatReaction * ReactESP::onRepeat | +( | +const uint32_t | +t, | +
+ | + | const react_callback | +cb | +
+ | ) | ++ |
Create a new RepeatReaction.
+t | Interval, in milliseconds |
cb | Callback function |
Definition at line 163 of file ReactESP.cpp.
+RepeatReaction * ReactESP::onRepeatMicros | +( | +const uint64_t | +t, | +
+ | + | const react_callback | +cb | +
+ | ) | ++ |
Create a new RepeatReaction.
+t | Interval, in microseconds |
cb | Callback function |
Definition at line 169 of file ReactESP.cpp.
+TickReaction * ReactESP::onTick | +( | +const react_callback | +cb | ) | ++ |
Create a new TickReaction.
+cb | Callback function to be called at every loop execution |
Definition at line 189 of file ReactESP.cpp.
+
+
|
+ +inline | +
Definition at line 261 of file ReactESP.h.
+void ReactESP::tick | +( | +void | +) | ++ |
Definition at line 145 of file ReactESP.cpp.
+
+
|
+ +friend | +
Definition at line 250 of file ReactESP.h.
+ +
+
|
+ +friend | +
Definition at line 246 of file ReactESP.h.
+ +
+
|
+ +friend | +
Definition at line 248 of file ReactESP.h.
+ +
+
|
+ +friend | +
Definition at line 247 of file ReactESP.h.
+ +
+
|
+ +friend | +
Definition at line 249 of file ReactESP.h.
+ +
+
|
+ +static | +
Static singleton reference to the instantiated ReactESP object.
+ +Definition at line 265 of file ReactESP.h.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reactions are code to be called when a given condition is fulfilled. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
virtual void | add ()=0 |
virtual void | remove ()=0 |
virtual void | tick ()=0 |
+Protected Attributes | |
const react_callback | callback |
Reactions are code to be called when a given condition is fulfilled.
+ +Definition at line 25 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new Reaction object.
+callback | Function to be called when the reaction is triggered |
Definition at line 35 of file ReactESP.h.
+ +
+
|
+ +pure virtual | +
Implemented in ISRReaction, UntimedReaction, and TimedReaction.
+ +
+
|
+ +pure virtual | +
Implemented in ISRReaction, UntimedReaction, and TimedReaction.
+ +
+
|
+ +pure virtual | +
Implemented in UntimedReaction, TimedReaction, ISRReaction, TickReaction, StreamReaction, RepeatReaction, and DelayReaction.
+ +
+
|
+ +protected | +
Definition at line 27 of file ReactESP.h.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for RepeatReaction, including all inherited members.
+add() | TimedReaction | virtual |
callback | Reaction | protected |
enabled | TimedReaction | protected |
getTriggerTime() | TimedReaction | inline |
getTriggerTimeMicros() | TimedReaction | inline |
interval | TimedReaction | protected |
isEnabled() | TimedReaction | inline |
last_trigger_time | TimedReaction | protected |
operator<(const TimedReaction &other) | TimedReaction | |
Reaction(react_callback callback) | Reaction | inline |
remove() | TimedReaction | virtual |
RepeatReaction(const uint32_t interval, const react_callback callback) | RepeatReaction | inline |
RepeatReaction(const uint64_t interval, const react_callback callback) | RepeatReaction | inline |
tick() | RepeatReaction | virtual |
TimedReaction(const uint32_t interval, const react_callback callback) | TimedReaction | inline |
TimedReaction(const uint64_t interval, const react_callback callback) | TimedReaction | inline |
~TimedReaction() | TimedReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reaction that is triggered repeatedly. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
RepeatReaction (const uint32_t interval, const react_callback callback) | |
Construct a new Repeat Reaction object. More... | |
RepeatReaction (const uint64_t interval, const react_callback callback) | |
Construct a new Repeat Reaction object. More... | |
void | tick () |
![]() | |
TimedReaction (const uint32_t interval, const react_callback callback) | |
Construct a new Timed Reaction object. More... | |
TimedReaction (const uint64_t interval, const react_callback callback) | |
Construct a new Timed Reaction object. More... | |
virtual | ~TimedReaction () |
bool | operator< (const TimedReaction &other) |
Return the current time since the device restart in microseconds. More... | |
void | add () |
void | remove () |
uint32_t | getTriggerTime () |
uint64_t | getTriggerTimeMicros () |
bool | isEnabled () |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Additional Inherited Members | |
![]() | |
const uint64_t | interval |
uint64_t | last_trigger_time |
bool | enabled |
![]() | |
const react_callback | callback |
Reaction that is triggered repeatedly.
+ +Definition at line 115 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new Repeat Reaction object.
+interval | Repetition interval, in milliseconds |
callback | Function to be called at every repetition |
Definition at line 123 of file ReactESP.h.
+ +
+
|
+ +inline | +
Construct a new Repeat Reaction object.
+interval | Repetition interval, in microseconds |
callback | Function to be called at every repetition |
Definition at line 131 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements TimedReaction.
+ +Definition at line 50 of file ReactESP.cpp.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for StreamReaction, including all inherited members.
+add() | UntimedReaction | virtual |
callback | Reaction | protected |
Reaction(react_callback callback) | Reaction | inline |
remove() | UntimedReaction | virtual |
StreamReaction(Stream &stream, const react_callback callback) | StreamReaction | inline |
tick() | StreamReaction | virtual |
UntimedReaction(const react_callback callback) | UntimedReaction | inline |
~UntimedReaction() | UntimedReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reaction that is triggered when there is input available at the given Arduino Stream. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
StreamReaction (Stream &stream, const react_callback callback) | |
Construct a new Stream Reaction object. More... | |
void | tick () |
![]() | |
UntimedReaction (const react_callback callback) | |
virtual | ~UntimedReaction () |
virtual void | add () |
virtual void | remove () |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Additional Inherited Members | |
![]() | |
const react_callback | callback |
Reaction that is triggered when there is input available at the given Arduino Stream.
+ +Definition at line 152 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new Stream Reaction object.
+stream | Stream to monitor |
callback | Callback to call for new input |
Definition at line 163 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements UntimedReaction.
+ +Definition at line 68 of file ReactESP.cpp.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for TickReaction, including all inherited members.
+add() | UntimedReaction | virtual |
callback | Reaction | protected |
Reaction(react_callback callback) | Reaction | inline |
remove() | UntimedReaction | virtual |
tick() | TickReaction | virtual |
TickReaction(const react_callback callback) | TickReaction | inline |
UntimedReaction(const react_callback callback) | UntimedReaction | inline |
~UntimedReaction() | UntimedReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reaction that is triggered unconditionally at each execution loop. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
TickReaction (const react_callback callback) | |
Construct a new Tick Reaction object. More... | |
void | tick () |
![]() | |
UntimedReaction (const react_callback callback) | |
virtual | ~UntimedReaction () |
virtual void | add () |
virtual void | remove () |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Additional Inherited Members | |
![]() | |
const react_callback | callback |
Reaction that is triggered unconditionally at each execution loop.
+ +Definition at line 171 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new Tick Reaction object.
+callback | Function to be called at each execution loop |
Definition at line 178 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements UntimedReaction.
+ +Definition at line 74 of file ReactESP.cpp.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for TimedReaction, including all inherited members.
+add() | TimedReaction | virtual |
callback | Reaction | protected |
enabled | TimedReaction | protected |
getTriggerTime() | TimedReaction | inline |
getTriggerTimeMicros() | TimedReaction | inline |
interval | TimedReaction | protected |
isEnabled() | TimedReaction | inline |
last_trigger_time | TimedReaction | protected |
operator<(const TimedReaction &other) | TimedReaction | |
Reaction(react_callback callback) | Reaction | inline |
remove() | TimedReaction | virtual |
tick()=0 | TimedReaction | pure virtual |
TimedReaction(const uint32_t interval, const react_callback callback) | TimedReaction | inline |
TimedReaction(const uint64_t interval, const react_callback callback) | TimedReaction | inline |
~TimedReaction() | TimedReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
TimedReactions are called based on elapsing of time. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
TimedReaction (const uint32_t interval, const react_callback callback) | |
Construct a new Timed Reaction object. More... | |
TimedReaction (const uint64_t interval, const react_callback callback) | |
Construct a new Timed Reaction object. More... | |
virtual | ~TimedReaction () |
bool | operator< (const TimedReaction &other) |
Return the current time since the device restart in microseconds. More... | |
void | add () |
void | remove () |
uint32_t | getTriggerTime () |
uint64_t | getTriggerTimeMicros () |
bool | isEnabled () |
virtual void | tick ()=0 |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Protected Attributes | |
const uint64_t | interval |
uint64_t | last_trigger_time |
bool | enabled |
![]() | |
const react_callback | callback |
TimedReactions are called based on elapsing of time.
+ +Definition at line 45 of file ReactESP.h.
+
+
|
+ +inline | +
Construct a new Timed Reaction object.
+interval | Interval or delay for the reaction, in milliseconds |
callback | Function to be called when the reaction is triggered |
Definition at line 58 of file ReactESP.h.
+ +
+
|
+ +inline | +
Construct a new Timed Reaction object.
+interval | Interval, in microseconds |
callback | Function to be called when the reaction is triggered |
Definition at line 69 of file ReactESP.h.
+ +
+
|
+ +inlinevirtual | +
Definition at line 75 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements Reaction.
+ +Definition at line 26 of file ReactESP.cpp.
+
+
|
+ +inline | +
Definition at line 79 of file ReactESP.h.
+ +
+
|
+ +inline | +
Definition at line 80 of file ReactESP.h.
+ +
+
|
+ +inline | +
Definition at line 81 of file ReactESP.h.
+ +bool TimedReaction::operator< | +( | +const TimedReaction & | +other | ) | ++ |
Return the current time since the device restart in microseconds.
+Returns the time since the device restart. Even though the time is in microseconds, a 64-bit integer is all but guaranteed not to rewrap, ever.
+ +Definition at line 21 of file ReactESP.cpp.
+ +
+
|
+ +virtual | +
Implements Reaction.
+ +Definition at line 28 of file ReactESP.cpp.
+ +
+
|
+ +pure virtual | +
Implements Reaction.
+ +Implemented in RepeatReaction, and DelayReaction.
+ +
+
|
+ +protected | +
Definition at line 49 of file ReactESP.h.
+ +
+
|
+ +protected | +
Definition at line 47 of file ReactESP.h.
+ +
+
|
+ +protected | +
Definition at line 48 of file ReactESP.h.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This is the complete list of members for UntimedReaction, including all inherited members.
+add() | UntimedReaction | virtual |
callback | Reaction | protected |
Reaction(react_callback callback) | Reaction | inline |
remove() | UntimedReaction | virtual |
tick()=0 | UntimedReaction | pure virtual |
UntimedReaction(const react_callback callback) | UntimedReaction | inline |
~UntimedReaction() | UntimedReaction | inlinevirtual |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Reactions that are triggered based on something else than time. + More...
+ +#include <ReactESP.h>
+Public Member Functions | |
UntimedReaction (const react_callback callback) | |
virtual | ~UntimedReaction () |
virtual void | add () |
virtual void | remove () |
virtual void | tick ()=0 |
![]() | |
Reaction (react_callback callback) | |
Construct a new Reaction object. More... | |
+Additional Inherited Members | |
![]() | |
const react_callback | callback |
Reactions that are triggered based on something else than time.
+ +Definition at line 139 of file ReactESP.h.
+
+
|
+ +inline | +
Definition at line 141 of file ReactESP.h.
+ +
+
|
+ +inlinevirtual | +
Definition at line 142 of file ReactESP.h.
+ +
+
|
+ +virtual | +
Implements Reaction.
+ +Definition at line 61 of file ReactESP.cpp.
+
+
|
+ +virtual | +
Implements Reaction.
+ +Definition at line 63 of file ReactESP.cpp.
+ +
+
|
+ +pure virtual | +
Implements Reaction.
+ +Implemented in TickReaction, and StreamReaction.
+ +
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+Files | |
file | main.cpp [code] |
file | ReactESP.cpp [code] |
file | ReactESP.h [code] |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
▼ src | |
main.cpp | |
ReactESP.cpp | |
ReactESP.h |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
CReactESP | Main class of a ReactESP program |
▼CReaction | Reactions are code to be called when a given condition is fulfilled |
CISRReaction | Reaction that is triggered on an input pin change |
▼CTimedReaction | TimedReactions are called based on elapsing of time |
CDelayReaction | Reaction that is triggered after a certain time delay |
CRepeatReaction | Reaction that is triggered repeatedly |
▼CUntimedReaction | Reactions that are triggered based on something else than time |
CStreamReaction | Reaction that is triggered when there is input available at the given Arduino Stream |
CTickReaction | Reaction that is triggered unconditionally at each execution loop |
CTriggerTimeCompare |
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
+ ReactESP
+ 0.3.1
+
+ Asynchronous programming for the ESP microcontrollers
+ |
+
Go to the source code of this file.
++Macros | |
#define | IO_REPEAT_DELAY 200 |
+Functions | |
void ICACHE_RAM_ATTR | isr () |
+Variables | |
volatile int | ticks = 0 |
ReactESP | app ([]() { Serial.begin(115200);pinMode(LED_PIN, OUTPUT);pinMode(INPUT_PIN, INPUT_PULLUP);app.onRepeatMicros(IO_REPEAT_DELAY, []() { static bool state=false;digitalWrite(LED_PIN, state);state=!state;});app.onInterrupt(INPUT_PIN, RISING, &isr);app.onRepeat(1000, []() { uint64_t now=micros64();uint32_t now_high=now >> 32;uint32_t now_low=now &0xffffffff;Serial.printf("Ticks: %d %08X %08X\n", ticks, now_high, now_low);ticks=0;});pinMode(OUTPUT_PIN, OUTPUT);app.onRepeat(20, []() { digitalWrite(OUTPUT_PIN, !digitalRead(OUTPUT_PIN));});Serial.println("First");Serial.println("Second");}) |
void ICACHE_RAM_ATTR isr | +( | +) | ++ |
ReactESP app([]() { Serial.begin(115200);pinMode(LED_PIN, OUTPUT);pinMode(INPUT_PIN, INPUT_PULLUP);app.onRepeatMicros(IO_REPEAT_DELAY,[]() { static bool state=false; digitalWrite(LED_PIN, state); state=!state; }); app.onInterrupt(INPUT_PIN, RISING, &isr);app.onRepeat(1000,[]() { uint64_t now=micros64(); uint32_t now_high=now >> 32; uint32_t now_low=now &0xffffffff; Serial.printf("Ticks: %d %08X %08X\n", ticks, now_high, now_low); ticks=0; });pinMode(OUTPUT_PIN, OUTPUT);app.onRepeat(20,[]() { digitalWrite(OUTPUT_PIN, !digitalRead(OUTPUT_PIN)); });Serial.println("First");Serial.println("Second");}) | +( | +[] () { Serial.begin(115200);pinMode(LED_PIN, OUTPUT);pinMode(INPUT_PIN, INPUT_PULLUP);app.onRepeatMicros(IO_REPEAT_DELAY, []() { static bool state=false;digitalWrite(LED_PIN, state);state=!state;});app.onInterrupt(INPUT_PIN, RISING, &isr);app.onRepeat(1000, []() { uint64_t now=micros64();uint32_t now_high=now >> 32;uint32_t now_low=now &0xffffffff;Serial.printf("Ticks: %d %08X %08X\n", ticks, now_high, now_low);ticks=0;});pinMode(OUTPUT_PIN, OUTPUT);app.onRepeat(20, []() { digitalWrite(OUTPUT_PIN, !digitalRead(OUTPUT_PIN));});Serial.println("First");Serial.println("Second");} | +) | ++ |