From 32c983b92d48ead583ce69c1c3d5e1c23b4c5ec2 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 6 Nov 2021 16:24:20 +0200 Subject: [PATCH 01/18] Bump version to 1.0.1-alpha --- Doxyfile | 2 +- library.json | 2 +- library.properties | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Doxyfile b/Doxyfile index e4514d4..d3704af 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = ReactESP # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.0.0 +PROJECT_NUMBER = 1.0.1-alpha # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/library.json b/library.json index 97c1d64..595aed5 100644 --- a/library.json +++ b/library.json @@ -23,7 +23,7 @@ } ], "dependencies": [], - "version": "1.0.0", + "version": "1.0.1-alpha", "frameworks": "arduino", "platforms": "*" } diff --git a/library.properties b/library.properties index 4a8d969..6824af5 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ReactESP -version=1.0.0 +version=1.0.1-alpha author=Matti Airas , Andrew Carter maintainer=Matti Airas sentence=Asynchronous programming library for the ESP8266 and other microcontrollers compatible with the Arduino framework. From c7076a685832649a21f4ffc19e2da9aa13646bdc Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 6 Nov 2021 16:24:45 +0200 Subject: [PATCH 02/18] Update doxygen docs --- docs/generated/docs/_react_e_s_p_8cpp.html | 2 +- docs/generated/docs/_react_e_s_p_8cpp_source.html | 2 +- docs/generated/docs/_react_e_s_p_8h.html | 2 +- docs/generated/docs/_react_e_s_p_8h_source.html | 2 +- docs/generated/docs/annotated.html | 2 +- docs/generated/docs/class_delay_reaction-members.html | 2 +- docs/generated/docs/class_delay_reaction.html | 2 +- docs/generated/docs/class_i_s_r_reaction-members.html | 2 +- docs/generated/docs/class_i_s_r_reaction.html | 2 +- docs/generated/docs/class_react_e_s_p-members.html | 2 +- docs/generated/docs/class_react_e_s_p.html | 2 +- docs/generated/docs/class_reaction-members.html | 2 +- docs/generated/docs/class_reaction.html | 2 +- docs/generated/docs/class_repeat_reaction-members.html | 2 +- docs/generated/docs/class_repeat_reaction.html | 2 +- docs/generated/docs/class_stream_reaction-members.html | 2 +- docs/generated/docs/class_stream_reaction.html | 2 +- docs/generated/docs/class_tick_reaction-members.html | 2 +- docs/generated/docs/class_tick_reaction.html | 2 +- docs/generated/docs/class_timed_reaction-members.html | 2 +- docs/generated/docs/class_timed_reaction.html | 2 +- docs/generated/docs/class_untimed_reaction-members.html | 2 +- docs/generated/docs/class_untimed_reaction.html | 2 +- docs/generated/docs/classes.html | 2 +- docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- docs/generated/docs/files.html | 2 +- docs/generated/docs/functions.html | 2 +- docs/generated/docs/functions_func.html | 2 +- docs/generated/docs/functions_rela.html | 2 +- docs/generated/docs/functions_vars.html | 2 +- docs/generated/docs/globals.html | 2 +- docs/generated/docs/globals_defs.html | 2 +- docs/generated/docs/globals_func.html | 2 +- docs/generated/docs/globals_type.html | 2 +- docs/generated/docs/globals_vars.html | 2 +- docs/generated/docs/graph_legend.html | 2 +- docs/generated/docs/hierarchy.html | 2 +- docs/generated/docs/index.html | 2 +- docs/generated/docs/inherits.html | 2 +- docs/generated/docs/main_8cpp.html | 2 +- docs/generated/docs/main_8cpp_source.html | 2 +- docs/generated/docs/struct_trigger_time_compare-members.html | 2 +- docs/generated/docs/struct_trigger_time_compare.html | 2 +- 43 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/generated/docs/_react_e_s_p_8cpp.html b/docs/generated/docs/_react_e_s_p_8cpp.html index 1732e4a..621f92a 100644 --- a/docs/generated/docs/_react_e_s_p_8cpp.html +++ b/docs/generated/docs/_react_e_s_p_8cpp.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/_react_e_s_p_8cpp_source.html b/docs/generated/docs/_react_e_s_p_8cpp_source.html index 4d0f9d3..6bd6d21 100644 --- a/docs/generated/docs/_react_e_s_p_8cpp_source.html +++ b/docs/generated/docs/_react_e_s_p_8cpp_source.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/_react_e_s_p_8h.html b/docs/generated/docs/_react_e_s_p_8h.html index 55dd672..6d3ae8d 100644 --- a/docs/generated/docs/_react_e_s_p_8h.html +++ b/docs/generated/docs/_react_e_s_p_8h.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/_react_e_s_p_8h_source.html b/docs/generated/docs/_react_e_s_p_8h_source.html index 42842ea..9ea7ecc 100644 --- a/docs/generated/docs/_react_e_s_p_8h_source.html +++ b/docs/generated/docs/_react_e_s_p_8h_source.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/annotated.html b/docs/generated/docs/annotated.html index 37a556c..b19fc92 100644 --- a/docs/generated/docs/annotated.html +++ b/docs/generated/docs/annotated.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_delay_reaction-members.html b/docs/generated/docs/class_delay_reaction-members.html index 0ce8158..3b86353 100644 --- a/docs/generated/docs/class_delay_reaction-members.html +++ b/docs/generated/docs/class_delay_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_delay_reaction.html b/docs/generated/docs/class_delay_reaction.html index e7517a3..be6d443 100644 --- a/docs/generated/docs/class_delay_reaction.html +++ b/docs/generated/docs/class_delay_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_i_s_r_reaction-members.html b/docs/generated/docs/class_i_s_r_reaction-members.html index af03b2e..9ac3599 100644 --- a/docs/generated/docs/class_i_s_r_reaction-members.html +++ b/docs/generated/docs/class_i_s_r_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_i_s_r_reaction.html b/docs/generated/docs/class_i_s_r_reaction.html index 06148c0..d9a9562 100644 --- a/docs/generated/docs/class_i_s_r_reaction.html +++ b/docs/generated/docs/class_i_s_r_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_react_e_s_p-members.html b/docs/generated/docs/class_react_e_s_p-members.html index 3808923..b2fea4f 100644 --- a/docs/generated/docs/class_react_e_s_p-members.html +++ b/docs/generated/docs/class_react_e_s_p-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_react_e_s_p.html b/docs/generated/docs/class_react_e_s_p.html index d40aa8f..3645ddd 100644 --- a/docs/generated/docs/class_react_e_s_p.html +++ b/docs/generated/docs/class_react_e_s_p.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_reaction-members.html b/docs/generated/docs/class_reaction-members.html index e41e30f..b45cf08 100644 --- a/docs/generated/docs/class_reaction-members.html +++ b/docs/generated/docs/class_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_reaction.html b/docs/generated/docs/class_reaction.html index c85f2a5..d6fa3e1 100644 --- a/docs/generated/docs/class_reaction.html +++ b/docs/generated/docs/class_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_repeat_reaction-members.html b/docs/generated/docs/class_repeat_reaction-members.html index 60b4a26..7b97bc7 100644 --- a/docs/generated/docs/class_repeat_reaction-members.html +++ b/docs/generated/docs/class_repeat_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_repeat_reaction.html b/docs/generated/docs/class_repeat_reaction.html index 66af87d..ac924dc 100644 --- a/docs/generated/docs/class_repeat_reaction.html +++ b/docs/generated/docs/class_repeat_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_stream_reaction-members.html b/docs/generated/docs/class_stream_reaction-members.html index 4f9951a..58b995d 100644 --- a/docs/generated/docs/class_stream_reaction-members.html +++ b/docs/generated/docs/class_stream_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_stream_reaction.html b/docs/generated/docs/class_stream_reaction.html index 1de0736..acd1d81 100644 --- a/docs/generated/docs/class_stream_reaction.html +++ b/docs/generated/docs/class_stream_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_tick_reaction-members.html b/docs/generated/docs/class_tick_reaction-members.html index 90963b3..c574c63 100644 --- a/docs/generated/docs/class_tick_reaction-members.html +++ b/docs/generated/docs/class_tick_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_tick_reaction.html b/docs/generated/docs/class_tick_reaction.html index 914ed84..cc8a1bc 100644 --- a/docs/generated/docs/class_tick_reaction.html +++ b/docs/generated/docs/class_tick_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_timed_reaction-members.html b/docs/generated/docs/class_timed_reaction-members.html index 42a8038..b2bbca6 100644 --- a/docs/generated/docs/class_timed_reaction-members.html +++ b/docs/generated/docs/class_timed_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_timed_reaction.html b/docs/generated/docs/class_timed_reaction.html index abf45d5..37f48e5 100644 --- a/docs/generated/docs/class_timed_reaction.html +++ b/docs/generated/docs/class_timed_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_untimed_reaction-members.html b/docs/generated/docs/class_untimed_reaction-members.html index 6bbae82..3698f69 100644 --- a/docs/generated/docs/class_untimed_reaction-members.html +++ b/docs/generated/docs/class_untimed_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/class_untimed_reaction.html b/docs/generated/docs/class_untimed_reaction.html index 692b414..b7af963 100644 --- a/docs/generated/docs/class_untimed_reaction.html +++ b/docs/generated/docs/class_untimed_reaction.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/classes.html b/docs/generated/docs/classes.html index 4296fe7..4c2a109 100644 --- a/docs/generated/docs/classes.html +++ b/docs/generated/docs/classes.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 5597d6b..dc9f327 100644 --- a/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/files.html b/docs/generated/docs/files.html index ddea5ef..a5134a9 100644 --- a/docs/generated/docs/files.html +++ b/docs/generated/docs/files.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/functions.html b/docs/generated/docs/functions.html index 3d2e757..50a17a2 100644 --- a/docs/generated/docs/functions.html +++ b/docs/generated/docs/functions.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/functions_func.html b/docs/generated/docs/functions_func.html index a25123d..1a6b090 100644 --- a/docs/generated/docs/functions_func.html +++ b/docs/generated/docs/functions_func.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/functions_rela.html b/docs/generated/docs/functions_rela.html index cc2f189..129b982 100644 --- a/docs/generated/docs/functions_rela.html +++ b/docs/generated/docs/functions_rela.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/functions_vars.html b/docs/generated/docs/functions_vars.html index ba2fa6a..3a63a29 100644 --- a/docs/generated/docs/functions_vars.html +++ b/docs/generated/docs/functions_vars.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/globals.html b/docs/generated/docs/globals.html index 2fb67a8..6e7d7c1 100644 --- a/docs/generated/docs/globals.html +++ b/docs/generated/docs/globals.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/globals_defs.html b/docs/generated/docs/globals_defs.html index b23626b..6be6d3e 100644 --- a/docs/generated/docs/globals_defs.html +++ b/docs/generated/docs/globals_defs.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/globals_func.html b/docs/generated/docs/globals_func.html index ed05356..cdad1b3 100644 --- a/docs/generated/docs/globals_func.html +++ b/docs/generated/docs/globals_func.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/globals_type.html b/docs/generated/docs/globals_type.html index 2171da6..249712b 100644 --- a/docs/generated/docs/globals_type.html +++ b/docs/generated/docs/globals_type.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/globals_vars.html b/docs/generated/docs/globals_vars.html index 437925d..83fe068 100644 --- a/docs/generated/docs/globals_vars.html +++ b/docs/generated/docs/globals_vars.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/graph_legend.html b/docs/generated/docs/graph_legend.html index 156ba6c..c8c0ce5 100644 --- a/docs/generated/docs/graph_legend.html +++ b/docs/generated/docs/graph_legend.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/hierarchy.html b/docs/generated/docs/hierarchy.html index c35c517..cedfafd 100644 --- a/docs/generated/docs/hierarchy.html +++ b/docs/generated/docs/hierarchy.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/index.html b/docs/generated/docs/index.html index 5301dd8..1d1b9ff 100644 --- a/docs/generated/docs/index.html +++ b/docs/generated/docs/index.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/inherits.html b/docs/generated/docs/inherits.html index 6b094aa..d77a696 100644 --- a/docs/generated/docs/inherits.html +++ b/docs/generated/docs/inherits.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/main_8cpp.html b/docs/generated/docs/main_8cpp.html index 9a19bea..fc7c25a 100644 --- a/docs/generated/docs/main_8cpp.html +++ b/docs/generated/docs/main_8cpp.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/main_8cpp_source.html b/docs/generated/docs/main_8cpp_source.html index 638a184..628faae 100644 --- a/docs/generated/docs/main_8cpp_source.html +++ b/docs/generated/docs/main_8cpp_source.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/struct_trigger_time_compare-members.html b/docs/generated/docs/struct_trigger_time_compare-members.html index d514ed5..29a0e1e 100644 --- a/docs/generated/docs/struct_trigger_time_compare-members.html +++ b/docs/generated/docs/struct_trigger_time_compare-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/struct_trigger_time_compare.html b/docs/generated/docs/struct_trigger_time_compare.html index c099827..5b22906 100644 --- a/docs/generated/docs/struct_trigger_time_compare.html +++ b/docs/generated/docs/struct_trigger_time_compare.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.0 +
ReactESP 1.0.1-alpha
Asynchronous programming for the ESP microcontrollers
From 4882652ac9dd607520c64b201fd5de0a1002eb23 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 12:38:53 +0200 Subject: [PATCH 03/18] Expect user-defined setup() and loop() functions Until now, ReactESP has defined setup() and loop() implicitly and expected the user to provide a setup callback in the constructor call. This is not customary in the Arduino Framework and may create some confusion in newcomers. --- src/ReactESP.cpp | 7 ------- src/ReactESP.h | 8 +------- 2 files changed, 1 insertion(+), 14 deletions(-) diff --git a/src/ReactESP.cpp b/src/ReactESP.cpp index 80ce2bc..b989bbe 100644 --- a/src/ReactESP.cpp +++ b/src/ReactESP.cpp @@ -104,13 +104,6 @@ void ISRReaction::remove() { // Need to define the static variable outside of the class ReactESP* ReactESP::app = NULL; -void setup(void) { ReactESP::app->setup(); } - -void loop(void) { - ReactESP::app->tick(); - yield(); -} - void ReactESP::tickTimed() { uint64_t now = micros64(); uint64_t trigger_t; diff --git a/src/ReactESP.h b/src/ReactESP.h index b00aace..906173e 100644 --- a/src/ReactESP.h +++ b/src/ReactESP.h @@ -252,13 +252,8 @@ class ReactESP { public: /** * @brief Construct a new ReactESP object - * - * @param cb Setup function to be called. This is equivalent to the regular - * Arduino setup() function and should perform any initial setup the program - * requires. */ - ReactESP(const react_callback cb) : _setup(cb) { app = this; } - void setup(void) { _setup(); } + ReactESP() { app = this; } void tick(void); /// Static singleton reference to the instantiated ReactESP object @@ -325,7 +320,6 @@ class ReactESP { TickReaction* onTick(const react_callback cb); private: - const react_callback _setup; std::priority_queue, TriggerTimeCompare> timed_queue; From 619973ced19f5910dafe9fc65c650c5e28d192e8 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 14:44:01 +0200 Subject: [PATCH 04/18] Update the examples --- examples/minimal/src/main.cpp | 22 ++++++++++++++-------- examples/torture_test/src/main.cpp | 15 +++++++++------ 2 files changed, 23 insertions(+), 14 deletions(-) diff --git a/examples/minimal/src/main.cpp b/examples/minimal/src/main.cpp index 878524c..7a4db3f 100644 --- a/examples/minimal/src/main.cpp +++ b/examples/minimal/src/main.cpp @@ -1,27 +1,33 @@ #include #include -extern "C" { -#include "user_interface.h" -} - #define LED_PIN 2 int led_state = 0; -ReactESP app([] () { +ReactESP app; + +void setup() { Serial.begin(115200); Serial.println("Starting"); pinMode(LED_PIN, OUTPUT); Serial.println("Setting up timed reactions"); + + // toggle LED every 400 ms app.onRepeat(400, [] () { led_state = !led_state; digitalWrite(LED_PIN, led_state); }); + + // Additionally, toggle LED every 1020 ms. + // This adds an irregularity to the LED blink pattern. app.onRepeat(1020, [] () { led_state = !led_state; digitalWrite(LED_PIN, led_state); - }); - -}); + }); +} + +void loop() { + app.tick(); +} diff --git a/examples/torture_test/src/main.cpp b/examples/torture_test/src/main.cpp index 7fe2169..24a73d5 100644 --- a/examples/torture_test/src/main.cpp +++ b/examples/torture_test/src/main.cpp @@ -1,10 +1,6 @@ #include #include -extern "C" { -#include "user_interface.h" -} - #define LED_PIN 2 #define OUT_PIN 14 // D5 #define INPUT_PIN1 12 // D6 @@ -16,6 +12,8 @@ extern "C" { int tick_counter = 0; int timer_ticks[NUM_TIMERS]; +ReactESP app; + void reporter() { Serial.printf("Timer ticks: "); for (int i=0; i Date: Sat, 20 Nov 2021 15:29:13 +0200 Subject: [PATCH 05/18] Remove the servo example It hasn't been tested and is unlikely to work as is. --- README.md | 2 - examples/servo.cpp | 144 --------------------------------------------- 2 files changed, 146 deletions(-) delete mode 100644 examples/servo.cpp diff --git a/README.md b/README.md index 263677e..07b72f9 100644 --- a/README.md +++ b/README.md @@ -216,6 +216,4 @@ Remove the reaction from the execution queue. - [`Minimal`](examples/minimal/src/main.cpp): A minimal example with two timers switching the LED state. -- [`Servo`](examples/servo.cpp): Demonstrates several different reaction types for controlling a servo, monitoring inputs and blinking an LED. - - [`Torture test`](examples/torture_test/src/main.cpp): A stress test of twenty simultaneous repeat reactions as well as a couple of interrupts, a stream, and a tick reaction. For kicks, try changing `NUM_TIMERS` to 200. Program performance will be practically unchanged! diff --git a/examples/servo.cpp b/examples/servo.cpp deleted file mode 100644 index f325d2a..0000000 --- a/examples/servo.cpp +++ /dev/null @@ -1,144 +0,0 @@ -#include -#include - -/* - * This example demonstates: - * - several reactions : - * + servo motion control - * + LED blinking - * + input monitoring - * - * Attach a hobby R/C analog servo to pin SERVO_PIN and a push button to - * BUTTON_PIN. - * - * The servo will start sweeping when the program starts. Depressing the button - * will toggle the motion on or off. - * - * At the same time, the LED will blink quickly when the servo is moving, and - * slowly when it is stopped. - * - * In addition to demonstrating several types of reaction used in the same - * application, this show also how reactions can be removed and added on the - * fly. This is used to change the blinking period of the LED. - */ - -#define SERVO_PIN 11 -#define BUTTON_PIN 8 - -// servo motion increment -#define MOVE_INCREMENT 1 - -// LED blink periods (ms) -#define BLINK_DELAY_MOVING 200 // when the servo is moving -#define BLINK_DELAY_STOPPED 500 // when the servo is stopped - -/* - * Servo related data - */ -Servo servo ; // the servo instance -bool servo_activated; // the flag telling if it is activated or not - -/* - * LED blink reaction reference - */ -RepeatReaction* r_blink; - - -/* - * LED blink reaction callback - */ -void blink() { - static bool state = false; - digitalWrite(LED_BUILTIN, state = !state); -} - - -/* - * Servo motion control reaction callback - */ -void move_servo() { - static uint8_t angle = 45; - static int8_t increment = MOVE_INCREMENT; - - if (!servo_activated) - return; - - servo.write(angle); - - angle += increment; - if (angle > 135) { - angle = 135; - increment = -MOVE_INCREMENT; - } else if (angle < 45) { - angle = 45; - increment = MOVE_INCREMENT; - } -} - - -/* - * I/O monitoring callback for the push button - */ -void button_cb() { - static uint32_t last_time; // last execution time for debouncing - - uint32_t now = millis(); - if (now - last_time >= 100) { // ignore calls closer than 100ms (debouncing) - Serial.println("button pressed"); - last_time = now; - - // toggle the servo state by attaching or detaching it - if (servo_activated) { - Serial.println("deactivating servo"); - servo.detach(); - } else { - Serial.println("activating servo"); - servo.attach(SERVO_PIN); - } - servo_activated = !servo_activated; - - /* - * blink frequency update to reflect the servo current activation state - */ - - // delete the current blink reaction - app.remove(r_blink); - - // create a new one with the relevant period and save its reference - r_blink = app.onRepeat( - servo_activated ? BLINK_DELAY_MOVING : BLINK_DELAY_STOPPED, - blink - ); - } -} - -/* - * Application initialization - */ -void app_main() { - // usual I/O configuration - pinMode(LED_BUILTIN, OUTPUT); - pinMode(BUTTON_PIN, INPUT_PULLUP); - - Serial.begin(9600); // for debug trace - - // activate the servo from app start - servo.attach(SERVO_PIN); - servo_activated = true; - - /* - * Reactions registration - */ - - // periodic LED blink (keep a reference for being able to edit it afterwards) - r_blink = app.onRepeat(BLINK_DELAY_MOVING, blink); - - // periodic servo motion control - app.onRepeat(20, move_servo); - - // input monitoring for the push button - app.onInterrupt(BUTTON_PIN, FALLING, button_cb); -} - -// let's start the reactor with our application -ReactESP app(app_main); From 52db26e60e0e30d5b3f2eb1d0eb2bc9a9cb9279f Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 15:29:33 +0200 Subject: [PATCH 06/18] Update README to match the new syntax --- README.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 07b72f9..ab39f3e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ By [Matti Airas](https://github.com/mairas) -An asynchronous programming library for the ESP8266 and other microcontrollers using the Arduino framework. +An asynchronous programming library for the ESP32 and other microcontrollers using the Arduino framework. The library is at the core of the [SensESP](https://github.com/SignalK/SensESP) project but is completely generic and can be used for standalone projects without issues. @@ -35,19 +35,25 @@ Using ReactESP, the sketch can be rewritten to the following: ```cpp #include -ReactESP app([] () { +ReactESP app; + +setup() { pinMode(LED_BUILTIN, OUTPUT); app.onRepeat(1000, [] () { static bool state = false; digitalWrite(LED_BUILTIN, state = !state); }); -}); +} + +void loop() { + app.tick(); +} ``` -With ReactESP, the developer creates an `app` object and passes to the constructor a start up function. In the example above, a [lambda function](http://en.cppreference.com/w/cpp/language/lambda) is used. +Instead of directly defining the program logic in the `loop()` function, _reactions_ are defined in the `setup()` function. A reaction is a function that is executed when a certain event happens. In this case, the event is that the function should repeat every second, as defined by the `onRepeat()` method call. The second argument to the `onRepeat()` method is a [lambda function](http://en.cppreference.com/w/cpp/language/lambda) that is executed every time the reaction is triggered. If the syntax feels weird, you can also use regular named functions instead of lambdas. -There is no `setup()` or `loop()`, ReactESP will define these for you. All you need to do is tell ReactESP which events you need to watch, and it will dispatch your handlers/callbacks when they occur. +The `app.tick()` call in the `loop()` function is the main loop of the program. It is responsible for calling the reactions that have been defined. You can also add additional code to the `loop()` function, any delays or other long-executing code should be avoided. ## Why Bother? @@ -136,7 +142,9 @@ This solves Charlie's problem, but it's quite verbose. Using ReactESP, Charlie c ```c++ #include -ReactESP app([] () { +ReactESP app; + +void setup() { Serial.begin(9600); pinMode(LED_BUILTIN, OUTPUT); @@ -146,7 +154,11 @@ ReactESP app([] () { app.onDelay(1000, [] () { digitalWrite(LED_BUILTIN, LOW); }); }); -}); +} + +void loop() { + app.tick(); +} ``` ## Advanced callback support From ceb68dd5b04f77a35d91d141d26b1b90f27a8208 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 15:40:56 +0200 Subject: [PATCH 07/18] Update the description --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 6824af5..dc92f2b 100644 --- a/library.properties +++ b/library.properties @@ -2,7 +2,7 @@ name=ReactESP version=1.0.1-alpha author=Matti Airas , Andrew Carter maintainer=Matti Airas -sentence=Asynchronous programming library for the ESP8266 and other microcontrollers compatible with the Arduino framework. +sentence=Asynchronous programming library for the ESP32 and other microcontrollers compatible with the Arduino framework. paragraph=ReactESP is an asynchronous programming library for creating non-blocking applications on the Arduino framework. category=Other url=https://github.com/mairas/ReactESP From ec456a8c3b6cac32ec2cbbea7258206a72e2a47b Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 15:41:12 +0200 Subject: [PATCH 08/18] Add a bumpversion config file --- .bumpversion.cfg | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .bumpversion.cfg diff --git a/.bumpversion.cfg b/.bumpversion.cfg new file mode 100644 index 0000000..a942308 --- /dev/null +++ b/.bumpversion.cfg @@ -0,0 +1,29 @@ +[bumpversion] +current_version = 1.0.1-alpha +commit = True +tag = False +parse = (?P\d+)\.(?P\d+)\.(?P\d+)(\-(?P[a-z]+))? +serialize = + {major}.{minor}.{patch}-{release} + {major}.{minor}.{patch} + +[bumpversion:part:release] +optional_value = final +first_value = alpha +values = + alpha + final + +[bumpversion:file:VERSION] + +[bumpversion:file:library.json] +search = "version": "{current_version}", +replace = "version": "{new_version}", + +[bumpversion:file:library.properties] +search = version={current_version} +replace = version={new_version} + +[bumpversion:file:Doxyfile] +search = = {current_version} +replace = = {new_version} From e52a98b10d01e1ac44f796687c38ee79a22a524a Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 15:41:55 +0200 Subject: [PATCH 09/18] Add a convenience VERSION file --- VERSION | 1 + 1 file changed, 1 insertion(+) create mode 100644 VERSION diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..1a15c9e --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +1.0.1-alpha From 64da88470e1ed00d3071e5127610b733d0f25e10 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 20 Nov 2021 15:42:13 +0200 Subject: [PATCH 10/18] =?UTF-8?q?Bump=20version:=201.0.1-alpha=20=E2=86=92?= =?UTF-8?q?=202.0.0-alpha?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- Doxyfile | 2 +- VERSION | 2 +- library.json | 2 +- library.properties | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index a942308..6da994c 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.0.1-alpha +current_version = 2.0.0-alpha commit = True tag = False parse = (?P\d+)\.(?P\d+)\.(?P\d+)(\-(?P[a-z]+))? diff --git a/Doxyfile b/Doxyfile index d3704af..65e9507 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = ReactESP # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.0.1-alpha +PROJECT_NUMBER = 2.0.0-alpha # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/VERSION b/VERSION index 1a15c9e..fbffcdf 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.1-alpha +2.0.0-alpha diff --git a/library.json b/library.json index 595aed5..d1a4fca 100644 --- a/library.json +++ b/library.json @@ -23,7 +23,7 @@ } ], "dependencies": [], - "version": "1.0.1-alpha", + "version": "2.0.0-alpha", "frameworks": "arduino", "platforms": "*" } diff --git a/library.properties b/library.properties index dc92f2b..787dc18 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ReactESP -version=1.0.1-alpha +version=2.0.0-alpha author=Matti Airas , Andrew Carter maintainer=Matti Airas sentence=Asynchronous programming library for the ESP32 and other microcontrollers compatible with the Arduino framework. From bf05455378b26c674ea7bc2fee13453bcff966c8 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Wed, 24 Nov 2021 11:33:04 +0200 Subject: [PATCH 11/18] Wrap the library in a namespace --- src/ReactESP.cpp | 4 ++++ src/ReactESP.h | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/src/ReactESP.cpp b/src/ReactESP.cpp index b989bbe..d4a3ee0 100644 --- a/src/ReactESP.cpp +++ b/src/ReactESP.cpp @@ -4,6 +4,8 @@ #include #include +namespace reactesp { + /** * @brief Return the current time since the device restart in microseconds * @@ -184,3 +186,5 @@ TickReaction* ReactESP::onTick(const react_callback cb) { tre->add(); return tre; } + +} // namespace reactesp diff --git a/src/ReactESP.h b/src/ReactESP.h index 906173e..ce5c05e 100644 --- a/src/ReactESP.h +++ b/src/ReactESP.h @@ -7,6 +7,8 @@ #include #include +namespace reactesp { + typedef std::function react_callback; typedef void (*isr_react_callback)(void*); @@ -332,4 +334,6 @@ class ReactESP { void add(Reaction* re); }; +} // namespace reactesp + #endif From 7ecb9e9af69f9f2dea6701d30e42e991a9eeaa57 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Wed, 24 Nov 2021 11:35:52 +0200 Subject: [PATCH 12/18] Add namespace declarations to examples --- examples/minimal/src/main.cpp | 2 ++ examples/torture_test/src/main.cpp | 2 ++ 2 files changed, 4 insertions(+) diff --git a/examples/minimal/src/main.cpp b/examples/minimal/src/main.cpp index 7a4db3f..a1b4021 100644 --- a/examples/minimal/src/main.cpp +++ b/examples/minimal/src/main.cpp @@ -1,6 +1,8 @@ #include #include +using namespace reactesp; + #define LED_PIN 2 int led_state = 0; diff --git a/examples/torture_test/src/main.cpp b/examples/torture_test/src/main.cpp index 24a73d5..77a72fe 100644 --- a/examples/torture_test/src/main.cpp +++ b/examples/torture_test/src/main.cpp @@ -1,6 +1,8 @@ #include #include +using namespace reactesp; + #define LED_PIN 2 #define OUT_PIN 14 // D5 #define INPUT_PIN1 12 // D6 From 059cae5e778405c1f5be0dc24482e5af7c44ebcd Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Wed, 24 Nov 2021 11:44:23 +0200 Subject: [PATCH 13/18] Describe the namespace change in README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index ab39f3e..36612e3 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ Using ReactESP, the sketch can be rewritten to the following: ```cpp #include +using namespace reactesp; + ReactESP app; setup() { @@ -142,6 +144,8 @@ This solves Charlie's problem, but it's quite verbose. Using ReactESP, Charlie c ```c++ #include +using namespace reactesp; + ReactESP app; void setup() { @@ -179,6 +183,21 @@ for (int i=0; i<20; i++) { ## API +### Namespace use + +Note that beginning of ReactESP 2.0.0, the ReactESP library has been wrapped in +a `reactesp` namespace. +This is to avoid name conflicts with other libraries. + +The impact to the user is that they need to define the namespace when using the library. +This can be done either globally by placing the following statement in the source code right after the `#include` statements: + + using namespace reactesp; + +or by using the `reactesp::` prefix when using the library: + + reactesp::ReactESP app; + ### Event Registration Functions All of the registration functions return a `Reaction` object pointer. This can be used to store and manipulate From 33007353ae4e671449b3b67bbabd72b688793b98 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 27 Nov 2021 12:54:01 +0200 Subject: [PATCH 14/18] =?UTF-8?q?Bump=20version:=202.0.0-alpha=20=E2=86=92?= =?UTF-8?q?=202.0.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- Doxyfile | 2 +- VERSION | 2 +- library.json | 2 +- library.properties | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 6da994c..cda330f 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.0.0-alpha +current_version = 2.0.0 commit = True tag = False parse = (?P\d+)\.(?P\d+)\.(?P\d+)(\-(?P[a-z]+))? diff --git a/Doxyfile b/Doxyfile index 65e9507..e4094a7 100644 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = ReactESP # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 2.0.0-alpha +PROJECT_NUMBER = 2.0.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/VERSION b/VERSION index fbffcdf..227cea2 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.0.0-alpha +2.0.0 diff --git a/library.json b/library.json index d1a4fca..1da4e9a 100644 --- a/library.json +++ b/library.json @@ -23,7 +23,7 @@ } ], "dependencies": [], - "version": "2.0.0-alpha", + "version": "2.0.0", "frameworks": "arduino", "platforms": "*" } diff --git a/library.properties b/library.properties index 787dc18..912c343 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ReactESP -version=2.0.0-alpha +version=2.0.0 author=Matti Airas , Andrew Carter maintainer=Matti Airas sentence=Asynchronous programming library for the ESP32 and other microcontrollers compatible with the Arduino framework. From 7160c4e908443a3dbf3c197581b3b4e4595baf64 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 27 Nov 2021 13:01:56 +0200 Subject: [PATCH 15/18] Update Doxyfile --- Doxyfile | 466 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 269 insertions(+), 197 deletions(-) diff --git a/Doxyfile b/Doxyfile index e4094a7..65bb60e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.15 +# Doxyfile 1.9.2 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -93,14 +93,6 @@ ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. @@ -197,6 +189,16 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus @@ -217,6 +219,14 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. @@ -240,25 +250,19 @@ TAB_SIZE = 4 # the documentation. An alias has the form: # name=value # For example adding -# "sideeffect=@par Side Effects:\n" +# "sideeffect=@par Side Effects:^^" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -299,19 +303,22 @@ OPTIMIZE_OUTPUT_SLICE = NO # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is -# Fortran), use: inc=Fortran f=C. +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. EXTENSION_MAPPING = @@ -329,7 +336,7 @@ MARKDOWN_SUPPORT = YES # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. +# Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 @@ -445,6 +452,19 @@ TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -465,6 +485,12 @@ EXTRACT_ALL = YES EXTRACT_PRIVATE = NO +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. @@ -502,6 +528,13 @@ EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation @@ -519,8 +552,8 @@ HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. +# declarations. If set to NO, these declarations will be included in the +# documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO @@ -539,11 +572,18 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. # The default value is: system dependent. CASE_SENSE_NAMES = NO @@ -562,6 +602,12 @@ HIDE_SCOPE_NAMES = NO HIDE_COMPOUND_REFERENCE= NO +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -719,7 +765,8 @@ FILE_VERSION_FILTER = # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE @@ -765,24 +812,35 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. # The default value is: NO. WARN_AS_ERROR = NO @@ -818,8 +876,8 @@ INPUT = src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: https://www.gnu.org/software/libiconv/) for the list of -# possible encodings. +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 @@ -832,11 +890,15 @@ INPUT_ENCODING = UTF-8 # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ @@ -1094,35 +1156,6 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files -# were built. This is equivalent to specifying the "-p" option to a clang tool, -# such as clang-check. These options will then be passed to the parser. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = - #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -1134,13 +1167,6 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored @@ -1240,7 +1266,7 @@ HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see +# this color. Hue is specified as an angle on a color-wheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. @@ -1250,7 +1276,7 @@ HTML_EXTRA_FILES = HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A +# in the HTML output. For a value of 0 the output will use gray-scales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1279,9 +1305,9 @@ HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that -# are dynamically created via Javascript. If disabled, the navigation index will +# are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have Javascript, +# page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1311,10 +1337,11 @@ HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: https://developer.apple.com/xcode/), introduced with OSX -# 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. @@ -1356,8 +1383,12 @@ DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML @@ -1387,7 +1418,7 @@ CHM_FILE = HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). +# (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1432,7 +1463,8 @@ QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1440,8 +1472,8 @@ QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- -# folders). +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1449,30 +1481,30 @@ QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = @@ -1515,16 +1547,28 @@ DISABLE_INDEX = NO # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # @@ -1549,6 +1593,17 @@ TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = NO +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML @@ -1569,8 +1624,14 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side Javascript for the rendering +# https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path @@ -1580,11 +1641,29 @@ FORMULA_TRANSPARENT = YES USE_MATHJAX = YES +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + # When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). # Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1597,22 +1676,29 @@ MATHJAX_FORMAT = HTML-CSS # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html +# #tex-and-latex-extensions): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1640,7 +1726,7 @@ MATHJAX_CODEFILE = SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There +# implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH # setting. When disabled, doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing @@ -1659,7 +1745,8 @@ SERVER_BASED_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). +# Xapian (see: +# https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1672,8 +1759,9 @@ EXTERNAL_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). See the section "External Indexing and -# Searching" for details. +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHENGINE_URL = @@ -1744,10 +1832,11 @@ LATEX_CMD_NAME = MAKEINDEX_CMD_NAME = makeindex # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to -# generate index for LaTeX. +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. # Note: This tag is used in the generated output file (.tex). # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. -# The default value is: \makeindex. +# The default value is: makeindex. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_MAKEINDEX_CMD = \makeindex @@ -1781,29 +1870,31 @@ PAPER_TYPE = a4 EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for +# the generated LaTeX document. The header should contain everything until the +# first chapter. If it is left blank doxygen will generate a standard header. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. # -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empty -# string, for the replacement values of the other commands the user is referred -# to HTML_HEADER. +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the -# generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. See +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for +# the generated LaTeX document. The footer should contain everything after the +# last chapter. If it is left blank doxygen will generate a standard footer. See # LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! +# special commands can be used inside the footer. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. Note: Only use a user-defined footer if you know what you are +# doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = @@ -1836,9 +1927,11 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES, to get a -# higher quality PDF documentation. +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1846,8 +1939,7 @@ USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode # command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. +# if errors occur, instead of asking the user for help. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1860,16 +1952,6 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. @@ -1950,16 +2032,6 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code -# with syntax highlighting in the RTF output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_RTF is set to YES. - -RTF_SOURCE_CODE = NO - #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- @@ -2056,15 +2128,6 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -2239,12 +2302,6 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- @@ -2258,15 +2315,6 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = NO -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2364,10 +2412,32 @@ UML_LOOK = NO # but if the number exceeds 15, the total amount of fields shown is limited to # 10. # Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. @@ -2465,7 +2535,7 @@ INTERACTIVE_SVG = YES # found. If left blank, it is assumed the dot tool can be found in the path. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_PATH = /usr/local/bin +DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the \dotfile @@ -2557,9 +2627,11 @@ DOT_MULTI_TARGETS = YES GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES From a05c0e03b650fbabc20c8b43a96ccee9ceb7bda2 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 27 Nov 2021 13:01:36 +0200 Subject: [PATCH 16/18] Add a doxygen updating script --- scripts/update_autogen.sh | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100755 scripts/update_autogen.sh diff --git a/scripts/update_autogen.sh b/scripts/update_autogen.sh new file mode 100755 index 0000000..66cdd78 --- /dev/null +++ b/scripts/update_autogen.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash + +# fail fast +set -euo pipefail + +VERSION=$(cat VERSION) + +# check that the repo is clean + +if ! git diff-index --quiet HEAD --; then + echo "Repo is not clean, aborting" + exit 1 +fi + +# udpate the doxygen docs + +git rm -rf docs/generated +mkdir -p docs/generated +doxygen +git add docs/generated +git commit -m "Update the Doxygen docs for version ${VERSION}" + From d16bf4061553c6ae085be142fbbf490ce23caf70 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 27 Nov 2021 13:08:17 +0200 Subject: [PATCH 17/18] Update the Doxygen docs for version 2.0.0 --- docs/generated/docs/_react_e_s_p_8cpp.html | 69 +-- docs/generated/docs/_react_e_s_p_8cpp.js | 5 - .../docs/_react_e_s_p_8cpp__incl.dot | 24 - .../docs/_react_e_s_p_8cpp__incl.map | 10 + .../docs/_react_e_s_p_8cpp__incl.md5 | 1 + .../docs/_react_e_s_p_8cpp__incl.svg | 132 +++++ ...b33edabd7f1c4e4a0bf32c67269be2f_cgraph.dot | 12 - ...dfd9b79bc5a37d7df40207afbc5431f_cgraph.dot | 12 - .../docs/_react_e_s_p_8cpp_source.html | 428 ++++++++------- docs/generated/docs/_react_e_s_p_8h.html | 91 ++-- docs/generated/docs/_react_e_s_p_8h.js | 24 +- .../docs/_react_e_s_p_8h__dep__incl.dot | 13 - .../docs/_react_e_s_p_8h__dep__incl.map | 5 + .../docs/_react_e_s_p_8h__dep__incl.md5 | 1 + .../docs/_react_e_s_p_8h__dep__incl.svg | 51 ++ docs/generated/docs/_react_e_s_p_8h__incl.dot | 17 - docs/generated/docs/_react_e_s_p_8h__incl.map | 7 + docs/generated/docs/_react_e_s_p_8h__incl.md5 | 1 + docs/generated/docs/_react_e_s_p_8h__incl.svg | 81 +++ .../docs/_react_e_s_p_8h_source.html | 491 +++++++++--------- docs/generated/docs/annotated.html | 25 +- docs/generated/docs/annotated_dup.js | 22 +- .../docs/class_delay_reaction-members.html | 126 ----- docs/generated/docs/class_delay_reaction.html | 323 ------------ docs/generated/docs/class_delay_reaction.js | 7 - .../class_delay_reaction__coll__graph.dot | 13 - .../class_delay_reaction__inherit__graph.dot | 13 - docs/generated/docs/class_i_s_r_reaction.js | 8 - .../class_i_s_r_reaction__coll__graph.dot | 11 - .../class_i_s_r_reaction__inherit__graph.dot | 11 - ...a4a495b10cf265d41cbdb9790936072_cgraph.dot | 12 - ...4a495b10cf265d41cbdb9790936072_icgraph.dot | 12 - .../docs/class_react_e_s_p-members.html | 124 ----- docs/generated/docs/class_react_e_s_p.js | 18 - .../docs/class_react_e_s_p__coll__graph.dot | 10 - ...2ce0511803b0d3a1fcec6bc56ff8b3f_cgraph.dot | 14 - ...a7018e7a5e89634e8e4385be51eafd4_cgraph.dot | 12 - ...da68d41f2a9790ab1aec2610bad07eb_cgraph.dot | 12 - ...31c11dd7f1a6e15d70785c3a990df93_cgraph.dot | 12 - ...6556a0954d117dc5b8d925e5924cdf_icgraph.dot | 12 - ...26769ff3e426972e87746749560ffc0_cgraph.dot | 12 - ...5739bf0fedb24931f98762113161e95_cgraph.dot | 12 - ...b20144bde6e60b41e484d2f6f61d0f5_cgraph.dot | 12 - ...fac464d9df930d020a321a63cdcf4b_icgraph.dot | 12 - docs/generated/docs/class_reaction.js | 8 - .../docs/class_reaction__inherit__graph.dot | 23 - .../docs/class_repeat_reaction-members.html | 125 ----- .../generated/docs/class_repeat_reaction.html | 310 ----------- docs/generated/docs/class_repeat_reaction.js | 6 - .../class_repeat_reaction__coll__graph.dot | 13 - .../class_repeat_reaction__inherit__graph.dot | 13 - .../generated/docs/class_stream_reaction.html | 240 --------- docs/generated/docs/class_stream_reaction.js | 5 - .../class_stream_reaction__coll__graph.dot | 13 - .../class_stream_reaction__inherit__graph.dot | 13 - docs/generated/docs/class_tick_reaction.html | 229 -------- docs/generated/docs/class_tick_reaction.js | 5 - .../docs/class_tick_reaction__coll__graph.dot | 13 - .../class_tick_reaction__inherit__graph.dot | 13 - .../docs/class_timed_reaction-members.html | 123 ----- docs/generated/docs/class_timed_reaction.js | 16 - .../class_timed_reaction__coll__graph.dot | 11 - .../class_timed_reaction__inherit__graph.dot | 15 - ...3d0232141ebe0d446d853969766a69_icgraph.dot | 18 - docs/generated/docs/class_untimed_reaction.js | 8 - .../class_untimed_reaction__coll__graph.dot | 11 - ...class_untimed_reaction__inherit__graph.dot | 15 - ...8d78a83d9c8174a2e069cb6279a793_icgraph.dot | 14 - docs/generated/docs/classes.html | 14 +- ...ssreactesp_1_1_delay_reaction-members.html | 126 +++++ .../classreactesp_1_1_delay_reaction.html | 323 ++++++++++++ .../docs/classreactesp_1_1_delay_reaction.js | 7 + ...actesp_1_1_delay_reaction__coll__graph.map | 5 + ...actesp_1_1_delay_reaction__coll__graph.md5 | 1 + ...actesp_1_1_delay_reaction__coll__graph.svg | 51 ++ ...esp_1_1_delay_reaction__inherit__graph.map | 5 + ...esp_1_1_delay_reaction__inherit__graph.md5 | 1 + ...esp_1_1_delay_reaction__inherit__graph.svg | 51 ++ ...sreactesp_1_1_i_s_r_reaction-members.html} | 22 +- ... => classreactesp_1_1_i_s_r_reaction.html} | 128 ++--- .../docs/classreactesp_1_1_i_s_r_reaction.js | 8 + ...actesp_1_1_i_s_r_reaction__coll__graph.map | 4 + ...actesp_1_1_i_s_r_reaction__coll__graph.md5 | 1 + ...actesp_1_1_i_s_r_reaction__coll__graph.svg | 36 ++ ...esp_1_1_i_s_r_reaction__inherit__graph.map | 4 + ...esp_1_1_i_s_r_reaction__inherit__graph.md5 | 1 + ...esp_1_1_i_s_r_reaction__inherit__graph.svg | 36 ++ ...cf4abc748379340fb0e97b77c3bc4d_icgraph.map | 5 + ...cf4abc748379340fb0e97b77c3bc4d_icgraph.md5 | 1 + ...cf4abc748379340fb0e97b77c3bc4d_icgraph.svg | 52 ++ ...b7efd14de7cd96df315e761f962d4a_icgraph.map | 6 + ...b7efd14de7cd96df315e761f962d4a_icgraph.md5 | 1 + ...b7efd14de7cd96df315e761f962d4a_icgraph.svg | 67 +++ ...classreactesp_1_1_react_e_s_p-members.html | 123 +++++ ...tml => classreactesp_1_1_react_e_s_p.html} | 305 ++++++----- .../docs/classreactesp_1_1_react_e_s_p.js | 17 + ...sreactesp_1_1_react_e_s_p__coll__graph.map | 3 + ...sreactesp_1_1_react_e_s_p__coll__graph.md5 | 1 + ...sreactesp_1_1_react_e_s_p__coll__graph.svg | 28 + ...2c88fbcd1f1ab9842517056448de6b5_cgraph.map | 4 + ...2c88fbcd1f1ab9842517056448de6b5_cgraph.md5 | 1 + ...2c88fbcd1f1ab9842517056448de6b5_cgraph.svg | 37 ++ ...c88fbcd1f1ab9842517056448de6b5_icgraph.map | 5 + ...c88fbcd1f1ab9842517056448de6b5_icgraph.md5 | 1 + ...c88fbcd1f1ab9842517056448de6b5_icgraph.svg | 52 ++ ...f51c39bd90492f6184872f6d91f14dd_cgraph.map | 4 + ...f51c39bd90492f6184872f6d91f14dd_cgraph.md5 | 1 + ...f51c39bd90492f6184872f6d91f14dd_cgraph.svg | 37 ++ ...b25d026d1f26fb80b2c6659f3875fd8_cgraph.map | 4 + ...b25d026d1f26fb80b2c6659f3875fd8_cgraph.md5 | 1 + ...b25d026d1f26fb80b2c6659f3875fd8_cgraph.svg | 37 ++ ...25d026d1f26fb80b2c6659f3875fd8_icgraph.map | 5 + ...25d026d1f26fb80b2c6659f3875fd8_icgraph.md5 | 1 + ...25d026d1f26fb80b2c6659f3875fd8_icgraph.svg | 52 ++ ...3d99a3ed39a75337f01888c2240df0_icgraph.map | 4 + ...3d99a3ed39a75337f01888c2240df0_icgraph.md5 | 1 + ...3d99a3ed39a75337f01888c2240df0_icgraph.svg | 37 ++ ...14de417d6b11c6111df8bba25d5ed75_cgraph.map | 4 + ...14de417d6b11c6111df8bba25d5ed75_cgraph.md5 | 1 + ...14de417d6b11c6111df8bba25d5ed75_cgraph.svg | 37 ++ ...4de417d6b11c6111df8bba25d5ed75_icgraph.map | 6 + ...4de417d6b11c6111df8bba25d5ed75_icgraph.md5 | 1 + ...4de417d6b11c6111df8bba25d5ed75_icgraph.svg | 73 +++ ...15637cf3778be71a156845bd069506a_cgraph.map | 4 + ...15637cf3778be71a156845bd069506a_cgraph.md5 | 1 + ...15637cf3778be71a156845bd069506a_cgraph.svg | 37 ++ ...442c7e1e8084f46a900646957f1f9c8_cgraph.map | 4 + ...442c7e1e8084f46a900646957f1f9c8_cgraph.md5 | 1 + ...442c7e1e8084f46a900646957f1f9c8_cgraph.svg | 37 ++ ...42c7e1e8084f46a900646957f1f9c8_icgraph.map | 5 + ...42c7e1e8084f46a900646957f1f9c8_icgraph.md5 | 1 + ...42c7e1e8084f46a900646957f1f9c8_icgraph.svg | 52 ++ ...a5876a2a33275dc7d0ba8214bb51ee7_cgraph.map | 4 + ...a5876a2a33275dc7d0ba8214bb51ee7_cgraph.md5 | 1 + ...a5876a2a33275dc7d0ba8214bb51ee7_cgraph.svg | 37 ++ ...5876a2a33275dc7d0ba8214bb51ee7_icgraph.map | 5 + ...5876a2a33275dc7d0ba8214bb51ee7_icgraph.md5 | 1 + ...5876a2a33275dc7d0ba8214bb51ee7_icgraph.svg | 52 ++ ...> classreactesp_1_1_reaction-members.html} | 18 +- ...n.html => classreactesp_1_1_reaction.html} | 86 +-- .../docs/classreactesp_1_1_reaction.js | 8 + ...sreactesp_1_1_reaction__inherit__graph.map | 10 + ...sreactesp_1_1_reaction__inherit__graph.md5 | 1 + ...sreactesp_1_1_reaction__inherit__graph.svg | 126 +++++ ...sreactesp_1_1_repeat_reaction-members.html | 125 +++++ .../classreactesp_1_1_repeat_reaction.html | 310 +++++++++++ .../docs/classreactesp_1_1_repeat_reaction.js | 6 + ...ctesp_1_1_repeat_reaction__coll__graph.map | 5 + ...ctesp_1_1_repeat_reaction__coll__graph.md5 | 1 + ...ctesp_1_1_repeat_reaction__coll__graph.svg | 51 ++ ...sp_1_1_repeat_reaction__inherit__graph.map | 5 + ...sp_1_1_repeat_reaction__inherit__graph.md5 | 1 + ...sp_1_1_repeat_reaction__inherit__graph.svg | 51 ++ ...reactesp_1_1_stream_reaction-members.html} | 24 +- .../classreactesp_1_1_stream_reaction.html | 240 +++++++++ .../docs/classreactesp_1_1_stream_reaction.js | 5 + ...ctesp_1_1_stream_reaction__coll__graph.map | 5 + ...ctesp_1_1_stream_reaction__coll__graph.md5 | 1 + ...ctesp_1_1_stream_reaction__coll__graph.svg | 51 ++ ...sp_1_1_stream_reaction__inherit__graph.map | 5 + ...sp_1_1_stream_reaction__inherit__graph.md5 | 1 + ...sp_1_1_stream_reaction__inherit__graph.svg | 51 ++ ...ssreactesp_1_1_tick_reaction-members.html} | 24 +- .../docs/classreactesp_1_1_tick_reaction.html | 229 ++++++++ .../docs/classreactesp_1_1_tick_reaction.js | 5 + ...eactesp_1_1_tick_reaction__coll__graph.map | 5 + ...eactesp_1_1_tick_reaction__coll__graph.md5 | 1 + ...eactesp_1_1_tick_reaction__coll__graph.svg | 51 ++ ...tesp_1_1_tick_reaction__inherit__graph.map | 5 + ...tesp_1_1_tick_reaction__inherit__graph.md5 | 1 + ...tesp_1_1_tick_reaction__inherit__graph.svg | 51 ++ ...ssreactesp_1_1_timed_reaction-members.html | 123 +++++ ... => classreactesp_1_1_timed_reaction.html} | 218 ++++---- .../docs/classreactesp_1_1_timed_reaction.js | 16 + ...actesp_1_1_timed_reaction__coll__graph.map | 4 + ...actesp_1_1_timed_reaction__coll__graph.md5 | 1 + ...actesp_1_1_timed_reaction__coll__graph.svg | 36 ++ ...esp_1_1_timed_reaction__inherit__graph.map | 6 + ...esp_1_1_timed_reaction__inherit__graph.md5 | 1 + ...esp_1_1_timed_reaction__inherit__graph.svg | 66 +++ ...318817b65df5dee74911f863973063_icgraph.map | 11 + ...318817b65df5dee74911f863973063_icgraph.md5 | 1 + ...318817b65df5dee74911f863973063_icgraph.svg | 157 ++++++ ...eactesp_1_1_untimed_reaction-members.html} | 22 +- ...> classreactesp_1_1_untimed_reaction.html} | 108 ++-- .../classreactesp_1_1_untimed_reaction.js | 8 + ...tesp_1_1_untimed_reaction__coll__graph.map | 4 + ...tesp_1_1_untimed_reaction__coll__graph.md5 | 1 + ...tesp_1_1_untimed_reaction__coll__graph.svg | 36 ++ ...p_1_1_untimed_reaction__inherit__graph.map | 6 + ...p_1_1_untimed_reaction__inherit__graph.md5 | 1 + ...p_1_1_untimed_reaction__inherit__graph.svg | 66 +++ ...503862f7b8e8033a2f401c9152a283_icgraph.map | 8 + ...503862f7b8e8033a2f401c9152a283_icgraph.md5 | 1 + ...503862f7b8e8033a2f401c9152a283_icgraph.svg | 104 ++++ .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.js | 2 +- docs/generated/docs/files.html | 2 +- docs/generated/docs/functions.html | 69 ++- docs/generated/docs/functions_func.html | 59 ++- docs/generated/docs/functions_rela.html | 12 +- docs/generated/docs/functions_vars.html | 12 +- docs/generated/docs/globals.html | 25 +- docs/generated/docs/globals_defs.html | 8 +- docs/generated/docs/globals_func.html | 12 +- docs/generated/docs/globals_vars.html | 7 +- docs/generated/docs/graph_legend.dot | 25 - docs/generated/docs/graph_legend.html | 4 +- docs/generated/docs/graph_legend.md5 | 1 + docs/generated/docs/graph_legend.svg | 116 +++++ docs/generated/docs/hierarchy.html | 22 +- docs/generated/docs/hierarchy.js | 20 +- docs/generated/docs/index.html | 2 +- docs/generated/docs/inherit_graph_0.dot | 10 - docs/generated/docs/inherit_graph_0.map | 3 + docs/generated/docs/inherit_graph_0.md5 | 1 + docs/generated/docs/inherit_graph_0.svg | 21 + docs/generated/docs/inherit_graph_1.dot | 24 - docs/generated/docs/inherit_graph_1.map | 10 + docs/generated/docs/inherit_graph_1.md5 | 1 + docs/generated/docs/inherit_graph_1.svg | 126 +++++ docs/generated/docs/inherit_graph_2.dot | 10 - docs/generated/docs/inherit_graph_2.map | 3 + docs/generated/docs/inherit_graph_2.md5 | 1 + docs/generated/docs/inherit_graph_2.svg | 21 + docs/generated/docs/inherits.html | 8 +- docs/generated/docs/main_8cpp.html | 334 +++++++++++- docs/generated/docs/main_8cpp.js | 19 +- docs/generated/docs/main_8cpp__incl.dot | 20 - docs/generated/docs/main_8cpp__incl.map | 8 + docs/generated/docs/main_8cpp__incl.md5 | 1 + docs/generated/docs/main_8cpp__incl.svg | 102 ++++ ...e12b91752b35a5f3a628424fcd5d73b_cgraph.map | 5 + ...e12b91752b35a5f3a628424fcd5d73b_cgraph.md5 | 1 + ...e12b91752b35a5f3a628424fcd5d73b_cgraph.svg | 52 ++ ...12b91752b35a5f3a628424fcd5d73b_icgraph.map | 4 + ...12b91752b35a5f3a628424fcd5d73b_icgraph.md5 | 1 + ...12b91752b35a5f3a628424fcd5d73b_icgraph.svg | 36 ++ ...fc01d736fe50cf5b977f755b675f11d_cgraph.map | 17 + ...fc01d736fe50cf5b977f755b675f11d_cgraph.md5 | 1 + ...fc01d736fe50cf5b977f755b675f11d_cgraph.svg | 349 +++++++++++++ ...d736fe50cf5b977f755b675f11d_cgraph_org.svg | 261 ++++++++++ ...acc222e959363ee034cea9488ef627_icgraph.map | 6 + ...acc222e959363ee034cea9488ef627_icgraph.md5 | 1 + ...acc222e959363ee034cea9488ef627_icgraph.svg | 72 +++ ...b0ce963bacb63827eb79b51bc74a551_cgraph.map | 6 + ...b0ce963bacb63827eb79b51bc74a551_cgraph.md5 | 1 + ...b0ce963bacb63827eb79b51bc74a551_cgraph.svg | 67 +++ ...0ce963bacb63827eb79b51bc74a551_icgraph.map | 4 + ...0ce963bacb63827eb79b51bc74a551_icgraph.md5 | 1 + ...0ce963bacb63827eb79b51bc74a551_icgraph.svg | 36 ++ ...41a4d8986ed6c03bd6ad416ba134a4e_cgraph.map | 9 + ...41a4d8986ed6c03bd6ad416ba134a4e_cgraph.md5 | 1 + ...41a4d8986ed6c03bd6ad416ba134a4e_cgraph.svg | 114 ++++ ...1a4d8986ed6c03bd6ad416ba134a4e_icgraph.map | 4 + ...1a4d8986ed6c03bd6ad416ba134a4e_icgraph.md5 | 1 + ...1a4d8986ed6c03bd6ad416ba134a4e_icgraph.svg | 36 ++ ...359e12c4743a5b1888ac194c199674_icgraph.dot | 14 - ...bd20f4bed5cefc2278d071d9dafb01f_cgraph.map | 7 + ...bd20f4bed5cefc2278d071d9dafb01f_cgraph.md5 | 1 + ...bd20f4bed5cefc2278d071d9dafb01f_cgraph.svg | 83 +++ ...d20f4bed5cefc2278d071d9dafb01f_icgraph.map | 4 + ...d20f4bed5cefc2278d071d9dafb01f_icgraph.md5 | 1 + ...d20f4bed5cefc2278d071d9dafb01f_icgraph.svg | 36 ++ ...e461d27b9c48d5921c00d521181f12f_cgraph.map | 4 + ...e461d27b9c48d5921c00d521181f12f_cgraph.md5 | 1 + ...e461d27b9c48d5921c00d521181f12f_cgraph.svg | 37 ++ docs/generated/docs/main_8cpp_source.html | 196 +++++-- docs/generated/docs/menudata.js | 6 +- docs/generated/docs/namespacemembers.html | 106 ++++ ...s_type.html => namespacemembers_type.html} | 10 +- docs/generated/docs/namespacereactesp.html | 182 +++++++ docs/generated/docs/namespacereactesp.js | 15 + docs/generated/docs/namespaces.html | 120 +++++ docs/generated/docs/namespaces_dup.js | 4 + docs/generated/docs/navtreedata.js | 8 +- docs/generated/docs/navtreeindex0.js | 263 ++++++---- docs/generated/docs/search/all_0.js | 4 +- docs/generated/docs/search/all_1.js | 2 +- docs/generated/docs/search/all_2.js | 2 +- docs/generated/docs/search/all_3.js | 2 +- docs/generated/docs/search/all_4.js | 4 +- docs/generated/docs/search/all_5.js | 12 +- docs/generated/docs/search/all_6.js | 5 +- docs/generated/docs/search/all_8.js | 10 +- docs/generated/docs/search/all_9.js | 17 +- docs/generated/docs/search/all_a.js | 11 +- docs/generated/docs/search/all_b.js | 11 +- docs/generated/docs/search/all_c.js | 7 +- docs/generated/docs/search/all_d.js | 5 +- docs/generated/docs/search/all_e.html | 37 ++ docs/generated/docs/search/all_e.js | 7 + docs/generated/docs/search/classes_0.js | 2 +- docs/generated/docs/search/classes_1.js | 2 +- docs/generated/docs/search/classes_2.js | 6 +- docs/generated/docs/search/classes_3.js | 2 +- docs/generated/docs/search/classes_4.js | 6 +- docs/generated/docs/search/classes_5.js | 2 +- docs/generated/docs/search/defines_0.js | 3 +- docs/generated/docs/search/defines_1.html | 37 ++ docs/generated/docs/search/defines_1.js | 4 + docs/generated/docs/search/defines_2.html | 37 ++ docs/generated/docs/search/defines_2.js | 4 + docs/generated/docs/search/defines_3.html | 37 ++ docs/generated/docs/search/defines_3.js | 4 + docs/generated/docs/search/functions_0.js | 2 +- docs/generated/docs/search/functions_1.js | 2 +- docs/generated/docs/search/functions_2.js | 4 +- docs/generated/docs/search/functions_3.js | 5 +- docs/generated/docs/search/functions_4.js | 2 +- docs/generated/docs/search/functions_5.js | 18 +- docs/generated/docs/search/functions_6.js | 9 +- docs/generated/docs/search/functions_7.js | 8 +- docs/generated/docs/search/functions_8.js | 6 +- docs/generated/docs/search/functions_9.js | 2 +- docs/generated/docs/search/functions_a.js | 8 +- docs/generated/docs/search/namespaces_0.html | 37 ++ docs/generated/docs/search/namespaces_0.js | 4 + docs/generated/docs/search/related_0.js | 2 +- docs/generated/docs/search/related_1.js | 4 +- docs/generated/docs/search/related_2.js | 2 +- docs/generated/docs/search/related_3.js | 2 +- docs/generated/docs/search/searchdata.js | 41 +- docs/generated/docs/search/typedefs_0.js | 2 +- docs/generated/docs/search/typedefs_1.js | 2 +- docs/generated/docs/search/variables_0.js | 2 +- docs/generated/docs/search/variables_1.js | 2 +- docs/generated/docs/search/variables_2.js | 2 +- docs/generated/docs/search/variables_3.js | 2 +- docs/generated/docs/search/variables_4.js | 2 +- docs/generated/docs/search/variables_5.js | 3 +- .../docs/struct_trigger_time_compare.js | 4 - ...esp_1_1_trigger_time_compare-members.html} | 10 +- ...uctreactesp_1_1_trigger_time_compare.html} | 30 +- ...structreactesp_1_1_trigger_time_compare.js | 4 + 335 files changed, 8230 insertions(+), 3807 deletions(-) delete mode 100644 docs/generated/docs/_react_e_s_p_8cpp.js delete mode 100644 docs/generated/docs/_react_e_s_p_8cpp__incl.dot create mode 100644 docs/generated/docs/_react_e_s_p_8cpp__incl.map create mode 100644 docs/generated/docs/_react_e_s_p_8cpp__incl.md5 create mode 100644 docs/generated/docs/_react_e_s_p_8cpp__incl.svg delete mode 100644 docs/generated/docs/_react_e_s_p_8cpp_a0b33edabd7f1c4e4a0bf32c67269be2f_cgraph.dot delete mode 100644 docs/generated/docs/_react_e_s_p_8cpp_a7dfd9b79bc5a37d7df40207afbc5431f_cgraph.dot delete mode 100644 docs/generated/docs/_react_e_s_p_8h__dep__incl.dot create mode 100644 docs/generated/docs/_react_e_s_p_8h__dep__incl.map create mode 100644 docs/generated/docs/_react_e_s_p_8h__dep__incl.md5 create mode 100644 docs/generated/docs/_react_e_s_p_8h__dep__incl.svg delete mode 100644 docs/generated/docs/_react_e_s_p_8h__incl.dot create mode 100644 docs/generated/docs/_react_e_s_p_8h__incl.map create mode 100644 docs/generated/docs/_react_e_s_p_8h__incl.md5 create mode 100644 docs/generated/docs/_react_e_s_p_8h__incl.svg delete mode 100644 docs/generated/docs/class_delay_reaction-members.html delete mode 100644 docs/generated/docs/class_delay_reaction.html delete mode 100644 docs/generated/docs/class_delay_reaction.js delete mode 100644 docs/generated/docs/class_delay_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_delay_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_i_s_r_reaction.js delete mode 100644 docs/generated/docs/class_i_s_r_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_i_s_r_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_cgraph.dot delete mode 100644 docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_icgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p-members.html delete mode 100644 docs/generated/docs/class_react_e_s_p.js delete mode 100644 docs/generated/docs/class_react_e_s_p__coll__graph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_a02ce0511803b0d3a1fcec6bc56ff8b3f_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_a2a7018e7a5e89634e8e4385be51eafd4_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_a7da68d41f2a9790ab1aec2610bad07eb_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_a831c11dd7f1a6e15d70785c3a990df93_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_aa26556a0954d117dc5b8d925e5924cdf_icgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_ab26769ff3e426972e87746749560ffc0_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_ad5739bf0fedb24931f98762113161e95_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_adb20144bde6e60b41e484d2f6f61d0f5_cgraph.dot delete mode 100644 docs/generated/docs/class_react_e_s_p_aeefac464d9df930d020a321a63cdcf4b_icgraph.dot delete mode 100644 docs/generated/docs/class_reaction.js delete mode 100644 docs/generated/docs/class_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_repeat_reaction-members.html delete mode 100644 docs/generated/docs/class_repeat_reaction.html delete mode 100644 docs/generated/docs/class_repeat_reaction.js delete mode 100644 docs/generated/docs/class_repeat_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_repeat_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_stream_reaction.html delete mode 100644 docs/generated/docs/class_stream_reaction.js delete mode 100644 docs/generated/docs/class_stream_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_stream_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_tick_reaction.html delete mode 100644 docs/generated/docs/class_tick_reaction.js delete mode 100644 docs/generated/docs/class_tick_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_tick_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_timed_reaction-members.html delete mode 100644 docs/generated/docs/class_timed_reaction.js delete mode 100644 docs/generated/docs/class_timed_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_timed_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_timed_reaction_a163d0232141ebe0d446d853969766a69_icgraph.dot delete mode 100644 docs/generated/docs/class_untimed_reaction.js delete mode 100644 docs/generated/docs/class_untimed_reaction__coll__graph.dot delete mode 100644 docs/generated/docs/class_untimed_reaction__inherit__graph.dot delete mode 100644 docs/generated/docs/class_untimed_reaction_aaf8d78a83d9c8174a2e069cb6279a793_icgraph.dot create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction-members.html create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction.html create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.svg rename docs/generated/docs/{class_untimed_reaction-members.html => classreactesp_1_1_i_s_r_reaction-members.html} (60%) rename docs/generated/docs/{class_i_s_r_reaction.html => classreactesp_1_1_i_s_r_reaction.html} (52%) create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p-members.html rename docs/generated/docs/{class_react_e_s_p.html => classreactesp_1_1_react_e_s_p.html} (52%) create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p.js create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.svg rename docs/generated/docs/{class_reaction-members.html => classreactesp_1_1_reaction-members.html} (68%) rename docs/generated/docs/{class_reaction.html => classreactesp_1_1_reaction.html} (57%) create mode 100644 docs/generated/docs/classreactesp_1_1_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction-members.html create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction.html create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.svg rename docs/generated/docs/{class_tick_reaction-members.html => classreactesp_1_1_stream_reaction-members.html} (57%) create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction.html create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.svg rename docs/generated/docs/{class_stream_reaction-members.html => classreactesp_1_1_tick_reaction-members.html} (57%) create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction.html create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction-members.html rename docs/generated/docs/{class_timed_reaction.html => classreactesp_1_1_timed_reaction.html} (51%) create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.svg rename docs/generated/docs/{class_i_s_r_reaction-members.html => classreactesp_1_1_untimed_reaction-members.html} (60%) rename docs/generated/docs/{class_untimed_reaction.html => classreactesp_1_1_untimed_reaction.html} (54%) create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction.js create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.map create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.svg create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.map create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.md5 create mode 100644 docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.svg delete mode 100644 docs/generated/docs/graph_legend.dot create mode 100644 docs/generated/docs/graph_legend.md5 create mode 100644 docs/generated/docs/graph_legend.svg delete mode 100644 docs/generated/docs/inherit_graph_0.dot create mode 100644 docs/generated/docs/inherit_graph_0.map create mode 100644 docs/generated/docs/inherit_graph_0.md5 create mode 100644 docs/generated/docs/inherit_graph_0.svg delete mode 100644 docs/generated/docs/inherit_graph_1.dot create mode 100644 docs/generated/docs/inherit_graph_1.map create mode 100644 docs/generated/docs/inherit_graph_1.md5 create mode 100644 docs/generated/docs/inherit_graph_1.svg delete mode 100644 docs/generated/docs/inherit_graph_2.dot create mode 100644 docs/generated/docs/inherit_graph_2.map create mode 100644 docs/generated/docs/inherit_graph_2.md5 create mode 100644 docs/generated/docs/inherit_graph_2.svg delete mode 100644 docs/generated/docs/main_8cpp__incl.dot create mode 100644 docs/generated/docs/main_8cpp__incl.map create mode 100644 docs/generated/docs/main_8cpp__incl.md5 create mode 100644 docs/generated/docs/main_8cpp__incl.svg create mode 100644 docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.map create mode 100644 docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.svg create mode 100644 docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.map create mode 100644 docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.svg create mode 100644 docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.map create mode 100644 docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.svg create mode 100644 docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph_org.svg create mode 100644 docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.map create mode 100644 docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.svg create mode 100644 docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.map create mode 100644 docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.svg create mode 100644 docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.map create mode 100644 docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.svg create mode 100644 docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.map create mode 100644 docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.svg create mode 100644 docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.map create mode 100644 docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.svg delete mode 100644 docs/generated/docs/main_8cpp_aa6359e12c4743a5b1888ac194c199674_icgraph.dot create mode 100644 docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.map create mode 100644 docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.svg create mode 100644 docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.map create mode 100644 docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.svg create mode 100644 docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.map create mode 100644 docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.md5 create mode 100644 docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.svg create mode 100644 docs/generated/docs/namespacemembers.html rename docs/generated/docs/{globals_type.html => namespacemembers_type.html} (90%) create mode 100644 docs/generated/docs/namespacereactesp.html create mode 100644 docs/generated/docs/namespacereactesp.js create mode 100644 docs/generated/docs/namespaces.html create mode 100644 docs/generated/docs/namespaces_dup.js create mode 100644 docs/generated/docs/search/all_e.html create mode 100644 docs/generated/docs/search/all_e.js create mode 100644 docs/generated/docs/search/defines_1.html create mode 100644 docs/generated/docs/search/defines_1.js create mode 100644 docs/generated/docs/search/defines_2.html create mode 100644 docs/generated/docs/search/defines_2.js create mode 100644 docs/generated/docs/search/defines_3.html create mode 100644 docs/generated/docs/search/defines_3.js create mode 100644 docs/generated/docs/search/namespaces_0.html create mode 100644 docs/generated/docs/search/namespaces_0.js delete mode 100644 docs/generated/docs/struct_trigger_time_compare.js rename docs/generated/docs/{struct_trigger_time_compare-members.html => structreactesp_1_1_trigger_time_compare-members.html} (84%) rename docs/generated/docs/{struct_trigger_time_compare.html => structreactesp_1_1_trigger_time_compare.html} (76%) create mode 100644 docs/generated/docs/structreactesp_1_1_trigger_time_compare.js diff --git a/docs/generated/docs/_react_e_s_p_8cpp.html b/docs/generated/docs/_react_e_s_p_8cpp.html index 621f92a..fd838ef 100644 --- a/docs/generated/docs/_react_e_s_p_8cpp.html +++ b/docs/generated/docs/_react_e_s_p_8cpp.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -91,7 +91,7 @@
ReactESP.cpp File Reference
@@ -102,72 +102,17 @@
Include dependency graph for ReactESP.cpp:
-
+

Go to the source code of this file.

- - - - - + + +

-Functions

void setup (void)
 
void loop (void)
 

+Namespaces

namespace  reactesp
 
-

Function Documentation

- -

◆ loop()

- -
-
- - - - - - - - -
void loop (void )
-
- -

Definition at line 109 of file ReactESP.cpp.

-
-Here is the call graph for this function:
-
-
-
-
- -
-
- -

◆ setup()

- -
-
- - - - - - - - -
void setup (void )
-
- -

Definition at line 107 of file ReactESP.cpp.

-
-Here is the call graph for this function:
-
-
-
-
- -
-
diff --git a/docs/generated/docs/_react_e_s_p_8cpp.js b/docs/generated/docs/_react_e_s_p_8cpp.js deleted file mode 100644 index ff8aca6..0000000 --- a/docs/generated/docs/_react_e_s_p_8cpp.js +++ /dev/null @@ -1,5 +0,0 @@ -var _react_e_s_p_8cpp = -[ - [ "loop", "_react_e_s_p_8cpp.html#a0b33edabd7f1c4e4a0bf32c67269be2f", null ], - [ "setup", "_react_e_s_p_8cpp.html#a7dfd9b79bc5a37d7df40207afbc5431f", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/_react_e_s_p_8cpp__incl.dot b/docs/generated/docs/_react_e_s_p_8cpp__incl.dot deleted file mode 100644 index d9e1cfb..0000000 --- a/docs/generated/docs/_react_e_s_p_8cpp__incl.dot +++ /dev/null @@ -1,24 +0,0 @@ -digraph "src/ReactESP.cpp" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="src/ReactESP.cpp",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ReactESP.h",height=0.2,width=0.4,color="black",URL="$_react_e_s_p_8h.html",tooltip=" "]; - Node2 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Arduino.h",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node2 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="forward_list",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node2 -> Node5 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node5 [label="functional",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node2 -> Node6 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node6 [label="queue",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node1 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node1 -> Node7 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node7 [label="FunctionalInterrupt.h",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node1 -> Node8 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node8 [label="string.h",height=0.2,width=0.4,color="grey75",tooltip=" "]; -} diff --git a/docs/generated/docs/_react_e_s_p_8cpp__incl.map b/docs/generated/docs/_react_e_s_p_8cpp__incl.map new file mode 100644 index 0000000..71fbb6f --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8cpp__incl.map @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docs/generated/docs/_react_e_s_p_8cpp__incl.md5 b/docs/generated/docs/_react_e_s_p_8cpp__incl.md5 new file mode 100644 index 0000000..895f8b7 --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8cpp__incl.md5 @@ -0,0 +1 @@ +47f003e2bc519a94d540a6f1430ed492 \ No newline at end of file diff --git a/docs/generated/docs/_react_e_s_p_8cpp__incl.svg b/docs/generated/docs/_react_e_s_p_8cpp__incl.svg new file mode 100644 index 0000000..60601db --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8cpp__incl.svg @@ -0,0 +1,132 @@ + + + + + + +src/ReactESP.cpp + + +Node1 + + +src/ReactESP.cpp + + + + + +Node2 + + +ReactESP.h + + + + + +Node1->Node2 + + + + + +Node3 + + +Arduino.h + + + + + +Node1->Node3 + + + + + +Node7 + + +FunctionalInterrupt.h + + + + + +Node1->Node7 + + + + + +Node8 + + +string.h + + + + + +Node1->Node8 + + + + + +Node2->Node3 + + + + + +Node4 + + +forward_list + + + + + +Node2->Node4 + + + + + +Node5 + + +functional + + + + + +Node2->Node5 + + + + + +Node6 + + +queue + + + + + +Node2->Node6 + + + + + diff --git a/docs/generated/docs/_react_e_s_p_8cpp_a0b33edabd7f1c4e4a0bf32c67269be2f_cgraph.dot b/docs/generated/docs/_react_e_s_p_8cpp_a0b33edabd7f1c4e4a0bf32c67269be2f_cgraph.dot deleted file mode 100644 index d03b341..0000000 --- a/docs/generated/docs/_react_e_s_p_8cpp_a0b33edabd7f1c4e4a0bf32c67269be2f_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "loop" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="loop",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ReactESP::tick",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#aeefac464d9df930d020a321a63cdcf4b",tooltip=" "]; -} diff --git a/docs/generated/docs/_react_e_s_p_8cpp_a7dfd9b79bc5a37d7df40207afbc5431f_cgraph.dot b/docs/generated/docs/_react_e_s_p_8cpp_a7dfd9b79bc5a37d7df40207afbc5431f_cgraph.dot deleted file mode 100644 index d7c3c09..0000000 --- a/docs/generated/docs/_react_e_s_p_8cpp_a7dfd9b79bc5a37d7df40207afbc5431f_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "setup" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="setup",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ReactESP::setup",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#aa26556a0954d117dc5b8d925e5924cdf",tooltip=" "]; -} diff --git a/docs/generated/docs/_react_e_s_p_8cpp_source.html b/docs/generated/docs/_react_e_s_p_8cpp_source.html index 6bd6d21..7e03d03 100644 --- a/docs/generated/docs/_react_e_s_p_8cpp_source.html +++ b/docs/generated/docs/_react_e_s_p_8cpp_source.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -99,230 +99,224 @@
4#include <FunctionalInterrupt.h>
5#include <string.h>
6
-
14#ifdef ESP32
-
15uint64_t ICACHE_RAM_ATTR micros64() { return esp_timer_get_time(); }
-
16#endif
-
17
-
18// Reaction classes define the behaviour of each particular
-
19// Reaction
-
20
- -
22 return (this->last_trigger_time + this->interval) <
-
23 (other.last_trigger_time + other.interval);
-
24}
-
25
-
26void TimedReaction::add() { ReactESP::app->timed_queue.push(this); }
+
7namespace reactesp {
+
8
+
16#ifdef ESP32
+
17uint64_t ICACHE_RAM_ATTR micros64() { return esp_timer_get_time(); }
+
18#endif
+
19
+
20// Reaction classes define the behaviour of each particular
+
21// Reaction
+
22
+ +
24 return (this->last_trigger_time + this->interval) <
+
25 (other.last_trigger_time + other.interval);
+
26}
27
- -
29 this->enabled = false;
-
30 // the object will be deleted when it's popped out of the
-
31 // timer queue
-
32}
-
33
-
34DelayReaction::DelayReaction(uint32_t interval, const react_callback callback)
-
35 : TimedReaction(interval, callback) {
-
36 this->last_trigger_time = micros64();
-
37}
-
38
-
39DelayReaction::DelayReaction(uint64_t interval, const react_callback callback)
-
40 : TimedReaction(interval, callback) {
-
41 this->last_trigger_time = micros64();
-
42}
-
43
- -
45 this->last_trigger_time = micros64();
-
46 this->callback();
-
47 delete this;
-
48}
-
49
- -
51 auto now = micros64();
-
52 this->last_trigger_time = this->last_trigger_time + this->interval;
-
53 if (this->last_trigger_time + this->interval < now) {
-
54 // we're lagging more than one full interval; reset the time
-
55 this->last_trigger_time = now;
-
56 }
-
57 this->callback();
-
58 ReactESP::app->timed_queue.push(this);
-
59}
-
60
-
61void UntimedReaction::add() { ReactESP::app->untimed_list.push_front(this); }
+
28void TimedReaction::add() { ReactESP::app->timed_queue.push(this); }
+
29
+ +
31 this->enabled = false;
+
32 // the object will be deleted when it's popped out of the
+
33 // timer queue
+
34}
+
35
+
36DelayReaction::DelayReaction(uint32_t interval, const react_callback callback)
+
37 : TimedReaction(interval, callback) {
+
38 this->last_trigger_time = micros64();
+
39}
+
40
+
41DelayReaction::DelayReaction(uint64_t interval, const react_callback callback)
+
42 : TimedReaction(interval, callback) {
+
43 this->last_trigger_time = micros64();
+
44}
+
45
+ +
47 this->last_trigger_time = micros64();
+
48 this->callback();
+
49 delete this;
+
50}
+
51
+ +
53 auto now = micros64();
+
54 this->last_trigger_time = this->last_trigger_time + this->interval;
+
55 if (this->last_trigger_time + this->interval < now) {
+
56 // we're lagging more than one full interval; reset the time
+
57 this->last_trigger_time = now;
+
58 }
+
59 this->callback();
+
60 ReactESP::app->timed_queue.push(this);
+
61}
62
- -
64 ReactESP::app->untimed_list.remove(this);
-
65 delete this;
-
66}
-
67
- -
69 if (stream.available()) {
-
70 this->callback();
-
71 }
-
72}
-
73
-
74void TickReaction::tick() { this->callback(); }
+
63void UntimedReaction::add() { ReactESP::app->untimed_list.push_front(this); }
+
64
+ +
66 ReactESP::app->untimed_list.remove(this);
+
67 delete this;
+
68}
+
69
+ +
71 if (stream.available()) {
+
72 this->callback();
+
73 }
+
74}
75
-
76#ifdef ESP32
-
77bool ISRReaction::isr_service_installed = false;
-
78
-
79void ISRReaction::isr(void* this_ptr) {
-
80 auto* this_ = (ISRReaction*)this_ptr;
-
81 this_->callback();
-
82}
-
83#endif
-
84
- -
86#ifdef ESP32
-
87 gpio_isr_handler_add((gpio_num_t)pin_number, ISRReaction::isr, (void*)this);
-
88#elif defined(ESP8266)
-
89 attachInterrupt(digitalPinToInterrupt(pin_number), callback, mode);
-
90#endif
-
91 ReactESP::app->isr_reaction_list.push_front(this);
-
92}
-
93
- -
95 ReactESP::app->isr_reaction_list.remove(this);
-
96#ifdef ESP32
-
97 gpio_isr_handler_remove((gpio_num_t)pin_number);
-
98#elif defined(ESP8266)
-
99 detachInterrupt(digitalPinToInterrupt(this->pin_number));
-
100#endif
-
101 delete this;
-
102}
-
103
-
104// Need to define the static variable outside of the class
-
105ReactESP* ReactESP::app = NULL;
-
106
-
107void setup(void) { ReactESP::app->setup(); }
+
76void TickReaction::tick() { this->callback(); }
+
77
+
78#ifdef ESP32
+
79bool ISRReaction::isr_service_installed = false;
+
80
+
81void ISRReaction::isr(void* this_ptr) {
+
82 auto* this_ = (ISRReaction*)this_ptr;
+
83 this_->callback();
+
84}
+
85#endif
+
86
+ +
88#ifdef ESP32
+
89 gpio_isr_handler_add((gpio_num_t)pin_number, ISRReaction::isr, (void*)this);
+
90#elif defined(ESP8266)
+
91 attachInterrupt(digitalPinToInterrupt(pin_number), callback, mode);
+
92#endif
+
93 ReactESP::app->isr_reaction_list.push_front(this);
+
94}
+
95
+ +
97 ReactESP::app->isr_reaction_list.remove(this);
+
98#ifdef ESP32
+
99 gpio_isr_handler_remove((gpio_num_t)pin_number);
+
100#elif defined(ESP8266)
+
101 detachInterrupt(digitalPinToInterrupt(this->pin_number));
+
102#endif
+
103 delete this;
+
104}
+
105
+
106// Need to define the static variable outside of the class
+
107ReactESP* ReactESP::app = NULL;
108
-
109void loop(void) {
- -
111 yield();
-
112}
+
109void ReactESP::tickTimed() {
+
110 uint64_t now = micros64();
+
111 uint64_t trigger_t;
+
112 TimedReaction* top;
113
-
114void ReactESP::tickTimed() {
-
115 uint64_t now = micros64();
-
116 uint64_t trigger_t;
-
117 TimedReaction* top;
-
118
-
119 while (true) {
-
120 if (timed_queue.empty()) {
-
121 break;
-
122 }
-
123 top = timed_queue.top();
-
124 if (!top->isEnabled()) {
-
125 timed_queue.pop();
-
126 delete top;
-
127 continue;
-
128 }
-
129 trigger_t = top->getTriggerTimeMicros();
-
130 if (now >= trigger_t) {
-
131 timed_queue.pop();
-
132 top->tick();
-
133 } else {
-
134 break;
-
135 }
-
136 }
-
137}
-
138
-
139void ReactESP::tickUntimed() {
-
140 for (UntimedReaction* re : this->untimed_list) {
-
141 re->tick();
-
142 }
+
114 while (true) {
+
115 if (timed_queue.empty()) {
+
116 break;
+
117 }
+
118 top = timed_queue.top();
+
119 if (!top->isEnabled()) {
+
120 timed_queue.pop();
+
121 delete top;
+
122 continue;
+
123 }
+
124 trigger_t = top->getTriggerTimeMicros();
+
125 if (now >= trigger_t) {
+
126 timed_queue.pop();
+
127 top->tick();
+
128 } else {
+
129 break;
+
130 }
+
131 }
+
132}
+
133
+
134void ReactESP::tickUntimed() {
+
135 for (UntimedReaction* re : this->untimed_list) {
+
136 re->tick();
+
137 }
+
138}
+
139
+ +
141 tickUntimed();
+
142 tickTimed();
143}
144
- -
146 tickUntimed();
-
147 tickTimed();
-
148}
-
149
-
150DelayReaction* ReactESP::onDelay(const uint32_t t, const react_callback cb) {
-
151 DelayReaction* dre = new DelayReaction(t, cb);
-
152 dre->add();
-
153 return dre;
-
154}
-
155
- -
157 const react_callback cb) {
-
158 DelayReaction* dre = new DelayReaction(t, cb);
-
159 dre->add();
-
160 return dre;
-
161}
-
162
- -
164 RepeatReaction* rre = new RepeatReaction(t, cb);
-
165 rre->add();
-
166 return rre;
-
167}
-
168
- -
170 const react_callback cb) {
-
171 RepeatReaction* rre = new RepeatReaction(t, cb);
-
172 rre->add();
-
173 return rre;
-
174}
-
175
- -
177 StreamReaction* sre = new StreamReaction(stream, cb);
-
178 sre->add();
-
179 return sre;
-
180}
-
181
-
182ISRReaction* ReactESP::onInterrupt(const uint8_t pin_number, int mode,
-
183 const react_callback cb) {
-
184 ISRReaction* isrre = new ISRReaction(pin_number, mode, cb);
-
185 isrre->add();
-
186 return isrre;
-
187}
-
188
- -
190 TickReaction* tre = new TickReaction(cb);
-
191 tre->add();
-
192 return tre;
-
193}
-
void loop(void)
Definition: ReactESP.cpp:109
-
void setup(void)
Definition: ReactESP.cpp:107
+
145DelayReaction* ReactESP::onDelay(const uint32_t t, const react_callback cb) {
+
146 DelayReaction* dre = new DelayReaction(t, cb);
+
147 dre->add();
+
148 return dre;
+
149}
+
150
+ +
152 const react_callback cb) {
+
153 DelayReaction* dre = new DelayReaction(t, cb);
+
154 dre->add();
+
155 return dre;
+
156}
+
157
+ +
159 RepeatReaction* rre = new RepeatReaction(t, cb);
+
160 rre->add();
+
161 return rre;
+
162}
+
163
+ +
165 const react_callback cb) {
+
166 RepeatReaction* rre = new RepeatReaction(t, cb);
+
167 rre->add();
+
168 return rre;
+
169}
+
170
+ +
172 StreamReaction* sre = new StreamReaction(stream, cb);
+
173 sre->add();
+
174 return sre;
+
175}
+
176
+
177ISRReaction* ReactESP::onInterrupt(const uint8_t pin_number, int mode,
+
178 const react_callback cb) {
+
179 ISRReaction* isrre = new ISRReaction(pin_number, mode, cb);
+
180 isrre->add();
+
181 return isrre;
+
182}
+
183
+ +
185 TickReaction* tre = new TickReaction(cb);
+
186 tre->add();
+
187 return tre;
+
188}
+
189
+
190} // namespace reactesp
-
std::function< void()> react_callback
Definition: ReactESP.h:10
-
Reaction that is triggered after a certain time delay.
Definition: ReactESP.h:92
-
DelayReaction(const uint32_t delay, const react_callback callback)
Construct a new Delay Reaction object.
Definition: ReactESP.cpp:34
-
void tick()
Definition: ReactESP.cpp:44
-
Reaction that is triggered on an input pin change.
Definition: ReactESP.h:185
-
void remove()
Definition: ReactESP.cpp:94
-
void add()
Definition: ReactESP.cpp:85
-
Main class of a ReactESP program.
Definition: ReactESP.h:245
-
ISRReaction * onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)
Create a new ISRReaction (interrupt reaction)
Definition: ReactESP.cpp:182
-
static ReactESP * app
Static singleton reference to the instantiated ReactESP object.
Definition: ReactESP.h:265
-
RepeatReaction * onRepeatMicros(const uint64_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:169
-
friend class RepeatReaction
Definition: ReactESP.h:248
-
friend class ISRReaction
Definition: ReactESP.h:250
-
TickReaction * onTick(const react_callback cb)
Create a new TickReaction.
Definition: ReactESP.cpp:189
-
StreamReaction * onAvailable(Stream &stream, const react_callback cb)
Create a new StreamReaction.
Definition: ReactESP.cpp:176
-
void setup(void)
Definition: ReactESP.h:261
-
DelayReaction * onDelay(const uint32_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:150
-
DelayReaction * onDelayMicros(const uint64_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:156
-
RepeatReaction * onRepeat(const uint32_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:163
-
void tick(void)
Definition: ReactESP.cpp:145
-
const react_callback callback
Definition: ReactESP.h:27
-
Reaction that is triggered repeatedly.
Definition: ReactESP.h:115
- -
Reaction that is triggered when there is input available at the given Arduino Stream.
Definition: ReactESP.h:152
- -
Reaction that is triggered unconditionally at each execution loop.
Definition: ReactESP.h:171
-
void tick()
Definition: ReactESP.cpp:74
-
TimedReactions are called based on elapsing of time.
Definition: ReactESP.h:45
-
void add()
Definition: ReactESP.cpp:26
-
uint64_t last_trigger_time
Definition: ReactESP.h:48
-
bool operator<(const TimedReaction &other)
Return the current time since the device restart in microseconds.
Definition: ReactESP.cpp:21
-
uint64_t getTriggerTimeMicros()
Definition: ReactESP.h:80
-
virtual void tick()=0
-
void remove()
Definition: ReactESP.cpp:28
-
const uint64_t interval
Definition: ReactESP.h:47
-
bool enabled
Definition: ReactESP.h:49
-
bool isEnabled()
Definition: ReactESP.h:81
-
Reactions that are triggered based on something else than time.
Definition: ReactESP.h:139
-
virtual void remove()
Definition: ReactESP.cpp:63
-
virtual void add()
Definition: ReactESP.cpp:61
-
void ICACHE_RAM_ATTR isr()
Definition: main.cpp:18
+
Reaction that is triggered after a certain time delay.
Definition: ReactESP.h:94
+
DelayReaction(const uint32_t delay, const react_callback callback)
Construct a new Delay Reaction object.
Definition: ReactESP.cpp:36
+ +
Reaction that is triggered on an input pin change.
Definition: ReactESP.h:187
+ + +
Main class of a ReactESP program.
Definition: ReactESP.h:247
+
StreamReaction * onAvailable(Stream &stream, const react_callback cb)
Create a new StreamReaction.
Definition: ReactESP.cpp:171
+
DelayReaction * onDelayMicros(const uint64_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:151
+
friend class RepeatReaction
Definition: ReactESP.h:250
+
DelayReaction * onDelay(const uint32_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:145
+
friend class ISRReaction
Definition: ReactESP.h:252
+
void tick(void)
Definition: ReactESP.cpp:140
+
static ReactESP * app
Static singleton reference to the instantiated ReactESP object.
Definition: ReactESP.h:262
+
RepeatReaction * onRepeat(const uint32_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:158
+
friend class UntimedReaction
Definition: ReactESP.h:251
+
RepeatReaction * onRepeatMicros(const uint64_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:164
+
TickReaction * onTick(const react_callback cb)
Create a new TickReaction.
Definition: ReactESP.cpp:184
+
ISRReaction * onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)
Create a new ISRReaction (interrupt reaction)
Definition: ReactESP.cpp:177
+
const react_callback callback
Definition: ReactESP.h:29
+
Reaction that is triggered repeatedly.
Definition: ReactESP.h:117
+ +
Reaction that is triggered when there is input available at the given Arduino Stream.
Definition: ReactESP.h:154
+ +
Reaction that is triggered unconditionally at each execution loop.
Definition: ReactESP.h:173
+ +
TimedReactions are called based on elapsing of time.
Definition: ReactESP.h:47
+ + +
bool operator<(const TimedReaction &other)
Return the current time since the device restart in microseconds.
Definition: ReactESP.cpp:23
+
virtual void tick()=0
+ +
uint64_t getTriggerTimeMicros()
Definition: ReactESP.h:82
+
const uint64_t interval
Definition: ReactESP.h:49
+ +
uint64_t last_trigger_time
Definition: ReactESP.h:50
+
virtual void remove()
Definition: ReactESP.cpp:65
+
virtual void add()
Definition: ReactESP.cpp:63
+ +
std::function< void()> react_callback
Definition: ReactESP.h:12
diff --git a/docs/generated/docs/_react_e_s_p_8h.html b/docs/generated/docs/_react_e_s_p_8h.html index 6d3ae8d..f7b8053 100644 --- a/docs/generated/docs/_react_e_s_p_8h.html +++ b/docs/generated/docs/_react_e_s_p_8h.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -92,6 +92,7 @@
ReactESP.h File Reference
@@ -103,13 +104,13 @@
Include dependency graph for ReactESP.h:
-
+
This graph shows which files directly or indirectly include this file:
-
+
@@ -117,76 +118,48 @@ - - + + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + +

Classes

class  Reaction
 Reactions are code to be called when a given condition is fulfilled. More...
class  reactesp::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...
class  reactesp::TimedReaction
 TimedReactions are called based on elapsing of time. More...
 
struct  TriggerTimeCompare
struct  reactesp::TriggerTimeCompare
 
class  DelayReaction
 Reaction that is triggered after a certain time delay. More...
class  reactesp::DelayReaction
 Reaction that is triggered after a certain time delay. More...
 
class  RepeatReaction
 Reaction that is triggered repeatedly. More...
class  reactesp::RepeatReaction
 Reaction that is triggered repeatedly. More...
 
class  UntimedReaction
 Reactions that are triggered based on something else than time. More...
class  reactesp::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  reactesp::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  reactesp::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::ISRReaction
 Reaction that is triggered on an input pin change. More...
 
class  ReactESP
 Main class of a ReactESP program. More...
class  reactesp::ReactESP
 Main class of a ReactESP program. More...
 
+ +

+Namespaces

namespace  reactesp
 
- - - - + + + +

Typedefs

typedef std::function< void()> react_callback
 
typedef void(* isr_react_callback) (void *)
 
typedef std::function< void()> reactesp::react_callback
 
typedef void(* reactesp::isr_react_callback) (void *)
 
-

Typedef Documentation

- -

◆ isr_react_callback

- -
-
- - - - -
typedef void(* isr_react_callback) (void *)
-
- -

Definition at line 11 of file ReactESP.h.

- -
-
- -

◆ react_callback

- -
-
- - - - -
typedef std::function<void()> react_callback
-
- -

Definition at line 10 of file ReactESP.h.

- -
-
diff --git a/docs/generated/docs/_react_e_s_p_8h.js b/docs/generated/docs/_react_e_s_p_8h.js index 0e160e3..ceb0ca4 100644 --- a/docs/generated/docs/_react_e_s_p_8h.js +++ b/docs/generated/docs/_react_e_s_p_8h.js @@ -1,15 +1,15 @@ var _react_e_s_p_8h = [ - [ "Reaction", "class_reaction.html", "class_reaction" ], - [ "TimedReaction", "class_timed_reaction.html", "class_timed_reaction" ], - [ "TriggerTimeCompare", "struct_trigger_time_compare.html", "struct_trigger_time_compare" ], - [ "DelayReaction", "class_delay_reaction.html", "class_delay_reaction" ], - [ "RepeatReaction", "class_repeat_reaction.html", "class_repeat_reaction" ], - [ "UntimedReaction", "class_untimed_reaction.html", "class_untimed_reaction" ], - [ "StreamReaction", "class_stream_reaction.html", "class_stream_reaction" ], - [ "TickReaction", "class_tick_reaction.html", "class_tick_reaction" ], - [ "ISRReaction", "class_i_s_r_reaction.html", "class_i_s_r_reaction" ], - [ "ReactESP", "class_react_e_s_p.html", "class_react_e_s_p" ], - [ "isr_react_callback", "_react_e_s_p_8h.html#a67b5c9351881150cba489e7594e0c976", null ], - [ "react_callback", "_react_e_s_p_8h.html#aced18b35574cdf9238eeb6d2c997db7f", null ] + [ "reactesp::Reaction", "classreactesp_1_1_reaction.html", "classreactesp_1_1_reaction" ], + [ "reactesp::TimedReaction", "classreactesp_1_1_timed_reaction.html", "classreactesp_1_1_timed_reaction" ], + [ "reactesp::TriggerTimeCompare", "structreactesp_1_1_trigger_time_compare.html", "structreactesp_1_1_trigger_time_compare" ], + [ "reactesp::DelayReaction", "classreactesp_1_1_delay_reaction.html", "classreactesp_1_1_delay_reaction" ], + [ "reactesp::RepeatReaction", "classreactesp_1_1_repeat_reaction.html", "classreactesp_1_1_repeat_reaction" ], + [ "reactesp::UntimedReaction", "classreactesp_1_1_untimed_reaction.html", "classreactesp_1_1_untimed_reaction" ], + [ "reactesp::StreamReaction", "classreactesp_1_1_stream_reaction.html", "classreactesp_1_1_stream_reaction" ], + [ "reactesp::TickReaction", "classreactesp_1_1_tick_reaction.html", "classreactesp_1_1_tick_reaction" ], + [ "reactesp::ISRReaction", "classreactesp_1_1_i_s_r_reaction.html", "classreactesp_1_1_i_s_r_reaction" ], + [ "reactesp::ReactESP", "classreactesp_1_1_react_e_s_p.html", "classreactesp_1_1_react_e_s_p" ], + [ "isr_react_callback", "_react_e_s_p_8h.html#a2b5792453cf14eaa49fd355ad1011482", null ], + [ "react_callback", "_react_e_s_p_8h.html#a1dfbc20eb5c3efa2665acac404585b81", null ] ]; \ No newline at end of file diff --git a/docs/generated/docs/_react_e_s_p_8h__dep__incl.dot b/docs/generated/docs/_react_e_s_p_8h__dep__incl.dot deleted file mode 100644 index 9a5f9db..0000000 --- a/docs/generated/docs/_react_e_s_p_8h__dep__incl.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "src/ReactESP.h" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="src/ReactESP.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="src/ReactESP.cpp",height=0.2,width=0.4,color="black",URL="$_react_e_s_p_8cpp.html",tooltip=" "]; - Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="src/main.cpp",height=0.2,width=0.4,color="black",URL="$main_8cpp.html",tooltip=" "]; -} diff --git a/docs/generated/docs/_react_e_s_p_8h__dep__incl.map b/docs/generated/docs/_react_e_s_p_8h__dep__incl.map new file mode 100644 index 0000000..4d09353 --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8h__dep__incl.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/_react_e_s_p_8h__dep__incl.md5 b/docs/generated/docs/_react_e_s_p_8h__dep__incl.md5 new file mode 100644 index 0000000..7083a04 --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8h__dep__incl.md5 @@ -0,0 +1 @@ +28a9a6da166b41733de4c35c69d0124e \ No newline at end of file diff --git a/docs/generated/docs/_react_e_s_p_8h__dep__incl.svg b/docs/generated/docs/_react_e_s_p_8h__dep__incl.svg new file mode 100644 index 0000000..f061e5e --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8h__dep__incl.svg @@ -0,0 +1,51 @@ + + + + + + +src/ReactESP.h + + +Node1 + + +src/ReactESP.h + + + + + +Node2 + + +src/ReactESP.cpp + + + + + +Node1->Node2 + + + + + +Node3 + + +src/main.cpp + + + + + +Node1->Node3 + + + + + diff --git a/docs/generated/docs/_react_e_s_p_8h__incl.dot b/docs/generated/docs/_react_e_s_p_8h__incl.dot deleted file mode 100644 index 2a085c3..0000000 --- a/docs/generated/docs/_react_e_s_p_8h__incl.dot +++ /dev/null @@ -1,17 +0,0 @@ -digraph "src/ReactESP.h" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="src/ReactESP.h",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Arduino.h",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node1 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="forward_list",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node1 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="functional",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node1 -> Node5 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node5 [label="queue",height=0.2,width=0.4,color="grey75",tooltip=" "]; -} diff --git a/docs/generated/docs/_react_e_s_p_8h__incl.map b/docs/generated/docs/_react_e_s_p_8h__incl.map new file mode 100644 index 0000000..bae4ae8 --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8h__incl.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/generated/docs/_react_e_s_p_8h__incl.md5 b/docs/generated/docs/_react_e_s_p_8h__incl.md5 new file mode 100644 index 0000000..5236e7d --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8h__incl.md5 @@ -0,0 +1 @@ +1481cab160afc7c93030b08fcca34ba4 \ No newline at end of file diff --git a/docs/generated/docs/_react_e_s_p_8h__incl.svg b/docs/generated/docs/_react_e_s_p_8h__incl.svg new file mode 100644 index 0000000..4b1bb75 --- /dev/null +++ b/docs/generated/docs/_react_e_s_p_8h__incl.svg @@ -0,0 +1,81 @@ + + + + + + +src/ReactESP.h + + +Node1 + + +src/ReactESP.h + + + + + +Node2 + + +Arduino.h + + + + + +Node1->Node2 + + + + + +Node3 + + +forward_list + + + + + +Node1->Node3 + + + + + +Node4 + + +functional + + + + + +Node1->Node4 + + + + + +Node5 + + +queue + + + + + +Node1->Node5 + + + + + diff --git a/docs/generated/docs/_react_e_s_p_8h_source.html b/docs/generated/docs/_react_e_s_p_8h_source.html index 9ea7ecc..b54d88d 100644 --- a/docs/generated/docs/_react_e_s_p_8h_source.html +++ b/docs/generated/docs/_react_e_s_p_8h_source.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -102,253 +102,254 @@
7#include <functional>
8#include <queue>
9
-
10typedef std::function<void()> react_callback;
-
11typedef void (*isr_react_callback)(void*);
-
12
-
13// forward declarations
+
10namespace reactesp {
+
11
+
12typedef std::function<void()> react_callback;
+
13typedef void (*isr_react_callback)(void*);
14
-
15class ReactESP;
+
15// forward declarations
16
-
17// ESP32 doesn't have the micros64 function defined
-
18#ifdef ESP32
-
19uint64_t ICACHE_RAM_ATTR micros64();
-
20#endif
-
21
-
25class Reaction {
-
26 protected:
- -
28
-
29 public:
- -
36 // FIXME: why do these have to be defined?
-
37 virtual void add() = 0;
-
38 virtual void remove() = 0;
-
39 virtual void tick() = 0;
-
40};
-
41
-
45class TimedReaction : public Reaction {
-
46 protected:
-
47 const uint64_t interval;
- -
49 bool enabled;
-
50
-
51 public:
- -
59 : Reaction(callback), interval((uint64_t)1000 * (uint64_t)interval) {
-
60 last_trigger_time = micros64();
-
61 enabled = true;
-
62 }
- - -
71 last_trigger_time = micros64();
-
72 enabled = true;
-
73 }
-
74
-
75 virtual ~TimedReaction() {}
-
76 bool operator<(const TimedReaction& other);
-
77 void add();
-
78 void remove();
-
79 uint32_t getTriggerTime() { return (last_trigger_time + interval) / 1000; }
- -
81 bool isEnabled() { return enabled; }
-
82 virtual void tick() = 0;
-
83};
-
84
- -
86 bool operator()(TimedReaction* a, TimedReaction* b) { return *b < *a; }
-
87};
-
88
- -
93 public:
-
100 DelayReaction(const uint32_t delay, const react_callback callback);
-
107 DelayReaction(const uint64_t delay, const react_callback callback);
-
108 virtual ~DelayReaction() {}
-
109 void tick();
-
110};
-
111
- -
116 public:
- - - - -
133 void tick();
-
134};
-
135
-
139class UntimedReaction : public Reaction {
-
140 public:
- -
142 virtual ~UntimedReaction() {}
-
143 virtual void add();
-
144 virtual void remove();
-
145 virtual void tick() = 0;
-
146};
-
147
- -
153 private:
-
154 Stream& stream;
-
155
-
156 public:
- -
164 : UntimedReaction(callback), stream(stream) {}
-
165 void tick();
-
166};
-
167
- -
172 public:
- -
179 void tick();
-
180};
-
181
-
185class ISRReaction : public Reaction {
-
186 private:
-
187 const uint8_t pin_number;
-
188 const int mode;
-
189#ifdef ESP32
-
190 // set to true once gpio_install_isr_service is called
-
191 static bool isr_service_installed;
-
192 static void isr(void* arg);
-
193#endif
-
194
-
195 public:
-
204 ISRReaction(uint8_t pin_number, int mode, const react_callback callback)
- -
206 pin_number(pin_number),
-
207 mode(mode) {
-
208#ifdef ESP32
-
209 gpio_int_type_t intr_type;
-
210 switch (mode) {
-
211 case RISING:
-
212 intr_type = GPIO_INTR_POSEDGE;
-
213 break;
-
214 case FALLING:
-
215 intr_type = GPIO_INTR_NEGEDGE;
-
216 break;
-
217 case CHANGE:
-
218 intr_type = GPIO_INTR_ANYEDGE;
-
219 break;
-
220 default:
-
221 intr_type = GPIO_INTR_DISABLE;
-
222 break;
-
223 }
-
224 // configure the IO pin
-
225 gpio_set_intr_type((gpio_num_t)pin_number, intr_type);
-
226
-
227 if (!isr_service_installed) {
-
228 gpio_install_isr_service(ESP_INTR_FLAG_LOWMED);
-
229 isr_service_installed = true;
-
230 }
-
231#endif
-
232 }
-
233 virtual ~ISRReaction() {}
-
234 void add();
-
235 void remove();
-
236 void tick() {}
-
237};
-
238
-
240// ReactESP main class implementation
-
241
-
245class ReactESP {
-
246 friend class Reaction;
-
247 friend class TimedReaction;
-
248 friend class RepeatReaction;
-
249 friend class UntimedReaction;
-
250 friend class ISRReaction;
-
251
-
252 public:
-
260 ReactESP(const react_callback cb) : _setup(cb) { app = this; }
-
261 void setup(void) { _setup(); }
-
262 void tick(void);
+
17class ReactESP;
+
18
+
19// ESP32 doesn't have the micros64 function defined
+
20#ifdef ESP32
+
21uint64_t ICACHE_RAM_ATTR micros64();
+
22#endif
+
23
+
27class Reaction {
+
28 protected:
+ +
30
+
31 public:
+ +
38 // FIXME: why do these have to be defined?
+
39 virtual void add() = 0;
+
40 virtual void remove() = 0;
+
41 virtual void tick() = 0;
+
42};
+
43
+
47class TimedReaction : public Reaction {
+
48 protected:
+
49 const uint64_t interval;
+ +
51 bool enabled;
+
52
+
53 public:
+ +
61 : Reaction(callback), interval((uint64_t)1000 * (uint64_t)interval) {
+
62 last_trigger_time = micros64();
+
63 enabled = true;
+
64 }
+ + +
73 last_trigger_time = micros64();
+
74 enabled = true;
+
75 }
+
76
+
77 virtual ~TimedReaction() {}
+
78 bool operator<(const TimedReaction& other);
+
79 void add();
+
80 void remove();
+
81 uint32_t getTriggerTime() { return (last_trigger_time + interval) / 1000; }
+ +
83 bool isEnabled() { return enabled; }
+
84 virtual void tick() = 0;
+
85};
+
86
+ +
88 bool operator()(TimedReaction* a, TimedReaction* b) { return *b < *a; }
+
89};
+
90
+ +
95 public:
+
102 DelayReaction(const uint32_t delay, const react_callback callback);
+
109 DelayReaction(const uint64_t delay, const react_callback callback);
+
110 virtual ~DelayReaction() {}
+
111 void tick();
+
112};
+
113
+ +
118 public:
+ + + + +
135 void tick();
+
136};
+
137
+
141class UntimedReaction : public Reaction {
+
142 public:
+ +
144 virtual ~UntimedReaction() {}
+
145 virtual void add();
+
146 virtual void remove();
+
147 virtual void tick() = 0;
+
148};
+
149
+ +
155 private:
+
156 Stream& stream;
+
157
+
158 public:
+ +
166 : UntimedReaction(callback), stream(stream) {}
+
167 void tick();
+
168};
+
169
+ +
174 public:
+ +
181 void tick();
+
182};
+
183
+
187class ISRReaction : public Reaction {
+
188 private:
+
189 const uint8_t pin_number;
+
190 const int mode;
+
191#ifdef ESP32
+
192 // set to true once gpio_install_isr_service is called
+
193 static bool isr_service_installed;
+
194 static void isr(void* arg);
+
195#endif
+
196
+
197 public:
+
206 ISRReaction(uint8_t pin_number, int mode, const react_callback callback)
+ +
208 pin_number(pin_number),
+
209 mode(mode) {
+
210#ifdef ESP32
+
211 gpio_int_type_t intr_type;
+
212 switch (mode) {
+
213 case RISING:
+
214 intr_type = GPIO_INTR_POSEDGE;
+
215 break;
+
216 case FALLING:
+
217 intr_type = GPIO_INTR_NEGEDGE;
+
218 break;
+
219 case CHANGE:
+
220 intr_type = GPIO_INTR_ANYEDGE;
+
221 break;
+
222 default:
+
223 intr_type = GPIO_INTR_DISABLE;
+
224 break;
+
225 }
+
226 // configure the IO pin
+
227 gpio_set_intr_type((gpio_num_t)pin_number, intr_type);
+
228
+
229 if (!isr_service_installed) {
+
230 gpio_install_isr_service(ESP_INTR_FLAG_LOWMED);
+
231 isr_service_installed = true;
+
232 }
+
233#endif
+
234 }
+
235 virtual ~ISRReaction() {}
+
236 void add();
+
237 void remove();
+
238 void tick() {}
+
239};
+
240
+
242// ReactESP main class implementation
+
243
+
247class ReactESP {
+
248 friend class Reaction;
+
249 friend class TimedReaction;
+
250 friend class RepeatReaction;
+
251 friend class UntimedReaction;
+
252 friend class ISRReaction;
+
253
+
254 public:
+
258 ReactESP() { app = this; }
+
259 void tick(void);
+
260
+
262 static ReactESP* app;
263
-
265 static ReactESP* app;
-
266
-
274 DelayReaction* onDelay(const uint32_t t, const react_callback cb);
-
282 DelayReaction* onDelayMicros(const uint64_t t, const react_callback cb);
-
290 RepeatReaction* onRepeat(const uint32_t t, const react_callback cb);
-
298 RepeatReaction* onRepeatMicros(const uint64_t t, const react_callback cb);
-
306 StreamReaction* onAvailable(Stream& stream, const react_callback cb);
-
317 ISRReaction* onInterrupt(const uint8_t pin_number, int mode,
-
318 const react_callback cb);
- -
326
-
327 private:
-
328 const react_callback _setup;
-
329 std::priority_queue<TimedReaction*, std::vector<TimedReaction*>,
- -
331 timed_queue;
-
332 std::forward_list<UntimedReaction*> untimed_list;
-
333 std::forward_list<ISRReaction*> isr_reaction_list;
-
334 std::forward_list<ISRReaction*> isr_pending_list;
-
335 void tickTimed();
-
336 void tickUntimed();
-
337 void tickISR();
-
338 void add(Reaction* re);
-
339};
-
340
-
341#endif
-
void(* isr_react_callback)(void *)
Definition: ReactESP.h:11
-
std::function< void()> react_callback
Definition: ReactESP.h:10
-
Reaction that is triggered after a certain time delay.
Definition: ReactESP.h:92
-
virtual ~DelayReaction()
Definition: ReactESP.h:108
-
DelayReaction(const uint32_t delay, const react_callback callback)
Construct a new Delay Reaction object.
Definition: ReactESP.cpp:34
-
void tick()
Definition: ReactESP.cpp:44
-
Reaction that is triggered on an input pin change.
Definition: ReactESP.h:185
-
void remove()
Definition: ReactESP.cpp:94
-
ISRReaction(uint8_t pin_number, int mode, const react_callback callback)
Construct a new ISRReaction object.
Definition: ReactESP.h:204
-
void tick()
Definition: ReactESP.h:236
-
void add()
Definition: ReactESP.cpp:85
-
virtual ~ISRReaction()
Definition: ReactESP.h:233
-
Main class of a ReactESP program.
Definition: ReactESP.h:245
-
ISRReaction * onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)
Create a new ISRReaction (interrupt reaction)
Definition: ReactESP.cpp:182
-
static ReactESP * app
Static singleton reference to the instantiated ReactESP object.
Definition: ReactESP.h:265
-
RepeatReaction * onRepeatMicros(const uint64_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:169
-
ReactESP(const react_callback cb)
Construct a new ReactESP object.
Definition: ReactESP.h:260
-
TickReaction * onTick(const react_callback cb)
Create a new TickReaction.
Definition: ReactESP.cpp:189
-
StreamReaction * onAvailable(Stream &stream, const react_callback cb)
Create a new StreamReaction.
Definition: ReactESP.cpp:176
-
void setup(void)
Definition: ReactESP.h:261
-
DelayReaction * onDelay(const uint32_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:150
-
DelayReaction * onDelayMicros(const uint64_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:156
-
RepeatReaction * onRepeat(const uint32_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:163
-
void tick(void)
Definition: ReactESP.cpp:145
-
Reactions are code to be called when a given condition is fulfilled.
Definition: ReactESP.h:25
-
const react_callback callback
Definition: ReactESP.h:27
-
virtual void tick()=0
-
virtual void add()=0
-
Reaction(react_callback callback)
Construct a new Reaction object.
Definition: ReactESP.h:35
-
virtual void remove()=0
-
Reaction that is triggered repeatedly.
Definition: ReactESP.h:115
- -
RepeatReaction(const uint64_t interval, const react_callback callback)
Construct a new Repeat Reaction object.
Definition: ReactESP.h:131
-
RepeatReaction(const uint32_t interval, const react_callback callback)
Construct a new Repeat Reaction object.
Definition: ReactESP.h:123
-
Reaction that is triggered when there is input available at the given Arduino Stream.
Definition: ReactESP.h:152
-
StreamReaction(Stream &stream, const react_callback callback)
Construct a new Stream Reaction object.
Definition: ReactESP.h:163
- -
Reaction that is triggered unconditionally at each execution loop.
Definition: ReactESP.h:171
-
TickReaction(const react_callback callback)
Construct a new Tick Reaction object.
Definition: ReactESP.h:178
-
void tick()
Definition: ReactESP.cpp:74
-
TimedReactions are called based on elapsing of time.
Definition: ReactESP.h:45
-
void add()
Definition: ReactESP.cpp:26
-
virtual ~TimedReaction()
Definition: ReactESP.h:75
-
uint64_t last_trigger_time
Definition: ReactESP.h:48
-
bool operator<(const TimedReaction &other)
Return the current time since the device restart in microseconds.
Definition: ReactESP.cpp:21
-
TimedReaction(const uint64_t interval, const react_callback callback)
Construct a new Timed Reaction object.
Definition: ReactESP.h:69
-
uint64_t getTriggerTimeMicros()
Definition: ReactESP.h:80
-
virtual void tick()=0
-
uint32_t getTriggerTime()
Definition: ReactESP.h:79
-
void remove()
Definition: ReactESP.cpp:28
-
const uint64_t interval
Definition: ReactESP.h:47
-
bool enabled
Definition: ReactESP.h:49
-
TimedReaction(const uint32_t interval, const react_callback callback)
Construct a new Timed Reaction object.
Definition: ReactESP.h:58
-
bool isEnabled()
Definition: ReactESP.h:81
-
Reactions that are triggered based on something else than time.
Definition: ReactESP.h:139
-
UntimedReaction(const react_callback callback)
Definition: ReactESP.h:141
-
virtual void remove()
Definition: ReactESP.cpp:63
-
virtual void tick()=0
-
virtual void add()
Definition: ReactESP.cpp:61
-
virtual ~UntimedReaction()
Definition: ReactESP.h:142
-
void ICACHE_RAM_ATTR isr()
Definition: main.cpp:18
- -
bool operator()(TimedReaction *a, TimedReaction *b)
Definition: ReactESP.h:86
+
271 DelayReaction* onDelay(const uint32_t t, const react_callback cb);
+
279 DelayReaction* onDelayMicros(const uint64_t t, const react_callback cb);
+
287 RepeatReaction* onRepeat(const uint32_t t, const react_callback cb);
+
295 RepeatReaction* onRepeatMicros(const uint64_t t, const react_callback cb);
+
303 StreamReaction* onAvailable(Stream& stream, const react_callback cb);
+
314 ISRReaction* onInterrupt(const uint8_t pin_number, int mode,
+
315 const react_callback cb);
+ +
323
+
324 private:
+
325 std::priority_queue<TimedReaction*, std::vector<TimedReaction*>,
+ +
327 timed_queue;
+
328 std::forward_list<UntimedReaction*> untimed_list;
+
329 std::forward_list<ISRReaction*> isr_reaction_list;
+
330 std::forward_list<ISRReaction*> isr_pending_list;
+
331 void tickTimed();
+
332 void tickUntimed();
+
333 void tickISR();
+
334 void add(Reaction* re);
+
335};
+
336
+
337} // namespace reactesp
+
338
+
339#endif
+
Reaction that is triggered after a certain time delay.
Definition: ReactESP.h:94
+
DelayReaction(const uint32_t delay, const react_callback callback)
Construct a new Delay Reaction object.
Definition: ReactESP.cpp:36
+ +
virtual ~DelayReaction()
Definition: ReactESP.h:110
+
Reaction that is triggered on an input pin change.
Definition: ReactESP.h:187
+
virtual ~ISRReaction()
Definition: ReactESP.h:235
+ + + +
ISRReaction(uint8_t pin_number, int mode, const react_callback callback)
Construct a new ISRReaction object.
Definition: ReactESP.h:206
+
Main class of a ReactESP program.
Definition: ReactESP.h:247
+
StreamReaction * onAvailable(Stream &stream, const react_callback cb)
Create a new StreamReaction.
Definition: ReactESP.cpp:171
+
DelayReaction * onDelayMicros(const uint64_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:151
+
DelayReaction * onDelay(const uint32_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:145
+
void tick(void)
Definition: ReactESP.cpp:140
+
static ReactESP * app
Static singleton reference to the instantiated ReactESP object.
Definition: ReactESP.h:262
+
RepeatReaction * onRepeat(const uint32_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:158
+
ReactESP()
Construct a new ReactESP object.
Definition: ReactESP.h:258
+
RepeatReaction * onRepeatMicros(const uint64_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:164
+
TickReaction * onTick(const react_callback cb)
Create a new TickReaction.
Definition: ReactESP.cpp:184
+
ISRReaction * onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)
Create a new ISRReaction (interrupt reaction)
Definition: ReactESP.cpp:177
+
Reactions are code to be called when a given condition is fulfilled.
Definition: ReactESP.h:27
+
virtual void add()=0
+
const react_callback callback
Definition: ReactESP.h:29
+
virtual void remove()=0
+
Reaction(react_callback callback)
Construct a new Reaction object.
Definition: ReactESP.h:37
+
virtual void tick()=0
+
Reaction that is triggered repeatedly.
Definition: ReactESP.h:117
+
RepeatReaction(const uint32_t interval, const react_callback callback)
Construct a new Repeat Reaction object.
Definition: ReactESP.h:125
+ +
RepeatReaction(const uint64_t interval, const react_callback callback)
Construct a new Repeat Reaction object.
Definition: ReactESP.h:133
+
Reaction that is triggered when there is input available at the given Arduino Stream.
Definition: ReactESP.h:154
+
StreamReaction(Stream &stream, const react_callback callback)
Construct a new Stream Reaction object.
Definition: ReactESP.h:165
+ +
Reaction that is triggered unconditionally at each execution loop.
Definition: ReactESP.h:173
+ +
TickReaction(const react_callback callback)
Construct a new Tick Reaction object.
Definition: ReactESP.h:180
+
TimedReactions are called based on elapsing of time.
Definition: ReactESP.h:47
+
virtual ~TimedReaction()
Definition: ReactESP.h:77
+ + +
TimedReaction(const uint32_t interval, const react_callback callback)
Construct a new Timed Reaction object.
Definition: ReactESP.h:60
+
bool operator<(const TimedReaction &other)
Return the current time since the device restart in microseconds.
Definition: ReactESP.cpp:23
+
virtual void tick()=0
+
uint32_t getTriggerTime()
Definition: ReactESP.h:81
+
TimedReaction(const uint64_t interval, const react_callback callback)
Construct a new Timed Reaction object.
Definition: ReactESP.h:71
+ +
uint64_t getTriggerTimeMicros()
Definition: ReactESP.h:82
+
const uint64_t interval
Definition: ReactESP.h:49
+ +
uint64_t last_trigger_time
Definition: ReactESP.h:50
+
Reactions that are triggered based on something else than time.
Definition: ReactESP.h:141
+
virtual void remove()
Definition: ReactESP.cpp:65
+
virtual void add()
Definition: ReactESP.cpp:63
+
virtual ~UntimedReaction()
Definition: ReactESP.h:144
+
virtual void tick()=0
+
UntimedReaction(const react_callback callback)
Definition: ReactESP.h:143
+ +
std::function< void()> react_callback
Definition: ReactESP.h:12
+
void(* isr_react_callback)(void *)
Definition: ReactESP.h:13
+ +
bool operator()(TimedReaction *a, TimedReaction *b)
Definition: ReactESP.h:88
diff --git a/docs/generated/docs/annotated.html b/docs/generated/docs/annotated.html index b19fc92..16e85e8 100644 --- a/docs/generated/docs/annotated.html +++ b/docs/generated/docs/annotated.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -94,17 +94,18 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - - - - - - +
[detail level 12]
 CDelayReactionReaction that is triggered after a certain time delay
 CISRReactionReaction that is triggered on an input pin change
 CReactESPMain class of a ReactESP program
 CReactionReactions are code to be called when a given condition is fulfilled
 CRepeatReactionReaction that is triggered repeatedly
 CStreamReactionReaction that is triggered when there is input available at the given Arduino Stream
 CTickReactionReaction that is triggered unconditionally at each execution loop
 CTimedReactionTimedReactions are called based on elapsing of time
 CTriggerTimeCompare
 CUntimedReactionReactions that are triggered based on something else than time
+ + + + + + + + + + +
 Nreactesp
 CDelayReactionReaction that is triggered after a certain time delay
 CISRReactionReaction that is triggered on an input pin change
 CReactESPMain class of a ReactESP program
 CReactionReactions are code to be called when a given condition is fulfilled
 CRepeatReactionReaction that is triggered repeatedly
 CStreamReactionReaction that is triggered when there is input available at the given Arduino Stream
 CTickReactionReaction that is triggered unconditionally at each execution loop
 CTimedReactionTimedReactions are called based on elapsing of time
 CTriggerTimeCompare
 CUntimedReactionReactions that are triggered based on something else than time
diff --git a/docs/generated/docs/annotated_dup.js b/docs/generated/docs/annotated_dup.js index d5476c1..df1ebaf 100644 --- a/docs/generated/docs/annotated_dup.js +++ b/docs/generated/docs/annotated_dup.js @@ -1,13 +1,15 @@ var annotated_dup = [ - [ "DelayReaction", "class_delay_reaction.html", "class_delay_reaction" ], - [ "ISRReaction", "class_i_s_r_reaction.html", "class_i_s_r_reaction" ], - [ "ReactESP", "class_react_e_s_p.html", "class_react_e_s_p" ], - [ "Reaction", "class_reaction.html", "class_reaction" ], - [ "RepeatReaction", "class_repeat_reaction.html", "class_repeat_reaction" ], - [ "StreamReaction", "class_stream_reaction.html", "class_stream_reaction" ], - [ "TickReaction", "class_tick_reaction.html", "class_tick_reaction" ], - [ "TimedReaction", "class_timed_reaction.html", "class_timed_reaction" ], - [ "TriggerTimeCompare", "struct_trigger_time_compare.html", "struct_trigger_time_compare" ], - [ "UntimedReaction", "class_untimed_reaction.html", "class_untimed_reaction" ] + [ "reactesp", "namespacereactesp.html", [ + [ "DelayReaction", "classreactesp_1_1_delay_reaction.html", "classreactesp_1_1_delay_reaction" ], + [ "ISRReaction", "classreactesp_1_1_i_s_r_reaction.html", "classreactesp_1_1_i_s_r_reaction" ], + [ "ReactESP", "classreactesp_1_1_react_e_s_p.html", "classreactesp_1_1_react_e_s_p" ], + [ "Reaction", "classreactesp_1_1_reaction.html", "classreactesp_1_1_reaction" ], + [ "RepeatReaction", "classreactesp_1_1_repeat_reaction.html", "classreactesp_1_1_repeat_reaction" ], + [ "StreamReaction", "classreactesp_1_1_stream_reaction.html", "classreactesp_1_1_stream_reaction" ], + [ "TickReaction", "classreactesp_1_1_tick_reaction.html", "classreactesp_1_1_tick_reaction" ], + [ "TimedReaction", "classreactesp_1_1_timed_reaction.html", "classreactesp_1_1_timed_reaction" ], + [ "TriggerTimeCompare", "structreactesp_1_1_trigger_time_compare.html", "structreactesp_1_1_trigger_time_compare" ], + [ "UntimedReaction", "classreactesp_1_1_untimed_reaction.html", "classreactesp_1_1_untimed_reaction" ] + ] ] ]; \ No newline at end of file diff --git a/docs/generated/docs/class_delay_reaction-members.html b/docs/generated/docs/class_delay_reaction-members.html deleted file mode 100644 index 3b86353..0000000 --- a/docs/generated/docs/class_delay_reaction-members.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - -ReactESP: Member List - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
DelayReaction Member List
-
-
- -

This is the complete list of members for DelayReaction, including all inherited members.

- - - - - - - - - - - - - - - - - - - -
add()TimedReactionvirtual
callbackReactionprotected
DelayReaction(const uint32_t delay, const react_callback callback)DelayReaction
DelayReaction(const uint64_t delay, const react_callback callback)DelayReaction
enabledTimedReactionprotected
getTriggerTime()TimedReactioninline
getTriggerTimeMicros()TimedReactioninline
intervalTimedReactionprotected
isEnabled()TimedReactioninline
last_trigger_timeTimedReactionprotected
operator<(const TimedReaction &other)TimedReaction
Reaction(react_callback callback)Reactioninline
remove()TimedReactionvirtual
tick()DelayReactionvirtual
TimedReaction(const uint32_t interval, const react_callback callback)TimedReactioninline
TimedReaction(const uint64_t interval, const react_callback callback)TimedReactioninline
~DelayReaction()DelayReactioninlinevirtual
~TimedReaction()TimedReactioninlinevirtual
-
- - - - diff --git a/docs/generated/docs/class_delay_reaction.html b/docs/generated/docs/class_delay_reaction.html deleted file mode 100644 index be6d443..0000000 --- a/docs/generated/docs/class_delay_reaction.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - -ReactESP: DelayReaction Class Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
- -
DelayReaction Class Reference
-
-
- -

Reaction that is triggered after a certain time delay. - More...

- -

#include <ReactESP.h>

-
-Inheritance diagram for DelayReaction:
-
-
-
-
[legend]
-
-Collaboration diagram for DelayReaction:
-
-
-
-
[legend]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-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 ()
 
- Public Member Functions inherited from TimedReaction
 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 ()
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - - - - - - - - - -

-Additional Inherited Members

- Protected Attributes inherited from TimedReaction
const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from Reaction
const react_callback callback
 
-

Detailed Description

-

Reaction that is triggered after a certain time delay.

- -

Definition at line 92 of file ReactESP.h.

-

Constructor & Destructor Documentation

- -

◆ DelayReaction() [1/2]

- -
-
- - - - - - - - - - - - - - - - - - -
DelayReaction::DelayReaction (const uint32_t delay,
const react_callback callback 
)
-
- -

Construct a new Delay Reaction object.

-
Parameters
- - - -
delayDelay, in milliseconds
callbackFunction to be called after the delay
-
-
- -

Definition at line 34 of file ReactESP.cpp.

- -
-
- -

◆ DelayReaction() [2/2]

- -
-
- - - - - - - - - - - - - - - - - - -
DelayReaction::DelayReaction (const uint64_t delay,
const react_callback callback 
)
-
- -

Construct a new Delay Reaction object.

-
Parameters
- - - -
delayDelay, in microseconds
callbackFunction to be called after the delay
-
-
- -

Definition at line 39 of file ReactESP.cpp.

- -
-
- -

◆ ~DelayReaction()

- -
-
- - - - - -
- - - - - - - -
virtual DelayReaction::~DelayReaction ()
-
-inlinevirtual
-
- -

Definition at line 108 of file ReactESP.h.

- -
-
-

Member Function Documentation

- -

◆ tick()

- -
-
- - - - - -
- - - - - - - -
void DelayReaction::tick ()
-
-virtual
-
- -

Implements TimedReaction.

- -

Definition at line 44 of file ReactESP.cpp.

- -
-
-
The documentation for this class was generated from the following files: -
-
- - - - diff --git a/docs/generated/docs/class_delay_reaction.js b/docs/generated/docs/class_delay_reaction.js deleted file mode 100644 index 8294f42..0000000 --- a/docs/generated/docs/class_delay_reaction.js +++ /dev/null @@ -1,7 +0,0 @@ -var class_delay_reaction = -[ - [ "DelayReaction", "class_delay_reaction.html#ab8cabba2391d4f4d836f4f060425ddb0", null ], - [ "DelayReaction", "class_delay_reaction.html#a27b07f8afc197ac54b6192c411d7e50b", null ], - [ "~DelayReaction", "class_delay_reaction.html#a50777489f0975d07a81c39c0638d1a7e", null ], - [ "tick", "class_delay_reaction.html#af2a85d71205ad1cbf5f6471f17e91a6f", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_delay_reaction__coll__graph.dot b/docs/generated/docs/class_delay_reaction__coll__graph.dot deleted file mode 100644 index 6037ed7..0000000 --- a/docs/generated/docs/class_delay_reaction__coll__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "DelayReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="DelayReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered after a certain time delay."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html",tooltip="TimedReactions are called based on elapsing of time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_delay_reaction__inherit__graph.dot b/docs/generated/docs/class_delay_reaction__inherit__graph.dot deleted file mode 100644 index 6037ed7..0000000 --- a/docs/generated/docs/class_delay_reaction__inherit__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "DelayReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="DelayReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered after a certain time delay."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html",tooltip="TimedReactions are called based on elapsing of time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_i_s_r_reaction.js b/docs/generated/docs/class_i_s_r_reaction.js deleted file mode 100644 index 0fa21a7..0000000 --- a/docs/generated/docs/class_i_s_r_reaction.js +++ /dev/null @@ -1,8 +0,0 @@ -var class_i_s_r_reaction = -[ - [ "ISRReaction", "class_i_s_r_reaction.html#a675599c657aa6aae62a1bc08510edfe5", null ], - [ "~ISRReaction", "class_i_s_r_reaction.html#adca866ff1b4dd48450ab0076707221bd", null ], - [ "add", "class_i_s_r_reaction.html#aba4a495b10cf265d41cbdb9790936072", null ], - [ "remove", "class_i_s_r_reaction.html#a6470d8b82a5066562ad9a2e169ea19b8", null ], - [ "tick", "class_i_s_r_reaction.html#aab332af06426b145d73c1b46b4d7c3fd", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_i_s_r_reaction__coll__graph.dot b/docs/generated/docs/class_i_s_r_reaction__coll__graph.dot deleted file mode 100644 index d8e6c66..0000000 --- a/docs/generated/docs/class_i_s_r_reaction__coll__graph.dot +++ /dev/null @@ -1,11 +0,0 @@ -digraph "ISRReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="ISRReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered on an input pin change."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_i_s_r_reaction__inherit__graph.dot b/docs/generated/docs/class_i_s_r_reaction__inherit__graph.dot deleted file mode 100644 index d8e6c66..0000000 --- a/docs/generated/docs/class_i_s_r_reaction__inherit__graph.dot +++ /dev/null @@ -1,11 +0,0 @@ -digraph "ISRReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="ISRReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered on an input pin change."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_cgraph.dot b/docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_cgraph.dot deleted file mode 100644 index 72f3175..0000000 --- a/docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ISRReaction::add" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ISRReaction::add",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="isr",height=0.2,width=0.4,color="black",URL="$main_8cpp.html#aa6359e12c4743a5b1888ac194c199674",tooltip=" "]; -} diff --git a/docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_icgraph.dot b/docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_icgraph.dot deleted file mode 100644 index 336308b..0000000 --- a/docs/generated/docs/class_i_s_r_reaction_aba4a495b10cf265d41cbdb9790936072_icgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ISRReaction::add" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="RL"; - Node1 [label="ISRReaction::add",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ReactESP::onInterrupt",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#a02ce0511803b0d3a1fcec6bc56ff8b3f",tooltip="Create a new ISRReaction (interrupt reaction)"]; -} diff --git a/docs/generated/docs/class_react_e_s_p-members.html b/docs/generated/docs/class_react_e_s_p-members.html deleted file mode 100644 index b2fea4f..0000000 --- a/docs/generated/docs/class_react_e_s_p-members.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - -ReactESP: Member List - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
ReactESP Member List
-
-
- -

This is the complete list of members for ReactESP, including all inherited members.

- - - - - - - - - - - - - - - - - -
appReactESPstatic
ISRReactionReactESPfriend
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)ReactESPinline
ReactionReactESPfriend
RepeatReactionReactESPfriend
setup(void)ReactESPinline
tick(void)ReactESP
TimedReactionReactESPfriend
UntimedReactionReactESPfriend
-
- - - - diff --git a/docs/generated/docs/class_react_e_s_p.js b/docs/generated/docs/class_react_e_s_p.js deleted file mode 100644 index 93d667a..0000000 --- a/docs/generated/docs/class_react_e_s_p.js +++ /dev/null @@ -1,18 +0,0 @@ -var class_react_e_s_p = -[ - [ "ReactESP", "class_react_e_s_p.html#a5dafe71a8c9c2834c5c34cc86b820c9a", null ], - [ "onAvailable", "class_react_e_s_p.html#a831c11dd7f1a6e15d70785c3a990df93", null ], - [ "onDelay", "class_react_e_s_p.html#ab26769ff3e426972e87746749560ffc0", null ], - [ "onDelayMicros", "class_react_e_s_p.html#ad5739bf0fedb24931f98762113161e95", null ], - [ "onInterrupt", "class_react_e_s_p.html#a02ce0511803b0d3a1fcec6bc56ff8b3f", null ], - [ "onRepeat", "class_react_e_s_p.html#adb20144bde6e60b41e484d2f6f61d0f5", null ], - [ "onRepeatMicros", "class_react_e_s_p.html#a2a7018e7a5e89634e8e4385be51eafd4", null ], - [ "onTick", "class_react_e_s_p.html#a7da68d41f2a9790ab1aec2610bad07eb", null ], - [ "setup", "class_react_e_s_p.html#aa26556a0954d117dc5b8d925e5924cdf", null ], - [ "tick", "class_react_e_s_p.html#aeefac464d9df930d020a321a63cdcf4b", null ], - [ "ISRReaction", "class_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269", null ], - [ "Reaction", "class_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51", null ], - [ "RepeatReaction", "class_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348", null ], - [ "TimedReaction", "class_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d", null ], - [ "UntimedReaction", "class_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_react_e_s_p__coll__graph.dot b/docs/generated/docs/class_react_e_s_p__coll__graph.dot deleted file mode 100644 index 7e71a08..0000000 --- a/docs/generated/docs/class_react_e_s_p__coll__graph.dot +++ /dev/null @@ -1,10 +0,0 @@ -digraph "ReactESP" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="ReactESP",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Main class of a ReactESP program."]; - Node1 -> Node1 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" app" ,fontname="Helvetica"]; -} diff --git a/docs/generated/docs/class_react_e_s_p_a02ce0511803b0d3a1fcec6bc56ff8b3f_cgraph.dot b/docs/generated/docs/class_react_e_s_p_a02ce0511803b0d3a1fcec6bc56ff8b3f_cgraph.dot deleted file mode 100644 index 1b32581..0000000 --- a/docs/generated/docs/class_react_e_s_p_a02ce0511803b0d3a1fcec6bc56ff8b3f_cgraph.dot +++ /dev/null @@ -1,14 +0,0 @@ -digraph "ReactESP::onInterrupt" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onInterrupt",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new ISRReaction (interrupt reaction)"]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ISRReaction::add",height=0.2,width=0.4,color="black",URL="$class_i_s_r_reaction.html#aba4a495b10cf265d41cbdb9790936072",tooltip=" "]; - Node2 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="isr",height=0.2,width=0.4,color="black",URL="$main_8cpp.html#aa6359e12c4743a5b1888ac194c199674",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_a2a7018e7a5e89634e8e4385be51eafd4_cgraph.dot b/docs/generated/docs/class_react_e_s_p_a2a7018e7a5e89634e8e4385be51eafd4_cgraph.dot deleted file mode 100644 index 31fe629..0000000 --- a/docs/generated/docs/class_react_e_s_p_a2a7018e7a5e89634e8e4385be51eafd4_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::onRepeatMicros" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onRepeatMicros",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new RepeatReaction."]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction::add",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html#a163d0232141ebe0d446d853969766a69",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_a7da68d41f2a9790ab1aec2610bad07eb_cgraph.dot b/docs/generated/docs/class_react_e_s_p_a7da68d41f2a9790ab1aec2610bad07eb_cgraph.dot deleted file mode 100644 index 4c0744a..0000000 --- a/docs/generated/docs/class_react_e_s_p_a7da68d41f2a9790ab1aec2610bad07eb_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::onTick" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onTick",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new TickReaction."]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="UntimedReaction::add",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html#aaf8d78a83d9c8174a2e069cb6279a793",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_a831c11dd7f1a6e15d70785c3a990df93_cgraph.dot b/docs/generated/docs/class_react_e_s_p_a831c11dd7f1a6e15d70785c3a990df93_cgraph.dot deleted file mode 100644 index d24bec7..0000000 --- a/docs/generated/docs/class_react_e_s_p_a831c11dd7f1a6e15d70785c3a990df93_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::onAvailable" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onAvailable",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new StreamReaction."]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="UntimedReaction::add",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html#aaf8d78a83d9c8174a2e069cb6279a793",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_aa26556a0954d117dc5b8d925e5924cdf_icgraph.dot b/docs/generated/docs/class_react_e_s_p_aa26556a0954d117dc5b8d925e5924cdf_icgraph.dot deleted file mode 100644 index 79fdb1b..0000000 --- a/docs/generated/docs/class_react_e_s_p_aa26556a0954d117dc5b8d925e5924cdf_icgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::setup" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="RL"; - Node1 [label="ReactESP::setup",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="setup",height=0.2,width=0.4,color="black",URL="$_react_e_s_p_8cpp.html#a7dfd9b79bc5a37d7df40207afbc5431f",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_ab26769ff3e426972e87746749560ffc0_cgraph.dot b/docs/generated/docs/class_react_e_s_p_ab26769ff3e426972e87746749560ffc0_cgraph.dot deleted file mode 100644 index cabd6ca..0000000 --- a/docs/generated/docs/class_react_e_s_p_ab26769ff3e426972e87746749560ffc0_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::onDelay" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onDelay",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new DelayReaction."]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction::add",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html#a163d0232141ebe0d446d853969766a69",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_ad5739bf0fedb24931f98762113161e95_cgraph.dot b/docs/generated/docs/class_react_e_s_p_ad5739bf0fedb24931f98762113161e95_cgraph.dot deleted file mode 100644 index 87924f2..0000000 --- a/docs/generated/docs/class_react_e_s_p_ad5739bf0fedb24931f98762113161e95_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::onDelayMicros" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onDelayMicros",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new DelayReaction."]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction::add",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html#a163d0232141ebe0d446d853969766a69",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_adb20144bde6e60b41e484d2f6f61d0f5_cgraph.dot b/docs/generated/docs/class_react_e_s_p_adb20144bde6e60b41e484d2f6f61d0f5_cgraph.dot deleted file mode 100644 index 8bebd8f..0000000 --- a/docs/generated/docs/class_react_e_s_p_adb20144bde6e60b41e484d2f6f61d0f5_cgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::onRepeat" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node1 [label="ReactESP::onRepeat",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Create a new RepeatReaction."]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction::add",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html#a163d0232141ebe0d446d853969766a69",tooltip=" "]; -} diff --git a/docs/generated/docs/class_react_e_s_p_aeefac464d9df930d020a321a63cdcf4b_icgraph.dot b/docs/generated/docs/class_react_e_s_p_aeefac464d9df930d020a321a63cdcf4b_icgraph.dot deleted file mode 100644 index 0350b82..0000000 --- a/docs/generated/docs/class_react_e_s_p_aeefac464d9df930d020a321a63cdcf4b_icgraph.dot +++ /dev/null @@ -1,12 +0,0 @@ -digraph "ReactESP::tick" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="RL"; - Node1 [label="ReactESP::tick",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="loop",height=0.2,width=0.4,color="black",URL="$_react_e_s_p_8cpp.html#a0b33edabd7f1c4e4a0bf32c67269be2f",tooltip=" "]; -} diff --git a/docs/generated/docs/class_reaction.js b/docs/generated/docs/class_reaction.js deleted file mode 100644 index f457985..0000000 --- a/docs/generated/docs/class_reaction.js +++ /dev/null @@ -1,8 +0,0 @@ -var class_reaction = -[ - [ "Reaction", "class_reaction.html#aea66093d451e22677190c38176b9fe40", null ], - [ "add", "class_reaction.html#a349da2fef93c94095c264ead1f5ffcb8", null ], - [ "remove", "class_reaction.html#af88faf9664340633d6cc5f913ab4e105", null ], - [ "tick", "class_reaction.html#a24cc0bd38eea8c50dd6718bb7a1c8051", null ], - [ "callback", "class_reaction.html#a13fdfc7eef62041f7394eac1f0b53978", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_reaction__inherit__graph.dot b/docs/generated/docs/class_reaction__inherit__graph.dot deleted file mode 100644 index cbc3b63..0000000 --- a/docs/generated/docs/class_reaction__inherit__graph.dot +++ /dev/null @@ -1,23 +0,0 @@ -digraph "Reaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="Reaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reactions are code to be called when a given condition is fulfilled."]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ISRReaction",height=0.2,width=0.4,color="black",URL="$class_i_s_r_reaction.html",tooltip="Reaction that is triggered on an input pin change."]; - Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="TimedReaction",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html",tooltip="TimedReactions are called based on elapsing of time."]; - Node3 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="DelayReaction",height=0.2,width=0.4,color="black",URL="$class_delay_reaction.html",tooltip="Reaction that is triggered after a certain time delay."]; - Node3 -> Node5 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node5 [label="RepeatReaction",height=0.2,width=0.4,color="black",URL="$class_repeat_reaction.html",tooltip="Reaction that is triggered repeatedly."]; - Node1 -> Node6 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node6 [label="UntimedReaction",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html",tooltip="Reactions that are triggered based on something else than time."]; - Node6 -> Node7 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node7 [label="StreamReaction",height=0.2,width=0.4,color="black",URL="$class_stream_reaction.html",tooltip="Reaction that is triggered when there is input available at the given Arduino Stream."]; - Node6 -> Node8 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node8 [label="TickReaction",height=0.2,width=0.4,color="black",URL="$class_tick_reaction.html",tooltip="Reaction that is triggered unconditionally at each execution loop."]; -} diff --git a/docs/generated/docs/class_repeat_reaction-members.html b/docs/generated/docs/class_repeat_reaction-members.html deleted file mode 100644 index 7b97bc7..0000000 --- a/docs/generated/docs/class_repeat_reaction-members.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - - -ReactESP: Member List - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
RepeatReaction Member List
-
-
- -

This is the complete list of members for RepeatReaction, including all inherited members.

- - - - - - - - - - - - - - - - - - -
add()TimedReactionvirtual
callbackReactionprotected
enabledTimedReactionprotected
getTriggerTime()TimedReactioninline
getTriggerTimeMicros()TimedReactioninline
intervalTimedReactionprotected
isEnabled()TimedReactioninline
last_trigger_timeTimedReactionprotected
operator<(const TimedReaction &other)TimedReaction
Reaction(react_callback callback)Reactioninline
remove()TimedReactionvirtual
RepeatReaction(const uint32_t interval, const react_callback callback)RepeatReactioninline
RepeatReaction(const uint64_t interval, const react_callback callback)RepeatReactioninline
tick()RepeatReactionvirtual
TimedReaction(const uint32_t interval, const react_callback callback)TimedReactioninline
TimedReaction(const uint64_t interval, const react_callback callback)TimedReactioninline
~TimedReaction()TimedReactioninlinevirtual
-
- - - - diff --git a/docs/generated/docs/class_repeat_reaction.html b/docs/generated/docs/class_repeat_reaction.html deleted file mode 100644 index ac924dc..0000000 --- a/docs/generated/docs/class_repeat_reaction.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - -ReactESP: RepeatReaction Class Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
- -
RepeatReaction Class Reference
-
-
- -

Reaction that is triggered repeatedly. - More...

- -

#include <ReactESP.h>

-
-Inheritance diagram for RepeatReaction:
-
-
-
-
[legend]
-
-Collaboration diagram for RepeatReaction:
-
-
-
-
[legend]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-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 ()
 
- Public Member Functions inherited from TimedReaction
 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 ()
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - - - - - - - - - -

-Additional Inherited Members

- Protected Attributes inherited from TimedReaction
const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from Reaction
const react_callback callback
 
-

Detailed Description

-

Reaction that is triggered repeatedly.

- -

Definition at line 115 of file ReactESP.h.

-

Constructor & Destructor Documentation

- -

◆ RepeatReaction() [1/2]

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
RepeatReaction::RepeatReaction (const uint32_t interval,
const react_callback callback 
)
-
-inline
-
- -

Construct a new Repeat Reaction object.

-
Parameters
- - - -
intervalRepetition interval, in milliseconds
callbackFunction to be called at every repetition
-
-
- -

Definition at line 123 of file ReactESP.h.

- -
-
- -

◆ RepeatReaction() [2/2]

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
RepeatReaction::RepeatReaction (const uint64_t interval,
const react_callback callback 
)
-
-inline
-
- -

Construct a new Repeat Reaction object.

-
Parameters
- - - -
intervalRepetition interval, in microseconds
callbackFunction to be called at every repetition
-
-
- -

Definition at line 131 of file ReactESP.h.

- -
-
-

Member Function Documentation

- -

◆ tick()

- -
-
- - - - - -
- - - - - - - -
void RepeatReaction::tick ()
-
-virtual
-
- -

Implements TimedReaction.

- -

Definition at line 50 of file ReactESP.cpp.

- -
-
-
The documentation for this class was generated from the following files: -
-
- - - - diff --git a/docs/generated/docs/class_repeat_reaction.js b/docs/generated/docs/class_repeat_reaction.js deleted file mode 100644 index a53a4a2..0000000 --- a/docs/generated/docs/class_repeat_reaction.js +++ /dev/null @@ -1,6 +0,0 @@ -var class_repeat_reaction = -[ - [ "RepeatReaction", "class_repeat_reaction.html#a68c6ea9ade842d93ef967d977937f683", null ], - [ "RepeatReaction", "class_repeat_reaction.html#a5b53f55d5b252708eb2348c4c3a55868", null ], - [ "tick", "class_repeat_reaction.html#a2c05598c7a03d60ec1088db1da5d851d", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_repeat_reaction__coll__graph.dot b/docs/generated/docs/class_repeat_reaction__coll__graph.dot deleted file mode 100644 index 450474e..0000000 --- a/docs/generated/docs/class_repeat_reaction__coll__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "RepeatReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="RepeatReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered repeatedly."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html",tooltip="TimedReactions are called based on elapsing of time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_repeat_reaction__inherit__graph.dot b/docs/generated/docs/class_repeat_reaction__inherit__graph.dot deleted file mode 100644 index 450474e..0000000 --- a/docs/generated/docs/class_repeat_reaction__inherit__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "RepeatReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="RepeatReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered repeatedly."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html",tooltip="TimedReactions are called based on elapsing of time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_stream_reaction.html b/docs/generated/docs/class_stream_reaction.html deleted file mode 100644 index acd1d81..0000000 --- a/docs/generated/docs/class_stream_reaction.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - -ReactESP: StreamReaction Class Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
- -
StreamReaction Class Reference
-
-
- -

Reaction that is triggered when there is input available at the given Arduino Stream. - More...

- -

#include <ReactESP.h>

-
-Inheritance diagram for StreamReaction:
-
-
-
-
[legend]
-
-Collaboration diagram for StreamReaction:
-
-
-
-
[legend]
- - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

 StreamReaction (Stream &stream, const react_callback callback)
 Construct a new Stream Reaction object. More...
 
void tick ()
 
- Public Member Functions inherited from UntimedReaction
 UntimedReaction (const react_callback callback)
 
virtual ~UntimedReaction ()
 
virtual void add ()
 
virtual void remove ()
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - - -

-Additional Inherited Members

- Protected Attributes inherited from Reaction
const react_callback callback
 
-

Detailed Description

-

Reaction that is triggered when there is input available at the given Arduino Stream.

- -

Definition at line 152 of file ReactESP.h.

-

Constructor & Destructor Documentation

- -

◆ StreamReaction()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
StreamReaction::StreamReaction (Stream & stream,
const react_callback callback 
)
-
-inline
-
- -

Construct a new Stream Reaction object.

-
Parameters
- - - -
streamStream to monitor
callbackCallback to call for new input
-
-
- -

Definition at line 163 of file ReactESP.h.

- -
-
-

Member Function Documentation

- -

◆ tick()

- -
-
- - - - - -
- - - - - - - -
void StreamReaction::tick ()
-
-virtual
-
- -

Implements UntimedReaction.

- -

Definition at line 68 of file ReactESP.cpp.

- -
-
-
The documentation for this class was generated from the following files: -
-
- - - - diff --git a/docs/generated/docs/class_stream_reaction.js b/docs/generated/docs/class_stream_reaction.js deleted file mode 100644 index 8539593..0000000 --- a/docs/generated/docs/class_stream_reaction.js +++ /dev/null @@ -1,5 +0,0 @@ -var class_stream_reaction = -[ - [ "StreamReaction", "class_stream_reaction.html#a902a27a4c687e6eac1255c4fad74bf17", null ], - [ "tick", "class_stream_reaction.html#aa874d5cc82b5392075da1262e318a703", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_stream_reaction__coll__graph.dot b/docs/generated/docs/class_stream_reaction__coll__graph.dot deleted file mode 100644 index 78680be..0000000 --- a/docs/generated/docs/class_stream_reaction__coll__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "StreamReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="StreamReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered when there is input available at the given Arduino Stream."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="UntimedReaction",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html",tooltip="Reactions that are triggered based on something else than time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_stream_reaction__inherit__graph.dot b/docs/generated/docs/class_stream_reaction__inherit__graph.dot deleted file mode 100644 index 78680be..0000000 --- a/docs/generated/docs/class_stream_reaction__inherit__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "StreamReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="StreamReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered when there is input available at the given Arduino Stream."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="UntimedReaction",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html",tooltip="Reactions that are triggered based on something else than time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_tick_reaction.html b/docs/generated/docs/class_tick_reaction.html deleted file mode 100644 index cc8a1bc..0000000 --- a/docs/generated/docs/class_tick_reaction.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - - -ReactESP: TickReaction Class Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
- -
TickReaction Class Reference
-
-
- -

Reaction that is triggered unconditionally at each execution loop. - More...

- -

#include <ReactESP.h>

-
-Inheritance diagram for TickReaction:
-
-
-
-
[legend]
-
-Collaboration diagram for TickReaction:
-
-
-
-
[legend]
- - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

 TickReaction (const react_callback callback)
 Construct a new Tick Reaction object. More...
 
void tick ()
 
- Public Member Functions inherited from UntimedReaction
 UntimedReaction (const react_callback callback)
 
virtual ~UntimedReaction ()
 
virtual void add ()
 
virtual void remove ()
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - - -

-Additional Inherited Members

- Protected Attributes inherited from Reaction
const react_callback callback
 
-

Detailed Description

-

Reaction that is triggered unconditionally at each execution loop.

- -

Definition at line 171 of file ReactESP.h.

-

Constructor & Destructor Documentation

- -

◆ TickReaction()

- -
-
- - - - - -
- - - - - - - - -
TickReaction::TickReaction (const react_callback callback)
-
-inline
-
- -

Construct a new Tick Reaction object.

-
Parameters
- - -
callbackFunction to be called at each execution loop
-
-
- -

Definition at line 178 of file ReactESP.h.

- -
-
-

Member Function Documentation

- -

◆ tick()

- -
-
- - - - - -
- - - - - - - -
void TickReaction::tick ()
-
-virtual
-
- -

Implements UntimedReaction.

- -

Definition at line 74 of file ReactESP.cpp.

- -
-
-
The documentation for this class was generated from the following files: -
-
- - - - diff --git a/docs/generated/docs/class_tick_reaction.js b/docs/generated/docs/class_tick_reaction.js deleted file mode 100644 index 9356100..0000000 --- a/docs/generated/docs/class_tick_reaction.js +++ /dev/null @@ -1,5 +0,0 @@ -var class_tick_reaction = -[ - [ "TickReaction", "class_tick_reaction.html#a0928c0693f10acec61157027dd4658fe", null ], - [ "tick", "class_tick_reaction.html#aa4e6419363cef721057c990111542b93", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_tick_reaction__coll__graph.dot b/docs/generated/docs/class_tick_reaction__coll__graph.dot deleted file mode 100644 index 222df00..0000000 --- a/docs/generated/docs/class_tick_reaction__coll__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "TickReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="TickReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered unconditionally at each execution loop."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="UntimedReaction",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html",tooltip="Reactions that are triggered based on something else than time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_tick_reaction__inherit__graph.dot b/docs/generated/docs/class_tick_reaction__inherit__graph.dot deleted file mode 100644 index 222df00..0000000 --- a/docs/generated/docs/class_tick_reaction__inherit__graph.dot +++ /dev/null @@ -1,13 +0,0 @@ -digraph "TickReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="TickReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reaction that is triggered unconditionally at each execution loop."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="UntimedReaction",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html",tooltip="Reactions that are triggered based on something else than time."]; - Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_timed_reaction-members.html b/docs/generated/docs/class_timed_reaction-members.html deleted file mode 100644 index b2bbca6..0000000 --- a/docs/generated/docs/class_timed_reaction-members.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - -ReactESP: Member List - - - - - - - - - - - - - - - -
-
- - - - - - -
-
ReactESP 1.0.1-alpha -
-
Asynchronous programming for the ESP microcontrollers
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
TimedReaction Member List
-
-
- -

This is the complete list of members for TimedReaction, including all inherited members.

- - - - - - - - - - - - - - - - -
add()TimedReactionvirtual
callbackReactionprotected
enabledTimedReactionprotected
getTriggerTime()TimedReactioninline
getTriggerTimeMicros()TimedReactioninline
intervalTimedReactionprotected
isEnabled()TimedReactioninline
last_trigger_timeTimedReactionprotected
operator<(const TimedReaction &other)TimedReaction
Reaction(react_callback callback)Reactioninline
remove()TimedReactionvirtual
tick()=0TimedReactionpure virtual
TimedReaction(const uint32_t interval, const react_callback callback)TimedReactioninline
TimedReaction(const uint64_t interval, const react_callback callback)TimedReactioninline
~TimedReaction()TimedReactioninlinevirtual
-
- - - - diff --git a/docs/generated/docs/class_timed_reaction.js b/docs/generated/docs/class_timed_reaction.js deleted file mode 100644 index be7c70f..0000000 --- a/docs/generated/docs/class_timed_reaction.js +++ /dev/null @@ -1,16 +0,0 @@ -var class_timed_reaction = -[ - [ "TimedReaction", "class_timed_reaction.html#af1653cd9ff0b545e95baec51cde2743c", null ], - [ "TimedReaction", "class_timed_reaction.html#a4a775a7624ba511ae80016e14b8d88f5", null ], - [ "~TimedReaction", "class_timed_reaction.html#a2f26edad67264a6c4f4da7d7ebfbb661", null ], - [ "add", "class_timed_reaction.html#a163d0232141ebe0d446d853969766a69", null ], - [ "getTriggerTime", "class_timed_reaction.html#ac419476db7b8b64c6b13ff62334a95ad", null ], - [ "getTriggerTimeMicros", "class_timed_reaction.html#a4ff15ba9b01cc69b045aac06b896404c", null ], - [ "isEnabled", "class_timed_reaction.html#af42d731961b6abcd508b48f4e007ebcf", null ], - [ "operator<", "class_timed_reaction.html#a431489308733484afc1f3b6b80289be1", null ], - [ "remove", "class_timed_reaction.html#acac370ae042f0561beecf528551ccad9", null ], - [ "tick", "class_timed_reaction.html#a56eb9a737b11089358d34cc347f9fc7a", null ], - [ "enabled", "class_timed_reaction.html#ae4c582a52e93db97646f8fbb0bb1b909", null ], - [ "interval", "class_timed_reaction.html#ad4a692b89c47ea51055534e8286532fa", null ], - [ "last_trigger_time", "class_timed_reaction.html#a403ac811efb47fc24aae688b83309540", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_timed_reaction__coll__graph.dot b/docs/generated/docs/class_timed_reaction__coll__graph.dot deleted file mode 100644 index 072322e..0000000 --- a/docs/generated/docs/class_timed_reaction__coll__graph.dot +++ /dev/null @@ -1,11 +0,0 @@ -digraph "TimedReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="TimedReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="TimedReactions are called based on elapsing of time."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_timed_reaction__inherit__graph.dot b/docs/generated/docs/class_timed_reaction__inherit__graph.dot deleted file mode 100644 index 873bc81..0000000 --- a/docs/generated/docs/class_timed_reaction__inherit__graph.dot +++ /dev/null @@ -1,15 +0,0 @@ -digraph "TimedReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="TimedReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="TimedReactions are called based on elapsing of time."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; - Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="DelayReaction",height=0.2,width=0.4,color="black",URL="$class_delay_reaction.html",tooltip="Reaction that is triggered after a certain time delay."]; - Node1 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="RepeatReaction",height=0.2,width=0.4,color="black",URL="$class_repeat_reaction.html",tooltip="Reaction that is triggered repeatedly."]; -} diff --git a/docs/generated/docs/class_timed_reaction_a163d0232141ebe0d446d853969766a69_icgraph.dot b/docs/generated/docs/class_timed_reaction_a163d0232141ebe0d446d853969766a69_icgraph.dot deleted file mode 100644 index 1d0a9de..0000000 --- a/docs/generated/docs/class_timed_reaction_a163d0232141ebe0d446d853969766a69_icgraph.dot +++ /dev/null @@ -1,18 +0,0 @@ -digraph "TimedReaction::add" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="RL"; - Node1 [label="TimedReaction::add",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ReactESP::onDelay",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#ab26769ff3e426972e87746749560ffc0",tooltip="Create a new DelayReaction."]; - Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="ReactESP::onDelayMicros",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#ad5739bf0fedb24931f98762113161e95",tooltip="Create a new DelayReaction."]; - Node1 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="ReactESP::onRepeat",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#adb20144bde6e60b41e484d2f6f61d0f5",tooltip="Create a new RepeatReaction."]; - Node1 -> Node5 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node5 [label="ReactESP::onRepeatMicros",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#a2a7018e7a5e89634e8e4385be51eafd4",tooltip="Create a new RepeatReaction."]; -} diff --git a/docs/generated/docs/class_untimed_reaction.js b/docs/generated/docs/class_untimed_reaction.js deleted file mode 100644 index 6beab85..0000000 --- a/docs/generated/docs/class_untimed_reaction.js +++ /dev/null @@ -1,8 +0,0 @@ -var class_untimed_reaction = -[ - [ "UntimedReaction", "class_untimed_reaction.html#a1e33cb5f40db3c477f0a476d63999770", null ], - [ "~UntimedReaction", "class_untimed_reaction.html#acd2ff1b448599949c3ad1d2e80b23507", null ], - [ "add", "class_untimed_reaction.html#aaf8d78a83d9c8174a2e069cb6279a793", null ], - [ "remove", "class_untimed_reaction.html#a52cdd4974e63425e6db056a50c9a51d6", null ], - [ "tick", "class_untimed_reaction.html#a803aa29ba1f5d9f0312d71e09ee83f15", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/class_untimed_reaction__coll__graph.dot b/docs/generated/docs/class_untimed_reaction__coll__graph.dot deleted file mode 100644 index 97c68a7..0000000 --- a/docs/generated/docs/class_untimed_reaction__coll__graph.dot +++ /dev/null @@ -1,11 +0,0 @@ -digraph "UntimedReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="UntimedReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reactions that are triggered based on something else than time."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; -} diff --git a/docs/generated/docs/class_untimed_reaction__inherit__graph.dot b/docs/generated/docs/class_untimed_reaction__inherit__graph.dot deleted file mode 100644 index 91383bf..0000000 --- a/docs/generated/docs/class_untimed_reaction__inherit__graph.dot +++ /dev/null @@ -1,15 +0,0 @@ -digraph "UntimedReaction" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="UntimedReaction",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip="Reactions that are triggered based on something else than time."]; - Node2 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; - Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="StreamReaction",height=0.2,width=0.4,color="black",URL="$class_stream_reaction.html",tooltip="Reaction that is triggered when there is input available at the given Arduino Stream."]; - Node1 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="TickReaction",height=0.2,width=0.4,color="black",URL="$class_tick_reaction.html",tooltip="Reaction that is triggered unconditionally at each execution loop."]; -} diff --git a/docs/generated/docs/class_untimed_reaction_aaf8d78a83d9c8174a2e069cb6279a793_icgraph.dot b/docs/generated/docs/class_untimed_reaction_aaf8d78a83d9c8174a2e069cb6279a793_icgraph.dot deleted file mode 100644 index 2c7fdd7..0000000 --- a/docs/generated/docs/class_untimed_reaction_aaf8d78a83d9c8174a2e069cb6279a793_icgraph.dot +++ /dev/null @@ -1,14 +0,0 @@ -digraph "UntimedReaction::add" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="RL"; - Node1 [label="UntimedReaction::add",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ReactESP::onAvailable",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#a831c11dd7f1a6e15d70785c3a990df93",tooltip="Create a new StreamReaction."]; - Node1 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="ReactESP::onTick",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#a7da68d41f2a9790ab1aec2610bad07eb",tooltip="Create a new TickReaction."]; -} diff --git a/docs/generated/docs/classes.html b/docs/generated/docs/classes.html index 4c2a109..f1179b2 100644 --- a/docs/generated/docs/classes.html +++ b/docs/generated/docs/classes.html @@ -32,7 +32,7 @@ -
diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction-members.html b/docs/generated/docs/classreactesp_1_1_delay_reaction-members.html new file mode 100644 index 0000000..f408a2b --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction-members.html @@ -0,0 +1,126 @@ + + + + + + + +ReactESP: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
reactesp::DelayReaction Member List
+
+
+ +

This is the complete list of members for reactesp::DelayReaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + + +
add()reactesp::TimedReactionvirtual
callbackreactesp::Reactionprotected
DelayReaction(const uint32_t delay, const react_callback callback)reactesp::DelayReaction
DelayReaction(const uint64_t delay, const react_callback callback)reactesp::DelayReaction
enabledreactesp::TimedReactionprotected
getTriggerTime()reactesp::TimedReactioninline
getTriggerTimeMicros()reactesp::TimedReactioninline
intervalreactesp::TimedReactionprotected
isEnabled()reactesp::TimedReactioninline
last_trigger_timereactesp::TimedReactionprotected
operator<(const TimedReaction &other)reactesp::TimedReaction
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::TimedReactionvirtual
tick()reactesp::DelayReactionvirtual
TimedReaction(const uint32_t interval, const react_callback callback)reactesp::TimedReactioninline
TimedReaction(const uint64_t interval, const react_callback callback)reactesp::TimedReactioninline
~DelayReaction()reactesp::DelayReactioninlinevirtual
~TimedReaction()reactesp::TimedReactioninlinevirtual
+
+ + + + diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction.html b/docs/generated/docs/classreactesp_1_1_delay_reaction.html new file mode 100644 index 0000000..6c0a462 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction.html @@ -0,0 +1,323 @@ + + + + + + + +ReactESP: reactesp::DelayReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
reactesp::DelayReaction Class Reference
+
+
+ +

Reaction that is triggered after a certain time delay. + More...

+ +

#include <ReactESP.h>

+
+Inheritance diagram for reactesp::DelayReaction:
+
+
+
+
[legend]
+
+Collaboration diagram for reactesp::DelayReaction:
+
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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 ()
 
- Public Member Functions inherited from reactesp::TimedReaction
 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 ()
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from reactesp::TimedReaction
const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 
+

Detailed Description

+

Reaction that is triggered after a certain time delay.

+ +

Definition at line 94 of file ReactESP.h.

+

Constructor & Destructor Documentation

+ +

◆ DelayReaction() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
reactesp::DelayReaction::DelayReaction (const uint32_t delay,
const react_callback callback 
)
+
+ +

Construct a new Delay Reaction object.

+
Parameters
+ + + +
delayDelay, in milliseconds
callbackFunction to be called after the delay
+
+
+ +

Definition at line 36 of file ReactESP.cpp.

+ +
+
+ +

◆ DelayReaction() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
reactesp::DelayReaction::DelayReaction (const uint64_t delay,
const react_callback callback 
)
+
+ +

Construct a new Delay Reaction object.

+
Parameters
+ + + +
delayDelay, in microseconds
callbackFunction to be called after the delay
+
+
+ +

Definition at line 41 of file ReactESP.cpp.

+ +
+
+ +

◆ ~DelayReaction()

+ +
+
+ + + + + +
+ + + + + + + +
virtual reactesp::DelayReaction::~DelayReaction ()
+
+inlinevirtual
+
+ +

Definition at line 110 of file ReactESP.h.

+ +
+
+

Member Function Documentation

+ +

◆ tick()

+ +
+
+ + + + + +
+ + + + + + + +
void reactesp::DelayReaction::tick ()
+
+virtual
+
+ +

Implements reactesp::TimedReaction.

+ +

Definition at line 46 of file ReactESP.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction.js b/docs/generated/docs/classreactesp_1_1_delay_reaction.js new file mode 100644 index 0000000..b12be8c --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction.js @@ -0,0 +1,7 @@ +var classreactesp_1_1_delay_reaction = +[ + [ "DelayReaction", "classreactesp_1_1_delay_reaction.html#aac5ab07009878644f0d9d1d5b2f7ce40", null ], + [ "DelayReaction", "classreactesp_1_1_delay_reaction.html#a6fbe0cd7f47fc81abdade25f09eed5f8", null ], + [ "~DelayReaction", "classreactesp_1_1_delay_reaction.html#af1fbdbee6c0c032d5acab763d315a34d", null ], + [ "tick", "classreactesp_1_1_delay_reaction.html#ad7f7bab48635897fec696b139d59c134", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.map new file mode 100644 index 0000000..23e12e9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.md5 new file mode 100644 index 0000000..b5dd250 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.md5 @@ -0,0 +1 @@ +b5c86eff9aa51c9b190d0b64b2dbdfb8 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.svg new file mode 100644 index 0000000..0b4396b --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction__coll__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::DelayReaction + + +Node1 + + +reactesp::DelayReaction + + + + + +Node2 + + +reactesp::TimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.map new file mode 100644 index 0000000..23e12e9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.md5 new file mode 100644 index 0000000..b5dd250 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +b5c86eff9aa51c9b190d0b64b2dbdfb8 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.svg new file mode 100644 index 0000000..0b4396b --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_delay_reaction__inherit__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::DelayReaction + + +Node1 + + +reactesp::DelayReaction + + + + + +Node2 + + +reactesp::TimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/class_untimed_reaction-members.html b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction-members.html similarity index 60% rename from docs/generated/docs/class_untimed_reaction-members.html rename to docs/generated/docs/classreactesp_1_1_i_s_r_reaction-members.html index 3698f69..d0f45dd 100644 --- a/docs/generated/docs/class_untimed_reaction-members.html +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -90,19 +90,19 @@
-
UntimedReaction Member List
+
reactesp::ISRReaction Member List
-

This is the complete list of members for UntimedReaction, including all inherited members.

+

This is the complete list of members for reactesp::ISRReaction, including all inherited members.

- - - - - - - + + + + + + +
add()UntimedReactionvirtual
callbackReactionprotected
Reaction(react_callback callback)Reactioninline
remove()UntimedReactionvirtual
tick()=0UntimedReactionpure virtual
UntimedReaction(const react_callback callback)UntimedReactioninline
~UntimedReaction()UntimedReactioninlinevirtual
add()reactesp::ISRReactionvirtual
callbackreactesp::Reactionprotected
ISRReaction(uint8_t pin_number, int mode, const react_callback callback)reactesp::ISRReactioninline
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::ISRReactionvirtual
tick()reactesp::ISRReactioninlinevirtual
~ISRReaction()reactesp::ISRReactioninlinevirtual
diff --git a/docs/generated/docs/class_i_s_r_reaction.html b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction.html similarity index 52% rename from docs/generated/docs/class_i_s_r_reaction.html rename to docs/generated/docs/classreactesp_1_1_i_s_r_reaction.html index d9a9562..fcf901c 100644 --- a/docs/generated/docs/class_i_s_r_reaction.html +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction.html @@ -5,7 +5,7 @@ -ReactESP: ISRReaction Class Reference +ReactESP: reactesp::ISRReaction Class Reference @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -92,59 +92,59 @@ +
reactesp::ISRReaction Class Reference
-

Reaction that is triggered on an input pin change. - More...

+

Reaction that is triggered on an input pin change. + More...

#include <ReactESP.h>

-Inheritance diagram for ISRReaction:
+Inheritance diagram for reactesp::ISRReaction:
-
+
[legend]
-Collaboration diagram for ISRReaction:
+Collaboration diagram for reactesp::ISRReaction:
-
+
[legend]
- - - - - - - - - - - - - - - + + + + + + + + + + + + + + +

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 ()
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
 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 ()
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - + + +

Additional Inherited Members

- Protected Attributes inherited from Reaction
const react_callback callback
 
- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 

Detailed Description

-

Reaction that is triggered on an input pin change.

+

Reaction that is triggered on an input pin change.

-

Definition at line 185 of file ReactESP.h.

+

Definition at line 187 of file ReactESP.h.

Constructor & Destructor Documentation

- -

◆ ISRReaction()

+ +

◆ ISRReaction()

@@ -153,7 +153,7 @@

- + @@ -167,7 +167,7 @@

- + @@ -183,7 +183,7 @@

-

Construct a new ISRReaction object.

+

Construct a new ISRReaction object.

Parameters

ISRReaction::ISRReaction reactesp::ISRReaction::ISRReaction ( uint8_t  pin_number, const react_callback const react_callback  callback 
@@ -193,12 +193,12 @@

Definition at line 204 of file ReactESP.h.

+

Definition at line 206 of file ReactESP.h.

- -

◆ ~ISRReaction()

+ +

◆ ~ISRReaction()

@@ -207,7 +207,7 @@

pin_numberGPIO pin number to which the interrupt is attached
- + @@ -220,13 +220,13 @@

-

Definition at line 233 of file ReactESP.h.

+

Definition at line 235 of file ReactESP.h.

Member Function Documentation

- -

◆ add()

+ +

◆ add()

@@ -235,7 +235,7 @@

virtual ISRReaction::~ISRReaction virtual reactesp::ISRReaction::~ISRReaction ( )
- + @@ -248,26 +248,20 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 85 of file ReactESP.cpp.

-
-Here is the call graph for this function:
-
-
-
-
+

Definition at line 87 of file ReactESP.cpp.

Here is the caller graph for this function:
-
+
- -

◆ remove()

+ +

◆ remove()

@@ -276,7 +270,7 @@

void ISRReaction::add void reactesp::ISRReaction::add ( )
- + @@ -289,14 +283,20 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 94 of file ReactESP.cpp.

+

Definition at line 96 of file ReactESP.cpp.

+
+Here is the caller graph for this function:
+
+
+
+
- -

◆ tick()

+ +

◆ tick()

@@ -305,7 +305,7 @@

void ISRReaction::remove void reactesp::ISRReaction::remove ( )
- + @@ -318,9 +318,9 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 236 of file ReactESP.h.

+

Definition at line 238 of file ReactESP.h.

@@ -333,7 +333,7 @@

diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction.js b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction.js new file mode 100644 index 0000000..e4848d9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction.js @@ -0,0 +1,8 @@ +var classreactesp_1_1_i_s_r_reaction = +[ + [ "ISRReaction", "classreactesp_1_1_i_s_r_reaction.html#add1ee86128b01e211cac9126a8b485d3", null ], + [ "~ISRReaction", "classreactesp_1_1_i_s_r_reaction.html#a850a9346562861c44a9bc3a20e13ba1f", null ], + [ "add", "classreactesp_1_1_i_s_r_reaction.html#ac7b7efd14de7cd96df315e761f962d4a", null ], + [ "remove", "classreactesp_1_1_i_s_r_reaction.html#a9ccf4abc748379340fb0e97b77c3bc4d", null ], + [ "tick", "classreactesp_1_1_i_s_r_reaction.html#aa8a31d433ff7e8a112afd9461e5da479", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.map new file mode 100644 index 0000000..cc242d1 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.md5 new file mode 100644 index 0000000..cee5071 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.md5 @@ -0,0 +1 @@ +a262977e6d63b6892f5dc4d174896f25 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.svg new file mode 100644 index 0000000..7b6e3ec --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__coll__graph.svg @@ -0,0 +1,36 @@ + + + + + + +reactesp::ISRReaction + + +Node1 + + +reactesp::ISRReaction + + + + + +Node2 + + +reactesp::Reaction + + + + + +Node2->Node1 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.map new file mode 100644 index 0000000..cc242d1 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.md5 new file mode 100644 index 0000000..cee5071 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +a262977e6d63b6892f5dc4d174896f25 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.svg new file mode 100644 index 0000000..7b6e3ec --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction__inherit__graph.svg @@ -0,0 +1,36 @@ + + + + + + +reactesp::ISRReaction + + +Node1 + + +reactesp::ISRReaction + + + + + +Node2 + + +reactesp::Reaction + + + + + +Node2->Node1 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.map b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.map new file mode 100644 index 0000000..7ab1a1f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.md5 new file mode 100644 index 0000000..3a80635 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.md5 @@ -0,0 +1 @@ +285d5b1e64c5980f75360e5e2bc56006 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.svg b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.svg new file mode 100644 index 0000000..31ec81e --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_a9ccf4abc748379340fb0e97b77c3bc4d_icgraph.svg @@ -0,0 +1,52 @@ + + + + + + +reactesp::ISRReaction::remove + + +Node1 + + +reactesp::ISRReaction +::remove + + + + + +Node2 + + +setup_io_pins + + + + + +Node1->Node2 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.map b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.map new file mode 100644 index 0000000..03aa3d3 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.md5 new file mode 100644 index 0000000..268e5fb --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.md5 @@ -0,0 +1 @@ +e8e209b66e45787a658d43ef87884c5f \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.svg b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.svg new file mode 100644 index 0000000..f967a5e --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_i_s_r_reaction_ac7b7efd14de7cd96df315e761f962d4a_icgraph.svg @@ -0,0 +1,67 @@ + + + + + + +reactesp::ISRReaction::add + + +Node1 + + +reactesp::ISRReaction::add + + + + + +Node2 + + +reactesp::ReactESP +::onInterrupt + + + + + +Node1->Node2 + + + + + +Node3 + + +setup_io_pins + + + + + +Node2->Node3 + + + + + +Node4 + + +setup + + + + + +Node3->Node4 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p-members.html b/docs/generated/docs/classreactesp_1_1_react_e_s_p-members.html new file mode 100644 index 0000000..068dd55 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p-members.html @@ -0,0 +1,123 @@ + + + + + + + +ReactESP: Member List + + + + + + + + + + + + + + + +
+
+

void ISRReaction::tick void reactesp::ISRReaction::tick ( )
+ + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+

+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
reactesp::ReactESP Member List
+
+
+ +

This is the complete list of members for reactesp::ReactESP, including all inherited members.

+ + + + + + + + + + + + + + + + +
appreactesp::ReactESPstatic
ISRReactionreactesp::ReactESPfriend
onAvailable(Stream &stream, const react_callback cb)reactesp::ReactESP
onDelay(const uint32_t t, const react_callback cb)reactesp::ReactESP
onDelayMicros(const uint64_t t, const react_callback cb)reactesp::ReactESP
onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)reactesp::ReactESP
onRepeat(const uint32_t t, const react_callback cb)reactesp::ReactESP
onRepeatMicros(const uint64_t t, const react_callback cb)reactesp::ReactESP
onTick(const react_callback cb)reactesp::ReactESP
ReactESP()reactesp::ReactESPinline
Reactionreactesp::ReactESPfriend
RepeatReactionreactesp::ReactESPfriend
tick(void)reactesp::ReactESP
TimedReactionreactesp::ReactESPfriend
UntimedReactionreactesp::ReactESPfriend
+
+ + + + diff --git a/docs/generated/docs/class_react_e_s_p.html b/docs/generated/docs/classreactesp_1_1_react_e_s_p.html similarity index 52% rename from docs/generated/docs/class_react_e_s_p.html rename to docs/generated/docs/classreactesp_1_1_react_e_s_p.html index 3645ddd..a13304d 100644 --- a/docs/generated/docs/class_react_e_s_p.html +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p.html @@ -5,7 +5,7 @@ -ReactESP: ReactESP Class Reference +ReactESP: reactesp::ReactESP Class Reference @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
-
ReactESP Class Reference
+List of all members
+
reactesp::ReactESP Class Reference
-

Main class of a ReactESP program. - More...

+

Main class of a ReactESP program. + More...

#include <ReactESP.h>

-Collaboration diagram for ReactESP:
+Collaboration diagram for reactesp::ReactESP:
-
+
[legend]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 ReactESP (const react_callback cb)
 Construct a new ReactESP object. More...
 
void setup (void)
 
void tick (void)
 
DelayReactiononDelay (const uint32_t t, const react_callback cb)
 Create a new DelayReaction. More...
 
DelayReactiononDelayMicros (const uint64_t t, const react_callback cb)
 Create a new DelayReaction. More...
 
RepeatReactiononRepeat (const uint32_t t, const react_callback cb)
 Create a new RepeatReaction. More...
 
RepeatReactiononRepeatMicros (const uint64_t t, const react_callback cb)
 Create a new RepeatReaction. More...
 
StreamReactiononAvailable (Stream &stream, const react_callback cb)
 Create a new StreamReaction. More...
 
ISRReactiononInterrupt (const uint8_t pin_number, int mode, const react_callback cb)
 Create a new ISRReaction (interrupt reaction) More...
 
TickReactiononTick (const react_callback cb)
 Create a new TickReaction. More...
 
 ReactESP ()
 Construct a new ReactESP object. More...
 
void tick (void)
 
DelayReactiononDelay (const uint32_t t, const react_callback cb)
 Create a new DelayReaction. More...
 
DelayReactiononDelayMicros (const uint64_t t, const react_callback cb)
 Create a new DelayReaction. More...
 
RepeatReactiononRepeat (const uint32_t t, const react_callback cb)
 Create a new RepeatReaction. More...
 
RepeatReactiononRepeatMicros (const uint64_t t, const react_callback cb)
 Create a new RepeatReaction. More...
 
StreamReactiononAvailable (Stream &stream, const react_callback cb)
 Create a new StreamReaction. More...
 
ISRReactiononInterrupt (const uint8_t pin_number, int mode, const react_callback cb)
 Create a new ISRReaction (interrupt reaction) More...
 
TickReactiononTick (const react_callback cb)
 Create a new TickReaction. More...
 
- - - + + +

Static Public Attributes

static ReactESPapp = NULL
 Static singleton reference to the instantiated ReactESP object. More...
 
static ReactESPapp = NULL
 Static singleton reference to the instantiated ReactESP object. More...
 
- + - + - + - + - +

Friends

class Reaction
class Reaction
 
class TimedReaction
class TimedReaction
 
class RepeatReaction
class RepeatReaction
 
class UntimedReaction
class UntimedReaction
 
class ISRReaction
class ISRReaction
 

Detailed Description

-

Main class of a ReactESP program.

+

Main class of a ReactESP program.

-

Definition at line 245 of file ReactESP.h.

+

Definition at line 247 of file ReactESP.h.

Constructor & Destructor Documentation

- -

◆ ReactESP()

+ +

◆ ReactESP()

@@ -175,10 +173,9 @@

- + - - +
ReactESP::ReactESP reactesp::ReactESP::ReactESP (const react_callback cb))
@@ -189,27 +186,21 @@

-

Construct a new ReactESP object.

-
Parameters
- - -
cbSetup function to be called. This is equivalent to the regular Arduino setup() function and should perform any initial setup the program requires.
-
-
+

Construct a new ReactESP object.

-

Definition at line 260 of file ReactESP.h.

+

Definition at line 258 of file ReactESP.h.

Member Function Documentation

- -

◆ onAvailable()

+ +

◆ onAvailable()

- + @@ -217,7 +208,7 @@

- + @@ -228,7 +219,7 @@

-

Create a new StreamReaction.

+

Create a new StreamReaction.

Parameters

StreamReaction * ReactESP::onAvailable StreamReaction * reactesp::ReactESP::onAvailable ( Stream &  stream, const react_callback const react_callback  cb 
@@ -238,24 +229,30 @@

Returns
StreamReaction*
-

Definition at line 176 of file ReactESP.cpp.

+

Definition at line 171 of file ReactESP.cpp.

Here is the call graph for this function:
-
+
+
+
+
+Here is the caller graph for this function:
+
+
- -

◆ onDelay()

+ +

◆ onDelay()

streamArduino Stream object to monitor
- + @@ -263,7 +260,7 @@

- + @@ -274,7 +271,7 @@

-

Create a new DelayReaction.

+

Create a new DelayReaction.

Parameters

DelayReaction * ReactESP::onDelay DelayReaction * reactesp::ReactESP::onDelay ( const uint32_t  t, const react_callback const react_callback  cb 
@@ -284,24 +281,30 @@

Returns
DelayReaction*
-

Definition at line 150 of file ReactESP.cpp.

+

Definition at line 145 of file ReactESP.cpp.

Here is the call graph for this function:
-
+
+
+
+
+Here is the caller graph for this function:
+
+
- -

◆ onDelayMicros()

+ +

◆ onDelayMicros()

tDelay, in milliseconds
- + @@ -309,7 +312,7 @@

- + @@ -320,7 +323,7 @@

-

Create a new DelayReaction.

+

Create a new DelayReaction.

Parameters

DelayReaction * ReactESP::onDelayMicros DelayReaction * reactesp::ReactESP::onDelayMicros ( const uint64_t  t, const react_callback const react_callback  cb 
@@ -330,24 +333,24 @@

Returns
DelayReaction*
-

Definition at line 156 of file ReactESP.cpp.

+

Definition at line 151 of file ReactESP.cpp.

Here is the call graph for this function:
-
+
- -

◆ onInterrupt()

+ +

◆ onInterrupt()

tDelay, in microseconds
- + @@ -361,7 +364,7 @@

- + @@ -372,7 +375,7 @@

-

Create a new ISRReaction (interrupt reaction)

+

Create a new ISRReaction (interrupt reaction)

Parameters

ISRReaction * ReactESP::onInterrupt ISRReaction * reactesp::ReactESP::onInterrupt ( const uint8_t  pin_number, const react_callback const react_callback  cb 
@@ -383,24 +386,30 @@

Returns
ISRReaction*
-

Definition at line 182 of file ReactESP.cpp.

+

Definition at line 177 of file ReactESP.cpp.

Here is the call graph for this function:
-
+
+
+
+
+Here is the caller graph for this function:
+
+
- -

◆ onRepeat()

+ +

◆ onRepeat()

pin_numberGPIO pin number
- + @@ -408,7 +417,7 @@

- + @@ -419,7 +428,7 @@

-

Create a new RepeatReaction.

+

Create a new RepeatReaction.

Parameters

RepeatReaction * ReactESP::onRepeat RepeatReaction * reactesp::ReactESP::onRepeat ( const uint32_t  t, const react_callback const react_callback  cb 
@@ -429,24 +438,30 @@

Returns
RepeatReaction*
-

Definition at line 163 of file ReactESP.cpp.

+

Definition at line 158 of file ReactESP.cpp.

Here is the call graph for this function:
-
+
+
+
+
+Here is the caller graph for this function:
+
+
- -

◆ onRepeatMicros()

+ +

◆ onRepeatMicros()

tInterval, in milliseconds
- + @@ -454,7 +469,7 @@

- + @@ -465,7 +480,7 @@

-

Create a new RepeatReaction.

+

Create a new RepeatReaction.

Parameters

RepeatReaction * ReactESP::onRepeatMicros RepeatReaction * reactesp::ReactESP::onRepeatMicros ( const uint64_t  t, const react_callback const react_callback  cb 
@@ -475,33 +490,33 @@

Returns
RepeatReaction*
-

Definition at line 169 of file ReactESP.cpp.

+

Definition at line 164 of file ReactESP.cpp.

Here is the call graph for this function:
-
+
- -

◆ onTick()

+ +

◆ onTick()

tInterval, in microseconds
- + - +
TickReaction * ReactESP::onTick TickReaction * reactesp::ReactESP::onTick (const react_callback const react_callback  cb)
-

Create a new TickReaction.

+

Create a new TickReaction.

Parameters
@@ -510,58 +525,30 @@

Returns
TickReaction*
-

Definition at line 189 of file ReactESP.cpp.

+

Definition at line 184 of file ReactESP.cpp.

Here is the call graph for this function:
-
-
+
-
- - -

◆ setup()

- -
-
-

cbCallback function to be called at every loop execution
- - - - -
- - - - - - - - -
void ReactESP::setup (void )
-
-inline
-
- -

Definition at line 261 of file ReactESP.h.

Here is the caller graph for this function:
-
+
- -

◆ tick()

+ +

◆ tick()

- + @@ -570,11 +557,11 @@

-

Definition at line 145 of file ReactESP.cpp.

+

Definition at line 140 of file ReactESP.cpp.

Here is the caller graph for this function:
-
+
@@ -591,7 +578,7 @@

void ReactESP::tick void reactesp::ReactESP::tick ( void  )
- +
friend class ISRReactionfriend class ISRReaction
@@ -601,7 +588,7 @@

-

Definition at line 250 of file ReactESP.h.

+

Definition at line 252 of file ReactESP.h.

@@ -615,7 +602,7 @@

- +
friend class Reactionfriend class Reaction
@@ -625,7 +612,7 @@

-

Definition at line 246 of file ReactESP.h.

+

Definition at line 248 of file ReactESP.h.

@@ -639,7 +626,7 @@

- +
friend class RepeatReactionfriend class RepeatReaction
@@ -649,7 +636,7 @@

-

Definition at line 248 of file ReactESP.h.

+

Definition at line 250 of file ReactESP.h.

@@ -663,7 +650,7 @@

- +
friend class TimedReactionfriend class TimedReaction
@@ -673,7 +660,7 @@

-

Definition at line 247 of file ReactESP.h.

+

Definition at line 249 of file ReactESP.h.

@@ -687,7 +674,7 @@

- +
friend class UntimedReactionfriend class UntimedReaction
@@ -697,13 +684,13 @@

-

Definition at line 249 of file ReactESP.h.

+

Definition at line 251 of file ReactESP.h.

Member Data Documentation

- -

◆ app

+ +

◆ app

@@ -737,7 +724,7 @@

diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p.js b/docs/generated/docs/classreactesp_1_1_react_e_s_p.js new file mode 100644 index 0000000..b2d7eec --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p.js @@ -0,0 +1,17 @@ +var classreactesp_1_1_react_e_s_p = +[ + [ "ReactESP", "classreactesp_1_1_react_e_s_p.html#ab60d32aea4a5c8040d9fb46797ebd63e", null ], + [ "onAvailable", "classreactesp_1_1_react_e_s_p.html#a42c88fbcd1f1ab9842517056448de6b5", null ], + [ "onDelay", "classreactesp_1_1_react_e_s_p.html#a5b25d026d1f26fb80b2c6659f3875fd8", null ], + [ "onDelayMicros", "classreactesp_1_1_react_e_s_p.html#a4f51c39bd90492f6184872f6d91f14dd", null ], + [ "onInterrupt", "classreactesp_1_1_react_e_s_p.html#afa5876a2a33275dc7d0ba8214bb51ee7", null ], + [ "onRepeat", "classreactesp_1_1_react_e_s_p.html#a914de417d6b11c6111df8bba25d5ed75", null ], + [ "onRepeatMicros", "classreactesp_1_1_react_e_s_p.html#ad15637cf3778be71a156845bd069506a", null ], + [ "onTick", "classreactesp_1_1_react_e_s_p.html#ae442c7e1e8084f46a900646957f1f9c8", null ], + [ "tick", "classreactesp_1_1_react_e_s_p.html#a683d99a3ed39a75337f01888c2240df0", null ], + [ "ISRReaction", "classreactesp_1_1_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269", null ], + [ "Reaction", "classreactesp_1_1_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51", null ], + [ "RepeatReaction", "classreactesp_1_1_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348", null ], + [ "TimedReaction", "classreactesp_1_1_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d", null ], + [ "UntimedReaction", "classreactesp_1_1_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.map new file mode 100644 index 0000000..00b5583 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.md5 new file mode 100644 index 0000000..4a90bc4 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.md5 @@ -0,0 +1 @@ +024e82bdff4f9a4ac5518691aee06a5c \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.svg new file mode 100644 index 0000000..0dd99d0 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p__coll__graph.svg @@ -0,0 +1,28 @@ + + + + + + +reactesp::ReactESP + + +Node1 + + +reactesp::ReactESP + + + + + +Node1->Node1 + + + app + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.map new file mode 100644 index 0000000..8517fe3 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.md5 new file mode 100644 index 0000000..d8a0816 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.md5 @@ -0,0 +1 @@ +4f0c68274ca252ca365b1ede6823211d \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.svg new file mode 100644 index 0000000..9a671f8 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onAvailable + + +Node1 + + +reactesp::ReactESP +::onAvailable + + + + + +Node2 + + +reactesp::UntimedReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.map new file mode 100644 index 0000000..5db0ccd --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.md5 new file mode 100644 index 0000000..8f4bedb --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.md5 @@ -0,0 +1 @@ +336663aff8870f4a12c70c8a012fbe32 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.svg new file mode 100644 index 0000000..9123d6f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a42c88fbcd1f1ab9842517056448de6b5_icgraph.svg @@ -0,0 +1,52 @@ + + + + + + +reactesp::ReactESP::onAvailable + + +Node1 + + +reactesp::ReactESP +::onAvailable + + + + + +Node2 + + +setup_serial + + + + + +Node1->Node2 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.map new file mode 100644 index 0000000..50977a8 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.md5 new file mode 100644 index 0000000..ab374b4 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.md5 @@ -0,0 +1 @@ +ee36245d8caef988f7d3d045dc93fa38 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.svg new file mode 100644 index 0000000..cbf5391 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a4f51c39bd90492f6184872f6d91f14dd_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onDelayMicros + + +Node1 + + +reactesp::ReactESP +::onDelayMicros + + + + + +Node2 + + +reactesp::TimedReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.map new file mode 100644 index 0000000..8ddf815 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.md5 new file mode 100644 index 0000000..4de9c8e --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.md5 @@ -0,0 +1 @@ +2f6b4d0046f0a13130170b55b149fb92 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.svg new file mode 100644 index 0000000..899e832 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onDelay + + +Node1 + + +reactesp::ReactESP +::onDelay + + + + + +Node2 + + +reactesp::TimedReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.map new file mode 100644 index 0000000..578eae0 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.md5 new file mode 100644 index 0000000..8d771ef --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.md5 @@ -0,0 +1 @@ +bdc0299ec0407952dd67f54e0581fcb8 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.svg new file mode 100644 index 0000000..b28a9a5 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a5b25d026d1f26fb80b2c6659f3875fd8_icgraph.svg @@ -0,0 +1,52 @@ + + + + + + +reactesp::ReactESP::onDelay + + +Node1 + + +reactesp::ReactESP +::onDelay + + + + + +Node2 + + +setup_serial + + + + + +Node1->Node2 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.map new file mode 100644 index 0000000..f24b108 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.md5 new file mode 100644 index 0000000..a6e8d97 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.md5 @@ -0,0 +1 @@ +4131340451f015c8b37e08280dd1414d \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.svg new file mode 100644 index 0000000..1d5ab87 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a683d99a3ed39a75337f01888c2240df0_icgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::tick + + +Node1 + + +reactesp::ReactESP +::tick + + + + + +Node2 + + +loop + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.map new file mode 100644 index 0000000..41da7e6 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.md5 new file mode 100644 index 0000000..e079412 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.md5 @@ -0,0 +1 @@ +03318673752f8f24876e3405da25e673 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.svg new file mode 100644 index 0000000..81c30ea --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onRepeat + + +Node1 + + +reactesp::ReactESP +::onRepeat + + + + + +Node2 + + +reactesp::TimedReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.map new file mode 100644 index 0000000..90d4dc6 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.md5 new file mode 100644 index 0000000..90953d5 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.md5 @@ -0,0 +1 @@ +f3f794ebdbf979b0ac3b2e262b26c66e \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.svg new file mode 100644 index 0000000..6837c24 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_a914de417d6b11c6111df8bba25d5ed75_icgraph.svg @@ -0,0 +1,73 @@ + + + + + + +reactesp::ReactESP::onRepeat + + +Node1 + + +reactesp::ReactESP +::onRepeat + + + + + +Node2 + + +setup_io_pins + + + + + +Node1->Node2 + + + + + +Node4 + + +setup_timers + + + + + +Node1->Node4 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + +Node4->Node3 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.map new file mode 100644 index 0000000..21434a3 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.md5 new file mode 100644 index 0000000..c7bc263 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.md5 @@ -0,0 +1 @@ +588278e4cb3c8229823c8729ae829658 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.svg new file mode 100644 index 0000000..aae9a0d --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ad15637cf3778be71a156845bd069506a_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onRepeatMicros + + +Node1 + + +reactesp::ReactESP +::onRepeatMicros + + + + + +Node2 + + +reactesp::TimedReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.map new file mode 100644 index 0000000..1a3a109 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.md5 new file mode 100644 index 0000000..188a099 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.md5 @@ -0,0 +1 @@ +f43d11b2bd5149fa6941eff4006d9ac7 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.svg new file mode 100644 index 0000000..42bbd50 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onTick + + +Node1 + + +reactesp::ReactESP +::onTick + + + + + +Node2 + + +reactesp::UntimedReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.map new file mode 100644 index 0000000..3810614 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.md5 new file mode 100644 index 0000000..ffa1add --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.md5 @@ -0,0 +1 @@ +5abbbd0664451828e93dce6d716c364f \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.svg new file mode 100644 index 0000000..980ffa2 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_ae442c7e1e8084f46a900646957f1f9c8_icgraph.svg @@ -0,0 +1,52 @@ + + + + + + +reactesp::ReactESP::onTick + + +Node1 + + +reactesp::ReactESP +::onTick + + + + + +Node2 + + +setup_tick + + + + + +Node1->Node2 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.map new file mode 100644 index 0000000..8fd5e55 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.md5 new file mode 100644 index 0000000..254025f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.md5 @@ -0,0 +1 @@ +52b156d7784ffddef6e6d0fd2fc07f57 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.svg new file mode 100644 index 0000000..adfad14 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +reactesp::ReactESP::onInterrupt + + +Node1 + + +reactesp::ReactESP +::onInterrupt + + + + + +Node2 + + +reactesp::ISRReaction::add + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.map b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.map new file mode 100644 index 0000000..dd3ee45 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.md5 new file mode 100644 index 0000000..e8c06df --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.md5 @@ -0,0 +1 @@ +6c8ff2d6b7b434b2061d2d878512b9c5 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.svg b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.svg new file mode 100644 index 0000000..277c6a8 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_react_e_s_p_afa5876a2a33275dc7d0ba8214bb51ee7_icgraph.svg @@ -0,0 +1,52 @@ + + + + + + +reactesp::ReactESP::onInterrupt + + +Node1 + + +reactesp::ReactESP +::onInterrupt + + + + + +Node2 + + +setup_io_pins + + + + + +Node1->Node2 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/class_reaction-members.html b/docs/generated/docs/classreactesp_1_1_reaction-members.html similarity index 68% rename from docs/generated/docs/class_reaction-members.html rename to docs/generated/docs/classreactesp_1_1_reaction-members.html index b45cf08..b073444 100644 --- a/docs/generated/docs/class_reaction-members.html +++ b/docs/generated/docs/classreactesp_1_1_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -90,17 +90,17 @@
-
Reaction Member List
+
reactesp::Reaction Member List
-

This is the complete list of members for Reaction, including all inherited members.

+

This is the complete list of members for reactesp::Reaction, including all inherited members.

- - - - - + + + + +
add()=0Reactionpure virtual
callbackReactionprotected
Reaction(react_callback callback)Reactioninline
remove()=0Reactionpure virtual
tick()=0Reactionpure virtual
add()=0reactesp::Reactionpure virtual
callbackreactesp::Reactionprotected
Reaction(react_callback callback)reactesp::Reactioninline
remove()=0reactesp::Reactionpure virtual
tick()=0reactesp::Reactionpure virtual
diff --git a/docs/generated/docs/class_reaction.html b/docs/generated/docs/classreactesp_1_1_reaction.html similarity index 57% rename from docs/generated/docs/class_reaction.html rename to docs/generated/docs/classreactesp_1_1_reaction.html index d6fa3e1..81f5051 100644 --- a/docs/generated/docs/class_reaction.html +++ b/docs/generated/docs/classreactesp_1_1_reaction.html @@ -5,7 +5,7 @@ -ReactESP: Reaction Class Reference +ReactESP: reactesp::Reaction Class Reference @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -93,46 +93,46 @@ -
Reaction Class Referenceabstract
+List of all members
+
reactesp::Reaction Class Referenceabstract

Reactions are code to be called when a given condition is fulfilled. - More...

+ More...

#include <ReactESP.h>

-Inheritance diagram for Reaction:
+Inheritance diagram for reactesp::Reaction:
-
+
[legend]
- - - - - - - - - + + + + + + + + +

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
 
 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
 
const react_callback callback
 

Detailed Description

Reactions are code to be called when a given condition is fulfilled.

-

Definition at line 25 of file ReactESP.h.

+

Definition at line 27 of file ReactESP.h.

Constructor & Destructor Documentation

- -

◆ Reaction()

+ +

◆ Reaction()

@@ -141,9 +141,9 @@

- + - + @@ -155,7 +155,7 @@

-

Construct a new Reaction object.

+

Construct a new Reaction object.

Parameters

Reaction::Reaction reactesp::Reaction::Reaction (react_callback react_callback  callback)
@@ -163,13 +163,13 @@

Definition at line 35 of file ReactESP.h.

+

Definition at line 37 of file ReactESP.h.

Member Function Documentation

- -

◆ add()

+ +

◆ add()

@@ -178,7 +178,7 @@

callbackFunction to be called when the reaction is triggered
- + @@ -191,12 +191,12 @@

-

Implemented in TimedReaction, UntimedReaction, and ISRReaction.

+

Implemented in reactesp::TimedReaction, reactesp::UntimedReaction, and reactesp::ISRReaction.

- -

◆ remove()

+ +

◆ remove()

@@ -205,7 +205,7 @@

virtual void Reaction::add virtual void reactesp::Reaction::add ( )
- + @@ -218,12 +218,12 @@

-

Implemented in TimedReaction, UntimedReaction, and ISRReaction.

+

Implemented in reactesp::TimedReaction, reactesp::UntimedReaction, and reactesp::ISRReaction.

- -

◆ tick()

+ +

◆ tick()

@@ -232,7 +232,7 @@

virtual void Reaction::remove virtual void reactesp::Reaction::remove ( )
- + @@ -245,13 +245,13 @@

-

Implemented in DelayReaction, RepeatReaction, StreamReaction, TickReaction, ISRReaction, TimedReaction, and UntimedReaction.

+

Implemented in reactesp::DelayReaction, reactesp::RepeatReaction, reactesp::StreamReaction, reactesp::TickReaction, reactesp::ISRReaction, reactesp::TimedReaction, and reactesp::UntimedReaction.

Member Data Documentation

- -

◆ callback

+ +

◆ callback

@@ -260,7 +260,7 @@

virtual void Reaction::tick virtual void reactesp::Reaction::tick ( )
- +
const react_callback Reaction::callbackconst react_callback reactesp::Reaction::callback
@@ -270,7 +270,7 @@

-

Definition at line 27 of file ReactESP.h.

+

Definition at line 29 of file ReactESP.h.

@@ -282,7 +282,7 @@

diff --git a/docs/generated/docs/classreactesp_1_1_reaction.js b/docs/generated/docs/classreactesp_1_1_reaction.js new file mode 100644 index 0000000..631c848 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_reaction.js @@ -0,0 +1,8 @@ +var classreactesp_1_1_reaction = +[ + [ "Reaction", "classreactesp_1_1_reaction.html#abc05ff856d46ceead9bb7e78368f386c", null ], + [ "add", "classreactesp_1_1_reaction.html#a4c90027a89d94464caa5bbd879e0a0b6", null ], + [ "remove", "classreactesp_1_1_reaction.html#aae992e5175207c253af0529d0888272e", null ], + [ "tick", "classreactesp_1_1_reaction.html#ad3d3f332d9552c27f6a00c907d8ca1bd", null ], + [ "callback", "classreactesp_1_1_reaction.html#a5247229438081b450d9e5985d1371238", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.map new file mode 100644 index 0000000..44fde5d --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.map @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.md5 new file mode 100644 index 0000000..2039a23 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +8521312faf91d86416ad1231794494ae \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.svg new file mode 100644 index 0000000..28e5b62 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_reaction__inherit__graph.svg @@ -0,0 +1,126 @@ + + + + + + +reactesp::Reaction + + +Node1 + + +reactesp::Reaction + + + + + +Node2 + + +reactesp::ISRReaction + + + + + +Node1->Node2 + + + + + +Node3 + + +reactesp::TimedReaction + + + + + +Node1->Node3 + + + + + +Node6 + + +reactesp::UntimedReaction + + + + + +Node1->Node6 + + + + + +Node4 + + +reactesp::DelayReaction + + + + + +Node3->Node4 + + + + + +Node5 + + +reactesp::RepeatReaction + + + + + +Node3->Node5 + + + + + +Node7 + + +reactesp::StreamReaction + + + + + +Node6->Node7 + + + + + +Node8 + + +reactesp::TickReaction + + + + + +Node6->Node8 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction-members.html b/docs/generated/docs/classreactesp_1_1_repeat_reaction-members.html new file mode 100644 index 0000000..3d4ce15 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction-members.html @@ -0,0 +1,125 @@ + + + + + + + +ReactESP: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
reactesp::RepeatReaction Member List
+
+
+ +

This is the complete list of members for reactesp::RepeatReaction, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
add()reactesp::TimedReactionvirtual
callbackreactesp::Reactionprotected
enabledreactesp::TimedReactionprotected
getTriggerTime()reactesp::TimedReactioninline
getTriggerTimeMicros()reactesp::TimedReactioninline
intervalreactesp::TimedReactionprotected
isEnabled()reactesp::TimedReactioninline
last_trigger_timereactesp::TimedReactionprotected
operator<(const TimedReaction &other)reactesp::TimedReaction
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::TimedReactionvirtual
RepeatReaction(const uint32_t interval, const react_callback callback)reactesp::RepeatReactioninline
RepeatReaction(const uint64_t interval, const react_callback callback)reactesp::RepeatReactioninline
tick()reactesp::RepeatReactionvirtual
TimedReaction(const uint32_t interval, const react_callback callback)reactesp::TimedReactioninline
TimedReaction(const uint64_t interval, const react_callback callback)reactesp::TimedReactioninline
~TimedReaction()reactesp::TimedReactioninlinevirtual
+
+ + + + diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction.html b/docs/generated/docs/classreactesp_1_1_repeat_reaction.html new file mode 100644 index 0000000..db3dd8e --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction.html @@ -0,0 +1,310 @@ + + + + + + + +ReactESP: reactesp::RepeatReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
reactesp::RepeatReaction Class Reference
+
+
+ +

Reaction that is triggered repeatedly. + More...

+ +

#include <ReactESP.h>

+
+Inheritance diagram for reactesp::RepeatReaction:
+
+
+
+
[legend]
+
+Collaboration diagram for reactesp::RepeatReaction:
+
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+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 ()
 
- Public Member Functions inherited from reactesp::TimedReaction
 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 ()
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Attributes inherited from reactesp::TimedReaction
const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 
+

Detailed Description

+

Reaction that is triggered repeatedly.

+ +

Definition at line 117 of file ReactESP.h.

+

Constructor & Destructor Documentation

+ +

◆ RepeatReaction() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
reactesp::RepeatReaction::RepeatReaction (const uint32_t interval,
const react_callback callback 
)
+
+inline
+
+ +

Construct a new Repeat Reaction object.

+
Parameters
+ + + +
intervalRepetition interval, in milliseconds
callbackFunction to be called at every repetition
+
+
+ +

Definition at line 125 of file ReactESP.h.

+ +
+
+ +

◆ RepeatReaction() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
reactesp::RepeatReaction::RepeatReaction (const uint64_t interval,
const react_callback callback 
)
+
+inline
+
+ +

Construct a new Repeat Reaction object.

+
Parameters
+ + + +
intervalRepetition interval, in microseconds
callbackFunction to be called at every repetition
+
+
+ +

Definition at line 133 of file ReactESP.h.

+ +
+
+

Member Function Documentation

+ +

◆ tick()

+ +
+
+ + + + + +
+ + + + + + + +
void reactesp::RepeatReaction::tick ()
+
+virtual
+
+ +

Implements reactesp::TimedReaction.

+ +

Definition at line 52 of file ReactESP.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction.js b/docs/generated/docs/classreactesp_1_1_repeat_reaction.js new file mode 100644 index 0000000..b5fe0ad --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction.js @@ -0,0 +1,6 @@ +var classreactesp_1_1_repeat_reaction = +[ + [ "RepeatReaction", "classreactesp_1_1_repeat_reaction.html#a55c79cf9f38829af00b2ea553596bbc4", null ], + [ "RepeatReaction", "classreactesp_1_1_repeat_reaction.html#aebda92dd28d44efb915c62434913f2a7", null ], + [ "tick", "classreactesp_1_1_repeat_reaction.html#adcbabf4f8166101c34468565a72dbc6a", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.map new file mode 100644 index 0000000..38e6a45 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.md5 new file mode 100644 index 0000000..a04b9b9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.md5 @@ -0,0 +1 @@ +2a67525aebc5b467bb9a0a43d5f088fa \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.svg new file mode 100644 index 0000000..18ec0d6 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction__coll__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::RepeatReaction + + +Node1 + + +reactesp::RepeatReaction + + + + + +Node2 + + +reactesp::TimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.map new file mode 100644 index 0000000..38e6a45 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.md5 new file mode 100644 index 0000000..a04b9b9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +2a67525aebc5b467bb9a0a43d5f088fa \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.svg new file mode 100644 index 0000000..18ec0d6 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_repeat_reaction__inherit__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::RepeatReaction + + +Node1 + + +reactesp::RepeatReaction + + + + + +Node2 + + +reactesp::TimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/class_tick_reaction-members.html b/docs/generated/docs/classreactesp_1_1_stream_reaction-members.html similarity index 57% rename from docs/generated/docs/class_tick_reaction-members.html rename to docs/generated/docs/classreactesp_1_1_stream_reaction-members.html index c574c63..e062483 100644 --- a/docs/generated/docs/class_tick_reaction-members.html +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -90,20 +90,20 @@
-
TickReaction Member List
+
reactesp::StreamReaction Member List
-

This is the complete list of members for TickReaction, including all inherited members.

+

This is the complete list of members for reactesp::StreamReaction, including all inherited members.

- - - - - - - - + + + + + + + +
add()UntimedReactionvirtual
callbackReactionprotected
Reaction(react_callback callback)Reactioninline
remove()UntimedReactionvirtual
tick()TickReactionvirtual
TickReaction(const react_callback callback)TickReactioninline
UntimedReaction(const react_callback callback)UntimedReactioninline
~UntimedReaction()UntimedReactioninlinevirtual
add()reactesp::UntimedReactionvirtual
callbackreactesp::Reactionprotected
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::UntimedReactionvirtual
StreamReaction(Stream &stream, const react_callback callback)reactesp::StreamReactioninline
tick()reactesp::StreamReactionvirtual
UntimedReaction(const react_callback callback)reactesp::UntimedReactioninline
~UntimedReaction()reactesp::UntimedReactioninlinevirtual
diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction.html b/docs/generated/docs/classreactesp_1_1_stream_reaction.html new file mode 100644 index 0000000..6a58463 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction.html @@ -0,0 +1,240 @@ + + + + + + + +ReactESP: reactesp::StreamReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
reactesp::StreamReaction Class Reference
+
+
+ +

Reaction that is triggered when there is input available at the given Arduino Stream. + More...

+ +

#include <ReactESP.h>

+
+Inheritance diagram for reactesp::StreamReaction:
+
+
+
+
[legend]
+
+Collaboration diagram for reactesp::StreamReaction:
+
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 StreamReaction (Stream &stream, const react_callback callback)
 Construct a new Stream Reaction object. More...
 
void tick ()
 
- Public Member Functions inherited from reactesp::UntimedReaction
 UntimedReaction (const react_callback callback)
 
virtual ~UntimedReaction ()
 
virtual void add ()
 
virtual void remove ()
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 
+

Detailed Description

+

Reaction that is triggered when there is input available at the given Arduino Stream.

+ +

Definition at line 154 of file ReactESP.h.

+

Constructor & Destructor Documentation

+ +

◆ StreamReaction()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
reactesp::StreamReaction::StreamReaction (Stream & stream,
const react_callback callback 
)
+
+inline
+
+ +

Construct a new Stream Reaction object.

+
Parameters
+ + + +
streamStream to monitor
callbackCallback to call for new input
+
+
+ +

Definition at line 165 of file ReactESP.h.

+ +
+
+

Member Function Documentation

+ +

◆ tick()

+ +
+
+ + + + + +
+ + + + + + + +
void reactesp::StreamReaction::tick ()
+
+virtual
+
+ +

Implements reactesp::UntimedReaction.

+ +

Definition at line 70 of file ReactESP.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction.js b/docs/generated/docs/classreactesp_1_1_stream_reaction.js new file mode 100644 index 0000000..3b4dcfa --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction.js @@ -0,0 +1,5 @@ +var classreactesp_1_1_stream_reaction = +[ + [ "StreamReaction", "classreactesp_1_1_stream_reaction.html#a415ab42487fd4811fcbefc1dda8f125b", null ], + [ "tick", "classreactesp_1_1_stream_reaction.html#aaacfadf2931a51f84fad46f8836f5407", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.map new file mode 100644 index 0000000..0608e14 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.md5 new file mode 100644 index 0000000..dc22e27 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.md5 @@ -0,0 +1 @@ +b7eaaf145ac9a8a846b22b3a9dcc8303 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.svg new file mode 100644 index 0000000..69ffa8b --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction__coll__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::StreamReaction + + +Node1 + + +reactesp::StreamReaction + + + + + +Node2 + + +reactesp::UntimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.map new file mode 100644 index 0000000..0608e14 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.md5 new file mode 100644 index 0000000..dc22e27 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +b7eaaf145ac9a8a846b22b3a9dcc8303 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.svg new file mode 100644 index 0000000..69ffa8b --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_stream_reaction__inherit__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::StreamReaction + + +Node1 + + +reactesp::StreamReaction + + + + + +Node2 + + +reactesp::UntimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/class_stream_reaction-members.html b/docs/generated/docs/classreactesp_1_1_tick_reaction-members.html similarity index 57% rename from docs/generated/docs/class_stream_reaction-members.html rename to docs/generated/docs/classreactesp_1_1_tick_reaction-members.html index 58b995d..cbf2348 100644 --- a/docs/generated/docs/class_stream_reaction-members.html +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -90,20 +90,20 @@
-
StreamReaction Member List
+
reactesp::TickReaction Member List
-

This is the complete list of members for StreamReaction, including all inherited members.

+

This is the complete list of members for reactesp::TickReaction, including all inherited members.

- - - - - - - - + + + + + + + +
add()UntimedReactionvirtual
callbackReactionprotected
Reaction(react_callback callback)Reactioninline
remove()UntimedReactionvirtual
StreamReaction(Stream &stream, const react_callback callback)StreamReactioninline
tick()StreamReactionvirtual
UntimedReaction(const react_callback callback)UntimedReactioninline
~UntimedReaction()UntimedReactioninlinevirtual
add()reactesp::UntimedReactionvirtual
callbackreactesp::Reactionprotected
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::UntimedReactionvirtual
tick()reactesp::TickReactionvirtual
TickReaction(const react_callback callback)reactesp::TickReactioninline
UntimedReaction(const react_callback callback)reactesp::UntimedReactioninline
~UntimedReaction()reactesp::UntimedReactioninlinevirtual
diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction.html b/docs/generated/docs/classreactesp_1_1_tick_reaction.html new file mode 100644 index 0000000..18df3ae --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction.html @@ -0,0 +1,229 @@ + + + + + + + +ReactESP: reactesp::TickReaction Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
reactesp::TickReaction Class Reference
+
+
+ +

Reaction that is triggered unconditionally at each execution loop. + More...

+ +

#include <ReactESP.h>

+
+Inheritance diagram for reactesp::TickReaction:
+
+
+
+
[legend]
+
+Collaboration diagram for reactesp::TickReaction:
+
+
+
+
[legend]
+ + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 TickReaction (const react_callback callback)
 Construct a new Tick Reaction object. More...
 
void tick ()
 
- Public Member Functions inherited from reactesp::UntimedReaction
 UntimedReaction (const react_callback callback)
 
virtual ~UntimedReaction ()
 
virtual void add ()
 
virtual void remove ()
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 
+

Detailed Description

+

Reaction that is triggered unconditionally at each execution loop.

+ +

Definition at line 173 of file ReactESP.h.

+

Constructor & Destructor Documentation

+ +

◆ TickReaction()

+ +
+
+ + + + + +
+ + + + + + + + +
reactesp::TickReaction::TickReaction (const react_callback callback)
+
+inline
+
+ +

Construct a new Tick Reaction object.

+
Parameters
+ + +
callbackFunction to be called at each execution loop
+
+
+ +

Definition at line 180 of file ReactESP.h.

+ +
+
+

Member Function Documentation

+ +

◆ tick()

+ +
+
+ + + + + +
+ + + + + + + +
void reactesp::TickReaction::tick ()
+
+virtual
+
+ +

Implements reactesp::UntimedReaction.

+ +

Definition at line 76 of file ReactESP.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction.js b/docs/generated/docs/classreactesp_1_1_tick_reaction.js new file mode 100644 index 0000000..8404e03 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction.js @@ -0,0 +1,5 @@ +var classreactesp_1_1_tick_reaction = +[ + [ "TickReaction", "classreactesp_1_1_tick_reaction.html#adf4e60e642e2c268150ddc8232e5dad8", null ], + [ "tick", "classreactesp_1_1_tick_reaction.html#a507fba43ad3fa7e7466654ad380ac65c", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.map new file mode 100644 index 0000000..f22fda0 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.md5 new file mode 100644 index 0000000..d64258f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.md5 @@ -0,0 +1 @@ +301ec757ea3934345daefbd9f55bc412 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.svg new file mode 100644 index 0000000..5188a62 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction__coll__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::TickReaction + + +Node1 + + +reactesp::TickReaction + + + + + +Node2 + + +reactesp::UntimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.map new file mode 100644 index 0000000..f22fda0 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.md5 new file mode 100644 index 0000000..d64258f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +301ec757ea3934345daefbd9f55bc412 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.svg new file mode 100644 index 0000000..5188a62 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_tick_reaction__inherit__graph.svg @@ -0,0 +1,51 @@ + + + + + + +reactesp::TickReaction + + +Node1 + + +reactesp::TickReaction + + + + + +Node2 + + +reactesp::UntimedReaction + + + + + +Node2->Node1 + + + + + +Node3 + + +reactesp::Reaction + + + + + +Node3->Node2 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction-members.html b/docs/generated/docs/classreactesp_1_1_timed_reaction-members.html new file mode 100644 index 0000000..54407f3 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction-members.html @@ -0,0 +1,123 @@ + + + + + + + +ReactESP: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
reactesp::TimedReaction Member List
+
+
+ +

This is the complete list of members for reactesp::TimedReaction, including all inherited members.

+ + + + + + + + + + + + + + + + +
add()reactesp::TimedReactionvirtual
callbackreactesp::Reactionprotected
enabledreactesp::TimedReactionprotected
getTriggerTime()reactesp::TimedReactioninline
getTriggerTimeMicros()reactesp::TimedReactioninline
intervalreactesp::TimedReactionprotected
isEnabled()reactesp::TimedReactioninline
last_trigger_timereactesp::TimedReactionprotected
operator<(const TimedReaction &other)reactesp::TimedReaction
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::TimedReactionvirtual
tick()=0reactesp::TimedReactionpure virtual
TimedReaction(const uint32_t interval, const react_callback callback)reactesp::TimedReactioninline
TimedReaction(const uint64_t interval, const react_callback callback)reactesp::TimedReactioninline
~TimedReaction()reactesp::TimedReactioninlinevirtual
+
+ + + + diff --git a/docs/generated/docs/class_timed_reaction.html b/docs/generated/docs/classreactesp_1_1_timed_reaction.html similarity index 51% rename from docs/generated/docs/class_timed_reaction.html rename to docs/generated/docs/classreactesp_1_1_timed_reaction.html index 37f48e5..2887853 100644 --- a/docs/generated/docs/class_timed_reaction.html +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction.html @@ -5,7 +5,7 @@ -ReactESP: TimedReaction Class Reference +ReactESP: reactesp::TimedReaction Class Reference @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -93,77 +93,77 @@ -
TimedReaction Class Referenceabstract
+List of all members
+
reactesp::TimedReaction Class Referenceabstract

TimedReactions are called based on elapsing of time. - More...

+ More...

#include <ReactESP.h>

-Inheritance diagram for TimedReaction:
+Inheritance diagram for reactesp::TimedReaction:
-
+
[legend]
-Collaboration diagram for TimedReaction:
+Collaboration diagram for reactesp::TimedReaction:
-
+
[legend]
- - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + +

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
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
 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
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - - - - - - - + + + + + + + + +

Protected Attributes

const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from Reaction
const react_callback callback
 
const uint64_t interval
 
uint64_t last_trigger_time
 
bool enabled
 
- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 

Detailed Description

TimedReactions are called based on elapsing of time.

-

Definition at line 45 of file ReactESP.h.

+

Definition at line 47 of file ReactESP.h.

Constructor & Destructor Documentation

- -

◆ TimedReaction() [1/2]

+ +

◆ TimedReaction() [1/2]

@@ -172,7 +172,7 @@

- + @@ -180,7 +180,7 @@

- + @@ -196,7 +196,7 @@

-

Construct a new Timed Reaction object.

+

Construct a new Timed Reaction object.

Parameters

TimedReaction::TimedReaction reactesp::TimedReaction::TimedReaction ( const uint32_t  interval, const react_callback const react_callback  callback 
@@ -205,12 +205,12 @@

Definition at line 58 of file ReactESP.h.

+

Definition at line 60 of file ReactESP.h.

- -

◆ TimedReaction() [2/2]

+ +

◆ TimedReaction() [2/2]

@@ -219,7 +219,7 @@

intervalInterval or delay for the reaction, in milliseconds
- + @@ -227,7 +227,7 @@

- + @@ -243,7 +243,7 @@

-

Construct a new Timed Reaction object.

+

Construct a new Timed Reaction object.

Parameters

TimedReaction::TimedReaction reactesp::TimedReaction::TimedReaction ( const uint64_t  interval, const react_callback const react_callback  callback 
@@ -252,12 +252,12 @@

Definition at line 69 of file ReactESP.h.

+

Definition at line 71 of file ReactESP.h.

- -

◆ ~TimedReaction()

+ +

◆ ~TimedReaction()

@@ -266,7 +266,7 @@

intervalInterval, in microseconds
- + @@ -279,13 +279,13 @@

-

Definition at line 75 of file ReactESP.h.

+

Definition at line 77 of file ReactESP.h.

Member Function Documentation

- -

◆ add()

+ +

◆ add()

@@ -294,7 +294,7 @@

virtual TimedReaction::~TimedReaction virtual reactesp::TimedReaction::~TimedReaction ( )
- + @@ -307,20 +307,20 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 26 of file ReactESP.cpp.

+

Definition at line 28 of file ReactESP.cpp.

Here is the caller graph for this function:
-
+
- -

◆ getTriggerTime()

+ +

◆ getTriggerTime()

@@ -329,7 +329,7 @@

void TimedReaction::add void reactesp::TimedReaction::add ( )
- + @@ -342,12 +342,12 @@

-

Definition at line 79 of file ReactESP.h.

+

Definition at line 81 of file ReactESP.h.

- -

◆ getTriggerTimeMicros()

+ +

◆ getTriggerTimeMicros()

@@ -356,7 +356,7 @@

uint32_t TimedReaction::getTriggerTime uint32_t reactesp::TimedReaction::getTriggerTime ( )
- + @@ -369,12 +369,12 @@

-

Definition at line 80 of file ReactESP.h.

+

Definition at line 82 of file ReactESP.h.

- -

◆ isEnabled()

+ +

◆ isEnabled()

@@ -383,7 +383,7 @@

uint64_t TimedReaction::getTriggerTimeMicros uint64_t reactesp::TimedReaction::getTriggerTimeMicros ( )
- + @@ -396,20 +396,20 @@

-

Definition at line 81 of file ReactESP.h.

+

Definition at line 83 of file ReactESP.h.

- -

◆ operator<()

+ +

◆ operator<()

bool TimedReaction::isEnabled bool reactesp::TimedReaction::isEnabled ( )
- + - + @@ -419,12 +419,12 @@

Definition at line 21 of file ReactESP.cpp.

+

Definition at line 23 of file ReactESP.cpp.

- -

◆ remove()

+ +

◆ remove()

@@ -433,7 +433,7 @@

bool TimedReaction::operator< bool reactesp::TimedReaction::operator< (const TimedReactionconst TimedReaction other)
- + @@ -446,14 +446,14 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 28 of file ReactESP.cpp.

+

Definition at line 30 of file ReactESP.cpp.

- -

◆ tick()

+ +

◆ tick()

@@ -462,7 +462,7 @@

void TimedReaction::remove void reactesp::TimedReaction::remove ( )
- + @@ -475,15 +475,15 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Implemented in DelayReaction, and RepeatReaction.

+

Implemented in reactesp::DelayReaction, and reactesp::RepeatReaction.

Member Data Documentation

- -

◆ enabled

+ +

◆ enabled

@@ -492,7 +492,7 @@

virtual void TimedReaction::tick virtual void reactesp::TimedReaction::tick ( )
- +
bool TimedReaction::enabledbool reactesp::TimedReaction::enabled
@@ -502,12 +502,12 @@

-

Definition at line 49 of file ReactESP.h.

+

Definition at line 51 of file ReactESP.h.

- -

◆ interval

+ +

◆ interval

- -

◆ last_trigger_time

+ +

◆ last_trigger_time

@@ -563,7 +563,7 @@

diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction.js b/docs/generated/docs/classreactesp_1_1_timed_reaction.js new file mode 100644 index 0000000..f03101c --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction.js @@ -0,0 +1,16 @@ +var classreactesp_1_1_timed_reaction = +[ + [ "TimedReaction", "classreactesp_1_1_timed_reaction.html#a61a39ae3b7cf58657b69ad27bef4d6d5", null ], + [ "TimedReaction", "classreactesp_1_1_timed_reaction.html#ab53411bb9c37d8624b2d79d6cd6a73a9", null ], + [ "~TimedReaction", "classreactesp_1_1_timed_reaction.html#a0f008c210ca872c62d01d2f8b71e1d7d", null ], + [ "add", "classreactesp_1_1_timed_reaction.html#ae8318817b65df5dee74911f863973063", null ], + [ "getTriggerTime", "classreactesp_1_1_timed_reaction.html#aaa7dc721c043b0df6b1dee56bfc6ab3b", null ], + [ "getTriggerTimeMicros", "classreactesp_1_1_timed_reaction.html#ad139926f58b087f6e1f5fd86609190d3", null ], + [ "isEnabled", "classreactesp_1_1_timed_reaction.html#ac8aa0c4d72900551791b4d276b5939a2", null ], + [ "operator<", "classreactesp_1_1_timed_reaction.html#a6243201b9a9ea88c7ddfc9b10441ffd8", null ], + [ "remove", "classreactesp_1_1_timed_reaction.html#a361492121a2ce2f76595886e6b93323f", null ], + [ "tick", "classreactesp_1_1_timed_reaction.html#aa32de4aadffb55da49678d662f9089de", null ], + [ "enabled", "classreactesp_1_1_timed_reaction.html#a2494033d04540bf672ce91b080b0b8c6", null ], + [ "interval", "classreactesp_1_1_timed_reaction.html#ae6b490c9d7b56a41c24c011e13834772", null ], + [ "last_trigger_time", "classreactesp_1_1_timed_reaction.html#aefccfe18abe4d6d83b2eae434be71e71", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.map new file mode 100644 index 0000000..914147e --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.md5 new file mode 100644 index 0000000..637da2f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.md5 @@ -0,0 +1 @@ +38837d7dd6651b0889dde913efd62485 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.svg new file mode 100644 index 0000000..42463d2 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction__coll__graph.svg @@ -0,0 +1,36 @@ + + + + + + +reactesp::TimedReaction + + +Node1 + + +reactesp::TimedReaction + + + + + +Node2 + + +reactesp::Reaction + + + + + +Node2->Node1 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.map new file mode 100644 index 0000000..0575908 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.md5 new file mode 100644 index 0000000..323b988 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +1b9225a2f090616b895fa0625126ab16 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.svg new file mode 100644 index 0000000..aafb7ab --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + +reactesp::TimedReaction + + +Node1 + + +reactesp::TimedReaction + + + + + +Node3 + + +reactesp::DelayReaction + + + + + +Node1->Node3 + + + + + +Node4 + + +reactesp::RepeatReaction + + + + + +Node1->Node4 + + + + + +Node2 + + +reactesp::Reaction + + + + + +Node2->Node1 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.map b/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.map new file mode 100644 index 0000000..46d8068 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.md5 new file mode 100644 index 0000000..158fe15 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.md5 @@ -0,0 +1 @@ +d5f9cb463be338fdc1655eae2643db21 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.svg b/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.svg new file mode 100644 index 0000000..4c120cc --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_timed_reaction_ae8318817b65df5dee74911f863973063_icgraph.svg @@ -0,0 +1,157 @@ + + + + + + +reactesp::TimedReaction::add + + +Node1 + + +reactesp::TimedReaction::add + + + + + +Node2 + + +reactesp::ReactESP +::onDelay + + + + + +Node1->Node2 + + + + + +Node5 + + +reactesp::ReactESP +::onDelayMicros + + + + + +Node1->Node5 + + + + + +Node6 + + +reactesp::ReactESP +::onRepeat + + + + + +Node1->Node6 + + + + + +Node9 + + +reactesp::ReactESP +::onRepeatMicros + + + + + +Node1->Node9 + + + + + +Node3 + + +setup_serial + + + + + +Node2->Node3 + + + + + +Node4 + + +setup + + + + + +Node3->Node4 + + + + + +Node7 + + +setup_io_pins + + + + + +Node6->Node7 + + + + + +Node8 + + +setup_timers + + + + + +Node6->Node8 + + + + + +Node7->Node4 + + + + + +Node8->Node4 + + + + + diff --git a/docs/generated/docs/class_i_s_r_reaction-members.html b/docs/generated/docs/classreactesp_1_1_untimed_reaction-members.html similarity index 60% rename from docs/generated/docs/class_i_s_r_reaction-members.html rename to docs/generated/docs/classreactesp_1_1_untimed_reaction-members.html index 9ac3599..0ea0fdb 100644 --- a/docs/generated/docs/class_i_s_r_reaction-members.html +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -90,19 +90,19 @@
-
ISRReaction Member List
+
reactesp::UntimedReaction Member List
-

This is the complete list of members for ISRReaction, including all inherited members.

+

This is the complete list of members for reactesp::UntimedReaction, including all inherited members.

- - - - - - - + + + + + + +
add()ISRReactionvirtual
callbackReactionprotected
ISRReaction(uint8_t pin_number, int mode, const react_callback callback)ISRReactioninline
Reaction(react_callback callback)Reactioninline
remove()ISRReactionvirtual
tick()ISRReactioninlinevirtual
~ISRReaction()ISRReactioninlinevirtual
add()reactesp::UntimedReactionvirtual
callbackreactesp::Reactionprotected
Reaction(react_callback callback)reactesp::Reactioninline
remove()reactesp::UntimedReactionvirtual
tick()=0reactesp::UntimedReactionpure virtual
UntimedReaction(const react_callback callback)reactesp::UntimedReactioninline
~UntimedReaction()reactesp::UntimedReactioninlinevirtual
diff --git a/docs/generated/docs/class_untimed_reaction.html b/docs/generated/docs/classreactesp_1_1_untimed_reaction.html similarity index 54% rename from docs/generated/docs/class_untimed_reaction.html rename to docs/generated/docs/classreactesp_1_1_untimed_reaction.html index b7af963..0f0baaf 100644 --- a/docs/generated/docs/class_untimed_reaction.html +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction.html @@ -5,7 +5,7 @@ -ReactESP: UntimedReaction Class Reference +ReactESP: reactesp::UntimedReaction Class Reference @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -92,58 +92,58 @@
-
UntimedReaction Class Referenceabstract
+List of all members
+
reactesp::UntimedReaction Class Referenceabstract

Reactions that are triggered based on something else than time. - More...

+ More...

#include <ReactESP.h>

-Inheritance diagram for UntimedReaction:
+Inheritance diagram for reactesp::UntimedReaction:
-
+
[legend]
-Collaboration diagram for UntimedReaction:
+Collaboration diagram for reactesp::UntimedReaction:
-
+
[legend]
- - - - - - - - - - - - - - + + + + + + + + + + + + + +

Public Member Functions

 UntimedReaction (const react_callback callback)
 
virtual ~UntimedReaction ()
 
virtual void add ()
 
virtual void remove ()
 
virtual void tick ()=0
 
- Public Member Functions inherited from Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
 UntimedReaction (const react_callback callback)
 
virtual ~UntimedReaction ()
 
virtual void add ()
 
virtual void remove ()
 
virtual void tick ()=0
 
- Public Member Functions inherited from reactesp::Reaction
 Reaction (react_callback callback)
 Construct a new Reaction object. More...
 
- - - + + +

Additional Inherited Members

- Protected Attributes inherited from Reaction
const react_callback callback
 
- Protected Attributes inherited from reactesp::Reaction
const react_callback callback
 

Detailed Description

Reactions that are triggered based on something else than time.

-

Definition at line 139 of file ReactESP.h.

+

Definition at line 141 of file ReactESP.h.

Constructor & Destructor Documentation

- -

◆ UntimedReaction()

+ +

◆ UntimedReaction()

@@ -152,9 +152,9 @@

- + - + @@ -166,12 +166,12 @@

-

Definition at line 141 of file ReactESP.h.

+

Definition at line 143 of file ReactESP.h.

- -

◆ ~UntimedReaction()

+ +

◆ ~UntimedReaction()

@@ -180,7 +180,7 @@

UntimedReaction::UntimedReaction reactesp::UntimedReaction::UntimedReaction (const react_callback const react_callback  callback)
- + @@ -193,13 +193,13 @@

-

Definition at line 142 of file ReactESP.h.

+

Definition at line 144 of file ReactESP.h.

Member Function Documentation

- -

◆ add()

+ +

◆ add()

@@ -208,7 +208,7 @@

virtual UntimedReaction::~UntimedReaction virtual reactesp::UntimedReaction::~UntimedReaction ( )
- + @@ -221,20 +221,20 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 61 of file ReactESP.cpp.

+

Definition at line 63 of file ReactESP.cpp.

Here is the caller graph for this function:
-
+
- -

◆ remove()

+ +

◆ remove()

@@ -243,7 +243,7 @@

void UntimedReaction::add void reactesp::UntimedReaction::add ( )
- + @@ -256,14 +256,14 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Definition at line 63 of file ReactESP.cpp.

+

Definition at line 65 of file ReactESP.cpp.

- -

◆ tick()

+ +

◆ tick()

@@ -272,7 +272,7 @@

void UntimedReaction::remove void reactesp::UntimedReaction::remove ( )
- + @@ -285,9 +285,9 @@

-

Implements Reaction.

+

Implements reactesp::Reaction.

-

Implemented in StreamReaction, and TickReaction.

+

Implemented in reactesp::StreamReaction, and reactesp::TickReaction.

@@ -300,7 +300,7 @@

diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction.js b/docs/generated/docs/classreactesp_1_1_untimed_reaction.js new file mode 100644 index 0000000..eee94a4 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction.js @@ -0,0 +1,8 @@ +var classreactesp_1_1_untimed_reaction = +[ + [ "UntimedReaction", "classreactesp_1_1_untimed_reaction.html#ad09151db8e445f748f4b84e2fe9472c6", null ], + [ "~UntimedReaction", "classreactesp_1_1_untimed_reaction.html#a806d843f7e6767bdab056f0eec241832", null ], + [ "add", "classreactesp_1_1_untimed_reaction.html#a69503862f7b8e8033a2f401c9152a283", null ], + [ "remove", "classreactesp_1_1_untimed_reaction.html#a64eae7e0443bd1146a8ad61730c79647", null ], + [ "tick", "classreactesp_1_1_untimed_reaction.html#aa960a5b8adc44a1c8e0800b6e9a697f7", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.map b/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.map new file mode 100644 index 0000000..118f394 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.md5 b/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.md5 new file mode 100644 index 0000000..4c47ca9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.md5 @@ -0,0 +1 @@ +e6c995e0adbc6e24759480ddec19ac69 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.svg b/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.svg new file mode 100644 index 0000000..0859e26 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction__coll__graph.svg @@ -0,0 +1,36 @@ + + + + + + +reactesp::UntimedReaction + + +Node1 + + +reactesp::UntimedReaction + + + + + +Node2 + + +reactesp::Reaction + + + + + +Node2->Node1 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.map b/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.map new file mode 100644 index 0000000..3172b24 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.md5 b/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.md5 new file mode 100644 index 0000000..740e5fc --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.md5 @@ -0,0 +1 @@ +91d714f9ba41c9501d06864bda0a74b3 \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.svg b/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.svg new file mode 100644 index 0000000..3185d64 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction__inherit__graph.svg @@ -0,0 +1,66 @@ + + + + + + +reactesp::UntimedReaction + + +Node1 + + +reactesp::UntimedReaction + + + + + +Node3 + + +reactesp::StreamReaction + + + + + +Node1->Node3 + + + + + +Node4 + + +reactesp::TickReaction + + + + + +Node1->Node4 + + + + + +Node2 + + +reactesp::Reaction + + + + + +Node2->Node1 + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.map b/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.map new file mode 100644 index 0000000..51df66f --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.md5 b/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.md5 new file mode 100644 index 0000000..ef19df9 --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.md5 @@ -0,0 +1 @@ +bd28d681d45fdd616af54248e293f94d \ No newline at end of file diff --git a/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.svg b/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.svg new file mode 100644 index 0000000..31bb0dd --- /dev/null +++ b/docs/generated/docs/classreactesp_1_1_untimed_reaction_a69503862f7b8e8033a2f401c9152a283_icgraph.svg @@ -0,0 +1,104 @@ + + + + + + +reactesp::UntimedReaction::add + + +Node1 + + +reactesp::UntimedReaction::add + + + + + +Node2 + + +reactesp::ReactESP +::onAvailable + + + + + +Node1->Node2 + + + + + +Node5 + + +reactesp::ReactESP +::onTick + + + + + +Node1->Node5 + + + + + +Node3 + + +setup_serial + + + + + +Node2->Node3 + + + + + +Node4 + + +setup + + + + + +Node3->Node4 + + + + + +Node6 + + +setup_tick + + + + + +Node5->Node6 + + + + + +Node6->Node4 + + + + + diff --git a/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index dc9f327..a61e99b 100644 --- a/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -32,7 +32,7 @@

diff --git a/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js b/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js index bf3a1bc..11b979b 100644 --- a/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js +++ b/docs/generated/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.js @@ -1,6 +1,6 @@ var dir_68267d1309a1af8e8297ef4c3efbcdba = [ [ "main.cpp", "main_8cpp.html", "main_8cpp" ], - [ "ReactESP.cpp", "_react_e_s_p_8cpp.html", "_react_e_s_p_8cpp" ], + [ "ReactESP.cpp", "_react_e_s_p_8cpp.html", null ], [ "ReactESP.h", "_react_e_s_p_8h.html", "_react_e_s_p_8h" ] ]; \ No newline at end of file diff --git a/docs/generated/docs/files.html b/docs/generated/docs/files.html index a5134a9..06046f0 100644 --- a/docs/generated/docs/files.html +++ b/docs/generated/docs/files.html @@ -32,7 +32,7 @@ diff --git a/docs/generated/docs/functions.html b/docs/generated/docs/functions.html index 50a17a2..6317d8b 100644 --- a/docs/generated/docs/functions.html +++ b/docs/generated/docs/functions.html @@ -32,7 +32,7 @@ @@ -93,88 +93,87 @@
Here is a list of all class members with links to the classes they belong to:

- a -

- c -

- d -

- e -

- g -

- i -

- l -

- o -

- r -

- s -

- t -

- u -

- ~ -

diff --git a/docs/generated/docs/functions_func.html b/docs/generated/docs/functions_func.html index 1a6b090..ed1e9ad 100644 --- a/docs/generated/docs/functions_func.html +++ b/docs/generated/docs/functions_func.html @@ -32,7 +32,7 @@ @@ -93,71 +93,70 @@  

- a -

- d -

- g -

- i -

- o -

- r -

- s -

- t -

- u -

- ~ -

diff --git a/docs/generated/docs/functions_rela.html b/docs/generated/docs/functions_rela.html index 129b982..5602b46 100644 --- a/docs/generated/docs/functions_rela.html +++ b/docs/generated/docs/functions_rela.html @@ -32,7 +32,7 @@ @@ -91,11 +91,11 @@
 
diff --git a/docs/generated/docs/functions_vars.html b/docs/generated/docs/functions_vars.html index 3a63a29..ab69da8 100644 --- a/docs/generated/docs/functions_vars.html +++ b/docs/generated/docs/functions_vars.html @@ -32,7 +32,7 @@ @@ -91,11 +91,11 @@
 
diff --git a/docs/generated/docs/globals.html b/docs/generated/docs/globals.html index 6e7d7c1..14a8e59 100644 --- a/docs/generated/docs/globals.html +++ b/docs/generated/docs/globals.html @@ -32,7 +32,7 @@ @@ -91,14 +91,21 @@
Here is a list of all file members with links to the files they belong to:
diff --git a/docs/generated/docs/globals_defs.html b/docs/generated/docs/globals_defs.html index 6be6d3e..f500c6b 100644 --- a/docs/generated/docs/globals_defs.html +++ b/docs/generated/docs/globals_defs.html @@ -32,7 +32,7 @@ @@ -91,7 +91,11 @@
 
diff --git a/docs/generated/docs/globals_func.html b/docs/generated/docs/globals_func.html index cdad1b3..fc35b15 100644 --- a/docs/generated/docs/globals_func.html +++ b/docs/generated/docs/globals_func.html @@ -32,7 +32,7 @@ @@ -91,9 +91,13 @@
 
diff --git a/docs/generated/docs/globals_vars.html b/docs/generated/docs/globals_vars.html index 83fe068..22bfdc5 100644 --- a/docs/generated/docs/globals_vars.html +++ b/docs/generated/docs/globals_vars.html @@ -32,7 +32,7 @@ @@ -91,8 +91,9 @@
 
diff --git a/docs/generated/docs/graph_legend.dot b/docs/generated/docs/graph_legend.dot deleted file mode 100644 index 14095ed..0000000 --- a/docs/generated/docs/graph_legend.dot +++ /dev/null @@ -1,25 +0,0 @@ -digraph "Graph Legend" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node9 [shape="box",label="Inherited",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",fillcolor="grey75",style="filled" fontcolor="black"]; - Node10 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node10 [shape="box",label="PublicBase",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="black"]; - Node11 -> Node10 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node11 [shape="box",label="Truncated",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="red"]; - Node13 -> Node9 [dir="back",color="darkgreen",fontsize="10",style="solid",fontname="Helvetica"]; - Node13 [shape="box",label="ProtectedBase",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="black"]; - Node14 -> Node9 [dir="back",color="firebrick4",fontsize="10",style="solid",fontname="Helvetica"]; - Node14 [shape="box",label="PrivateBase",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="black"]; - Node15 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node15 [shape="box",label="Undocumented",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="grey75"]; - Node16 -> Node9 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node16 [shape="box",label="Templ< int >",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="black"]; - Node17 -> Node16 [dir="back",color="orange",fontsize="10",style="dashed",label="< int >",fontname="Helvetica"]; - Node17 [shape="box",label="Templ< T >",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="black"]; - Node18 -> Node9 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label="m_usedClass",fontname="Helvetica"]; - Node18 [shape="box",label="Used",fontsize="10",height=0.2,width=0.4,fontname="Helvetica",color="black"]; -} diff --git a/docs/generated/docs/graph_legend.html b/docs/generated/docs/graph_legend.html index c8c0ce5..b9fd53f 100644 --- a/docs/generated/docs/graph_legend.html +++ b/docs/generated/docs/graph_legend.html @@ -32,7 +32,7 @@ @@ -129,7 +129,7 @@
Used *m_usedClass;
};

This will result in the following graph:

-
[!-- SVG 0 --]

The boxes in the above graph have the following meaning:

+

The boxes in the above graph have the following meaning:

  • A filled gray box represents the struct or class for which the graph is generated.
  • diff --git a/docs/generated/docs/graph_legend.md5 b/docs/generated/docs/graph_legend.md5 new file mode 100644 index 0000000..5eb5d7e --- /dev/null +++ b/docs/generated/docs/graph_legend.md5 @@ -0,0 +1 @@ +4bd89fcedc1a2fed970f477be8ea7616 \ No newline at end of file diff --git a/docs/generated/docs/graph_legend.svg b/docs/generated/docs/graph_legend.svg new file mode 100644 index 0000000..67e56e9 --- /dev/null +++ b/docs/generated/docs/graph_legend.svg @@ -0,0 +1,116 @@ + + + + + + +Graph Legend + + +Node9 + +Inherited + + + +Node10 + +PublicBase + + + +Node10->Node9 + + + + + +Node11 + +Truncated + + + +Node11->Node10 + + + + + +Node13 + +ProtectedBase + + + +Node13->Node9 + + + + + +Node14 + +PrivateBase + + + +Node14->Node9 + + + + + +Node15 + +Undocumented + + + +Node15->Node9 + + + + + +Node16 + +Templ< int > + + + +Node16->Node9 + + + + + +Node17 + +Templ< T > + + + +Node17->Node16 + + +< int > + + + +Node18 + +Used + + + +Node18->Node9 + + +m_usedClass + + + diff --git a/docs/generated/docs/hierarchy.html b/docs/generated/docs/hierarchy.html index cedfafd..5416094 100644 --- a/docs/generated/docs/hierarchy.html +++ b/docs/generated/docs/hierarchy.html @@ -32,7 +32,7 @@
@@ -97,16 +97,16 @@

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 123]
virtual void UntimedReaction::tick virtual void reactesp::UntimedReaction::tick ( )
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
-
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
- - - - - - - - - - + + + + + + + + + +
 CReactESPMain class of a ReactESP program
 CReactionReactions are code to be called when a given condition is fulfilled
 CISRReactionReaction that is triggered on an input pin change
 CTimedReactionTimedReactions are called based on elapsing of time
 CDelayReactionReaction that is triggered after a certain time delay
 CRepeatReactionReaction that is triggered repeatedly
 CUntimedReactionReactions that are triggered based on something else than time
 CStreamReactionReaction that is triggered when there is input available at the given Arduino Stream
 CTickReactionReaction that is triggered unconditionally at each execution loop
 CTriggerTimeCompare
 Creactesp::ReactESPMain class of a ReactESP program
 Creactesp::ReactionReactions are code to be called when a given condition is fulfilled
 Creactesp::ISRReactionReaction that is triggered on an input pin change
 Creactesp::TimedReactionTimedReactions are called based on elapsing of time
 Creactesp::DelayReactionReaction that is triggered after a certain time delay
 Creactesp::RepeatReactionReaction that is triggered repeatedly
 Creactesp::UntimedReactionReactions that are triggered based on something else than time
 Creactesp::StreamReactionReaction that is triggered when there is input available at the given Arduino Stream
 Creactesp::TickReactionReaction that is triggered unconditionally at each execution loop
 Creactesp::TriggerTimeCompare

diff --git a/docs/generated/docs/hierarchy.js b/docs/generated/docs/hierarchy.js index e0a6fd1..657275d 100644 --- a/docs/generated/docs/hierarchy.js +++ b/docs/generated/docs/hierarchy.js @@ -1,16 +1,16 @@ var hierarchy = [ - [ "ReactESP", "class_react_e_s_p.html", null ], - [ "Reaction", "class_reaction.html", [ - [ "ISRReaction", "class_i_s_r_reaction.html", null ], - [ "TimedReaction", "class_timed_reaction.html", [ - [ "DelayReaction", "class_delay_reaction.html", null ], - [ "RepeatReaction", "class_repeat_reaction.html", null ] + [ "reactesp::ReactESP", "classreactesp_1_1_react_e_s_p.html", null ], + [ "reactesp::Reaction", "classreactesp_1_1_reaction.html", [ + [ "reactesp::ISRReaction", "classreactesp_1_1_i_s_r_reaction.html", null ], + [ "reactesp::TimedReaction", "classreactesp_1_1_timed_reaction.html", [ + [ "reactesp::DelayReaction", "classreactesp_1_1_delay_reaction.html", null ], + [ "reactesp::RepeatReaction", "classreactesp_1_1_repeat_reaction.html", null ] ] ], - [ "UntimedReaction", "class_untimed_reaction.html", [ - [ "StreamReaction", "class_stream_reaction.html", null ], - [ "TickReaction", "class_tick_reaction.html", null ] + [ "reactesp::UntimedReaction", "classreactesp_1_1_untimed_reaction.html", [ + [ "reactesp::StreamReaction", "classreactesp_1_1_stream_reaction.html", null ], + [ "reactesp::TickReaction", "classreactesp_1_1_tick_reaction.html", null ] ] ] ] ], - [ "TriggerTimeCompare", "struct_trigger_time_compare.html", null ] + [ "reactesp::TriggerTimeCompare", "structreactesp_1_1_trigger_time_compare.html", null ] ]; \ No newline at end of file diff --git a/docs/generated/docs/index.html b/docs/generated/docs/index.html index 1d1b9ff..01b9733 100644 --- a/docs/generated/docs/index.html +++ b/docs/generated/docs/index.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
diff --git a/docs/generated/docs/inherit_graph_0.dot b/docs/generated/docs/inherit_graph_0.dot deleted file mode 100644 index 451b00a..0000000 --- a/docs/generated/docs/inherit_graph_0.dot +++ /dev/null @@ -1,10 +0,0 @@ -digraph "Graphical Class Hierarchy" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node0 [label="ReactESP",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html",tooltip="Main class of a ReactESP program."]; -} diff --git a/docs/generated/docs/inherit_graph_0.map b/docs/generated/docs/inherit_graph_0.map new file mode 100644 index 0000000..10a85ae --- /dev/null +++ b/docs/generated/docs/inherit_graph_0.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/generated/docs/inherit_graph_0.md5 b/docs/generated/docs/inherit_graph_0.md5 new file mode 100644 index 0000000..e542247 --- /dev/null +++ b/docs/generated/docs/inherit_graph_0.md5 @@ -0,0 +1 @@ +41694f9fd26da98287ee3f6280498d10 \ No newline at end of file diff --git a/docs/generated/docs/inherit_graph_0.svg b/docs/generated/docs/inherit_graph_0.svg new file mode 100644 index 0000000..a65cc0f --- /dev/null +++ b/docs/generated/docs/inherit_graph_0.svg @@ -0,0 +1,21 @@ + + + + + + +Graphical Class Hierarchy + + +Node0 + + +reactesp::ReactESP + + + + + diff --git a/docs/generated/docs/inherit_graph_1.dot b/docs/generated/docs/inherit_graph_1.dot deleted file mode 100644 index 21e9d55..0000000 --- a/docs/generated/docs/inherit_graph_1.dot +++ /dev/null @@ -1,24 +0,0 @@ -digraph "Graphical Class Hierarchy" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node0 [label="Reaction",height=0.2,width=0.4,color="black",URL="$class_reaction.html",tooltip="Reactions are code to be called when a given condition is fulfilled."]; - Node0 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node1 [label="ISRReaction",height=0.2,width=0.4,color="black",URL="$class_i_s_r_reaction.html",tooltip="Reaction that is triggered on an input pin change."]; - Node0 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="TimedReaction",height=0.2,width=0.4,color="black",URL="$class_timed_reaction.html",tooltip="TimedReactions are called based on elapsing of time."]; - Node2 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="DelayReaction",height=0.2,width=0.4,color="black",URL="$class_delay_reaction.html",tooltip="Reaction that is triggered after a certain time delay."]; - Node2 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="RepeatReaction",height=0.2,width=0.4,color="black",URL="$class_repeat_reaction.html",tooltip="Reaction that is triggered repeatedly."]; - Node0 -> Node5 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node5 [label="UntimedReaction",height=0.2,width=0.4,color="black",URL="$class_untimed_reaction.html",tooltip="Reactions that are triggered based on something else than time."]; - Node5 -> Node6 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node6 [label="StreamReaction",height=0.2,width=0.4,color="black",URL="$class_stream_reaction.html",tooltip="Reaction that is triggered when there is input available at the given Arduino Stream."]; - Node5 -> Node7 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node7 [label="TickReaction",height=0.2,width=0.4,color="black",URL="$class_tick_reaction.html",tooltip="Reaction that is triggered unconditionally at each execution loop."]; -} diff --git a/docs/generated/docs/inherit_graph_1.map b/docs/generated/docs/inherit_graph_1.map new file mode 100644 index 0000000..1b4eb27 --- /dev/null +++ b/docs/generated/docs/inherit_graph_1.map @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docs/generated/docs/inherit_graph_1.md5 b/docs/generated/docs/inherit_graph_1.md5 new file mode 100644 index 0000000..b134f68 --- /dev/null +++ b/docs/generated/docs/inherit_graph_1.md5 @@ -0,0 +1 @@ +3efdff6c87da9da31d8ce522f7b4d56d \ No newline at end of file diff --git a/docs/generated/docs/inherit_graph_1.svg b/docs/generated/docs/inherit_graph_1.svg new file mode 100644 index 0000000..cb7a501 --- /dev/null +++ b/docs/generated/docs/inherit_graph_1.svg @@ -0,0 +1,126 @@ + + + + + + +Graphical Class Hierarchy + + +Node0 + + +reactesp::Reaction + + + + + +Node1 + + +reactesp::ISRReaction + + + + + +Node0->Node1 + + + + + +Node2 + + +reactesp::TimedReaction + + + + + +Node0->Node2 + + + + + +Node5 + + +reactesp::UntimedReaction + + + + + +Node0->Node5 + + + + + +Node3 + + +reactesp::DelayReaction + + + + + +Node2->Node3 + + + + + +Node4 + + +reactesp::RepeatReaction + + + + + +Node2->Node4 + + + + + +Node6 + + +reactesp::StreamReaction + + + + + +Node5->Node6 + + + + + +Node7 + + +reactesp::TickReaction + + + + + +Node5->Node7 + + + + + diff --git a/docs/generated/docs/inherit_graph_2.dot b/docs/generated/docs/inherit_graph_2.dot deleted file mode 100644 index 794224e..0000000 --- a/docs/generated/docs/inherit_graph_2.dot +++ /dev/null @@ -1,10 +0,0 @@ -digraph "Graphical Class Hierarchy" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="LR"; - Node0 [label="TriggerTimeCompare",height=0.2,width=0.4,color="black",URL="$struct_trigger_time_compare.html",tooltip=" "]; -} diff --git a/docs/generated/docs/inherit_graph_2.map b/docs/generated/docs/inherit_graph_2.map new file mode 100644 index 0000000..d0c37f3 --- /dev/null +++ b/docs/generated/docs/inherit_graph_2.map @@ -0,0 +1,3 @@ + + + diff --git a/docs/generated/docs/inherit_graph_2.md5 b/docs/generated/docs/inherit_graph_2.md5 new file mode 100644 index 0000000..5433495 --- /dev/null +++ b/docs/generated/docs/inherit_graph_2.md5 @@ -0,0 +1 @@ +670cc43f41b99cedcf20efc940a79444 \ No newline at end of file diff --git a/docs/generated/docs/inherit_graph_2.svg b/docs/generated/docs/inherit_graph_2.svg new file mode 100644 index 0000000..324d51c --- /dev/null +++ b/docs/generated/docs/inherit_graph_2.svg @@ -0,0 +1,21 @@ + + + + + + +Graphical Class Hierarchy + + +Node0 + + +reactesp::TriggerTimeCompare + + + + + diff --git a/docs/generated/docs/inherits.html b/docs/generated/docs/inherits.html index d77a696..6062043 100644 --- a/docs/generated/docs/inherits.html +++ b/docs/generated/docs/inherits.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -96,11 +96,11 @@ - - -
+
+
+
diff --git a/docs/generated/docs/main_8cpp.html b/docs/generated/docs/main_8cpp.html index fc7c25a..5c73b2a 100644 --- a/docs/generated/docs/main_8cpp.html +++ b/docs/generated/docs/main_8cpp.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -102,7 +102,7 @@
Include dependency graph for main.cpp:
-
+
@@ -110,47 +110,158 @@ - - + + + + + + + + + +

Macros

#define IO_REPEAT_DELAY   200
 
#define LED_PIN   2
 
#define OUT_PIN   14
 
#define INPUT_PIN1   12
 
#define INPUT_PIN2   13
 
#define NUM_TIMERS   20
 
- - + + + + + + + + + + + + + +

Functions

void ICACHE_RAM_ATTR isr ()
 
void reporter ()
 
void setup_timers (ReactESP &app)
 
void setup_io_pins (ReactESP &app)
 
void setup_serial (ReactESP &app)
 
void setup_tick (ReactESP &app)
 
void setup ()
 
void loop ()
 
- - - - + + + + + +

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");})
 
int tick_counter = 0
 
int timer_ticks [NUM_TIMERS]
 
ReactESP app
 

Macro Definition Documentation

- -

◆ IO_REPEAT_DELAY

+ +

◆ INPUT_PIN1

- +
#define IO_REPEAT_DELAY   200#define INPUT_PIN1   12
-

Definition at line 14 of file main.cpp.

+

Definition at line 8 of file main.cpp.

+ +
+
+ +

◆ INPUT_PIN2

+ +
+
+ + + + +
#define INPUT_PIN2   13
+
+ +

Definition at line 9 of file main.cpp.

+ +
+
+ +

◆ LED_PIN

+ +
+
+ + + + +
#define LED_PIN   2
+
+ +

Definition at line 6 of file main.cpp.

+ +
+
+ +

◆ NUM_TIMERS

+ +
+
+ + + + +
#define NUM_TIMERS   20
+
+ +

Definition at line 12 of file main.cpp.

+ +
+
+ +

◆ OUT_PIN

+ +
+
+ + + + +
#define OUT_PIN   14
+
+ +

Definition at line 7 of file main.cpp.

Function Documentation

- -

◆ isr()

+ +

◆ loop()

+ +
+
+ + + + + + + +
void loop ()
+
+ +

Definition at line 116 of file main.cpp.

+
+Here is the call graph for this function:
+
+
+
+
+ +
+
+ +

◆ reporter()

- + @@ -158,48 +269,215 @@

-

Definition at line 18 of file main.cpp.

+

Definition at line 19 of file main.cpp.

Here is the caller graph for this function:
-
+
-

Variable Documentation

- -

◆ app

+ +

◆ setup()

void ICACHE_RAM_ATTR isr void reporter ( )
- + -
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 setup ([] () { 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");}  )
+

Definition at line 105 of file main.cpp.

+
+Here is the call graph for this function:
+
+
+
+
+ +
+
+ +

◆ setup_io_pins()

+ +
+
+ + + + + + + + +
void setup_io_pins (ReactESPapp)
+
+ +

Definition at line 47 of file main.cpp.

+
+Here is the call graph for this function:
+
+
+
+
+
+Here is the caller graph for this function:
+
+
+
+
+ +
+
+ +

◆ setup_serial()

+ +
+
+ + + + + + + + +
void setup_serial (ReactESPapp)
+
+ +

Definition at line 78 of file main.cpp.

+
+Here is the call graph for this function:
+
+
+
+
+
+Here is the caller graph for this function:
+
+
+
+
+ +
+
+ +

◆ setup_tick()

+ +
+
+ + + + + + + + +
void setup_tick (ReactESPapp)
+
+ +

Definition at line 98 of file main.cpp.

+
+Here is the call graph for this function:
+
+
+
+
+
+Here is the caller graph for this function:
+
+
+
+
+ +
+
+ +

◆ setup_timers()

+ +
+
+ + + + + + + + +
void setup_timers (ReactESPapp)
+
+ +

Definition at line 31 of file main.cpp.

+
+Here is the call graph for this function:
+
+
+
+
+
+Here is the caller graph for this function:
+
+
+
+
+ +
+
+

Variable Documentation

+ +

◆ app

+ +
+
+ + + + +
ReactESP app
+
+ +

Definition at line 17 of file main.cpp.

+ +
+
+ +

◆ tick_counter

+ +
+
+ + + + +
int tick_counter = 0
+
+ +

Definition at line 14 of file main.cpp.

+
- -

◆ ticks

+ +

◆ timer_ticks

- +
volatile int ticks = 0int timer_ticks[NUM_TIMERS]
-

Definition at line 16 of file main.cpp.

+

Definition at line 15 of file main.cpp.

diff --git a/docs/generated/docs/main_8cpp.js b/docs/generated/docs/main_8cpp.js index 4932e78..100e151 100644 --- a/docs/generated/docs/main_8cpp.js +++ b/docs/generated/docs/main_8cpp.js @@ -1,7 +1,18 @@ var main_8cpp = [ - [ "IO_REPEAT_DELAY", "main_8cpp.html#ad64fdff6a92cd05ce2adf27c0adaf065", null ], - [ "isr", "main_8cpp.html#aa6359e12c4743a5b1888ac194c199674", null ], - [ "app", "main_8cpp.html#a828c6621f8cb3fef163c4b1f0c7e56c5", null ], - [ "ticks", "main_8cpp.html#ab97230fdf86fd49a50dbcc8e44fdf9cc", null ] + [ "INPUT_PIN1", "main_8cpp.html#af0a45111dfe499bdcb17708f49a57308", null ], + [ "INPUT_PIN2", "main_8cpp.html#a34c3d0a01760642883ba48bceddc2712", null ], + [ "LED_PIN", "main_8cpp.html#ab4553be4db9860d940f81d7447173b2f", null ], + [ "NUM_TIMERS", "main_8cpp.html#a34ad18456588200cc4dd40de41ba33f6", null ], + [ "OUT_PIN", "main_8cpp.html#a4077bef57f7b230360d3c9fd61abe7b7", null ], + [ "loop", "main_8cpp.html#afe461d27b9c48d5921c00d521181f12f", null ], + [ "reporter", "main_8cpp.html#a58acc222e959363ee034cea9488ef627", null ], + [ "setup", "main_8cpp.html#a4fc01d736fe50cf5b977f755b675f11d", null ], + [ "setup_io_pins", "main_8cpp.html#aa41a4d8986ed6c03bd6ad416ba134a4e", null ], + [ "setup_serial", "main_8cpp.html#aabd20f4bed5cefc2278d071d9dafb01f", null ], + [ "setup_tick", "main_8cpp.html#a4e12b91752b35a5f3a628424fcd5d73b", null ], + [ "setup_timers", "main_8cpp.html#a8b0ce963bacb63827eb79b51bc74a551", null ], + [ "app", "main_8cpp.html#aaa2ffd80e6f851dc6bb43c95a2c7d26f", null ], + [ "tick_counter", "main_8cpp.html#a6a8cac11201c2aa688c56aa3d8ae4e60", null ], + [ "timer_ticks", "main_8cpp.html#a9747497b4cd5b5c68c9ff49d3ded14a4", null ] ]; \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp__incl.dot b/docs/generated/docs/main_8cpp__incl.dot deleted file mode 100644 index 60524bf..0000000 --- a/docs/generated/docs/main_8cpp__incl.dot +++ /dev/null @@ -1,20 +0,0 @@ -digraph "src/main.cpp" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - Node1 [label="src/main.cpp",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="Arduino.h",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node1 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="ReactESP.h",height=0.2,width=0.4,color="black",URL="$_react_e_s_p_8h.html",tooltip=" "]; - Node3 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node4 [label="forward_list",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node3 -> Node5 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node5 [label="functional",height=0.2,width=0.4,color="grey75",tooltip=" "]; - Node3 -> Node6 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node6 [label="queue",height=0.2,width=0.4,color="grey75",tooltip=" "]; -} diff --git a/docs/generated/docs/main_8cpp__incl.map b/docs/generated/docs/main_8cpp__incl.map new file mode 100644 index 0000000..6005723 --- /dev/null +++ b/docs/generated/docs/main_8cpp__incl.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/generated/docs/main_8cpp__incl.md5 b/docs/generated/docs/main_8cpp__incl.md5 new file mode 100644 index 0000000..5195ca0 --- /dev/null +++ b/docs/generated/docs/main_8cpp__incl.md5 @@ -0,0 +1 @@ +c6f1f45dc6e0c7a74d352d5be06d373f \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp__incl.svg b/docs/generated/docs/main_8cpp__incl.svg new file mode 100644 index 0000000..c69bc30 --- /dev/null +++ b/docs/generated/docs/main_8cpp__incl.svg @@ -0,0 +1,102 @@ + + + + + + +src/main.cpp + + +Node1 + + +src/main.cpp + + + + + +Node2 + + +Arduino.h + + + + + +Node1->Node2 + + + + + +Node3 + + +ReactESP.h + + + + + +Node1->Node3 + + + + + +Node3->Node2 + + + + + +Node4 + + +forward_list + + + + + +Node3->Node4 + + + + + +Node5 + + +functional + + + + + +Node3->Node5 + + + + + +Node6 + + +queue + + + + + +Node3->Node6 + + + + + diff --git a/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.map b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.map new file mode 100644 index 0000000..402b66f --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.md5 b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.md5 new file mode 100644 index 0000000..dc34997 --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.md5 @@ -0,0 +1 @@ +26bdcc03a50b6dd69a105a5450bc0cb0 \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.svg b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.svg new file mode 100644 index 0000000..7e8f86f --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_cgraph.svg @@ -0,0 +1,52 @@ + + + + + + +setup_tick + + +Node1 + + +setup_tick + + + + + +Node2 + + +reactesp::ReactESP +::onTick + + + + + +Node1->Node2 + + + + + +Node3 + + +reactesp::UntimedReaction::add + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.map b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.map new file mode 100644 index 0000000..7333c8c --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.md5 b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.md5 new file mode 100644 index 0000000..3210a0c --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.md5 @@ -0,0 +1 @@ +49e17e7ed82e4db88a306cd55306b1a3 \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.svg b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.svg new file mode 100644 index 0000000..282e75a --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4e12b91752b35a5f3a628424fcd5d73b_icgraph.svg @@ -0,0 +1,36 @@ + + + + + + +setup_tick + + +Node1 + + +setup_tick + + + + + +Node2 + + +setup + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.map b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.map new file mode 100644 index 0000000..a202392 --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.map @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.md5 b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.md5 new file mode 100644 index 0000000..a638b6f --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.md5 @@ -0,0 +1 @@ +6e05fae15ac0ce84cd6d8298a9036345 \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.svg b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.svg new file mode 100644 index 0000000..f492d06 --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph.svg @@ -0,0 +1,349 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +setup + + +Node1 + + +setup + + + + + +Node2 + + +setup_io_pins + + + + + +Node1->Node2 + + + + + +Node9 + + +setup_serial + + + + + +Node1->Node9 + + + + + +Node13 + + +setup_tick + + + + + +Node1->Node13 + + + + + +Node15 + + +setup_timers + + + + + +Node1->Node15 + + + + + +Node3 + + +reactesp::ReactESP +::onInterrupt + + + + + +Node2->Node3 + + + + + +Node5 + + +reactesp::ReactESP +::onRepeat + + + + + +Node2->Node5 + + + + + +Node7 + + +reactesp::ISRReaction +::remove + + + + + +Node2->Node7 + + + + + +Node8 + + +reporter + + + + + +Node2->Node8 + + + + + +Node4 + + +reactesp::ISRReaction::add + + + + + +Node3->Node4 + + + + + +Node6 + + +reactesp::TimedReaction::add + + + + + +Node5->Node6 + + + + + +Node10 + + +reactesp::ReactESP +::onAvailable + + + + + +Node9->Node10 + + + + + +Node12 + + +reactesp::ReactESP +::onDelay + + + + + +Node9->Node12 + + + + + +Node11 + + +reactesp::UntimedReaction::add + + + + + +Node10->Node11 + + + + + +Node12->Node6 + + + + + +Node14 + + +reactesp::ReactESP +::onTick + + + + + +Node13->Node14 + + + + + +Node14->Node11 + + + + + +Node15->Node5 + + + + + +Node15->Node8 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph_org.svg b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph_org.svg new file mode 100644 index 0000000..45c830e --- /dev/null +++ b/docs/generated/docs/main_8cpp_a4fc01d736fe50cf5b977f755b675f11d_cgraph_org.svg @@ -0,0 +1,261 @@ + + + + + + +setup + + +Node1 + + +setup + + + + + +Node2 + + +setup_io_pins + + + + + +Node1->Node2 + + + + + +Node9 + + +setup_serial + + + + + +Node1->Node9 + + + + + +Node13 + + +setup_tick + + + + + +Node1->Node13 + + + + + +Node15 + + +setup_timers + + + + + +Node1->Node15 + + + + + +Node3 + + +reactesp::ReactESP +::onInterrupt + + + + + +Node2->Node3 + + + + + +Node5 + + +reactesp::ReactESP +::onRepeat + + + + + +Node2->Node5 + + + + + +Node7 + + +reactesp::ISRReaction +::remove + + + + + +Node2->Node7 + + + + + +Node8 + + +reporter + + + + + +Node2->Node8 + + + + + +Node4 + + +reactesp::ISRReaction::add + + + + + +Node3->Node4 + + + + + +Node6 + + +reactesp::TimedReaction::add + + + + + +Node5->Node6 + + + + + +Node10 + + +reactesp::ReactESP +::onAvailable + + + + + +Node9->Node10 + + + + + +Node12 + + +reactesp::ReactESP +::onDelay + + + + + +Node9->Node12 + + + + + +Node11 + + +reactesp::UntimedReaction::add + + + + + +Node10->Node11 + + + + + +Node12->Node6 + + + + + +Node14 + + +reactesp::ReactESP +::onTick + + + + + +Node13->Node14 + + + + + +Node14->Node11 + + + + + +Node15->Node5 + + + + + +Node15->Node8 + + + + + diff --git a/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.map b/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.map new file mode 100644 index 0000000..7f946bc --- /dev/null +++ b/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.md5 b/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.md5 new file mode 100644 index 0000000..95e1131 --- /dev/null +++ b/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.md5 @@ -0,0 +1 @@ +0fd57dbbc7ecf0ce1584a07aee6f929e \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.svg b/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.svg new file mode 100644 index 0000000..74b9d53 --- /dev/null +++ b/docs/generated/docs/main_8cpp_a58acc222e959363ee034cea9488ef627_icgraph.svg @@ -0,0 +1,72 @@ + + + + + + +reporter + + +Node1 + + +reporter + + + + + +Node2 + + +setup_io_pins + + + + + +Node1->Node2 + + + + + +Node4 + + +setup_timers + + + + + +Node1->Node4 + + + + + +Node3 + + +setup + + + + + +Node2->Node3 + + + + + +Node4->Node3 + + + + + diff --git a/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.map b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.map new file mode 100644 index 0000000..e3306de --- /dev/null +++ b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.md5 b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.md5 new file mode 100644 index 0000000..6843efe --- /dev/null +++ b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.md5 @@ -0,0 +1 @@ +e48f314d74304511317d81da783dba4c \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.svg b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.svg new file mode 100644 index 0000000..b37d74b --- /dev/null +++ b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_cgraph.svg @@ -0,0 +1,67 @@ + + + + + + +setup_timers + + +Node1 + + +setup_timers + + + + + +Node2 + + +reactesp::ReactESP +::onRepeat + + + + + +Node1->Node2 + + + + + +Node4 + + +reporter + + + + + +Node1->Node4 + + + + + +Node3 + + +reactesp::TimedReaction::add + + + + + +Node2->Node3 + + + + + diff --git a/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.map b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.map new file mode 100644 index 0000000..bad5c10 --- /dev/null +++ b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.md5 b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.md5 new file mode 100644 index 0000000..4e8ca1a --- /dev/null +++ b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.md5 @@ -0,0 +1 @@ +71b189ebd603e620bde1a7a324ac5171 \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.svg b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.svg new file mode 100644 index 0000000..2b227fa --- /dev/null +++ b/docs/generated/docs/main_8cpp_a8b0ce963bacb63827eb79b51bc74a551_icgraph.svg @@ -0,0 +1,36 @@ + + + + + + +setup_timers + + +Node1 + + +setup_timers + + + + + +Node2 + + +setup + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.map b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.map new file mode 100644 index 0000000..893dad6 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.md5 b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.md5 new file mode 100644 index 0000000..af148b9 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.md5 @@ -0,0 +1 @@ +fedd645a97c9a44047a63c849a57458e \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.svg b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.svg new file mode 100644 index 0000000..27636dd --- /dev/null +++ b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_cgraph.svg @@ -0,0 +1,114 @@ + + + + + + +setup_io_pins + + +Node1 + + +setup_io_pins + + + + + +Node2 + + +reactesp::ReactESP +::onInterrupt + + + + + +Node1->Node2 + + + + + +Node4 + + +reactesp::ReactESP +::onRepeat + + + + + +Node1->Node4 + + + + + +Node6 + + +reactesp::ISRReaction +::remove + + + + + +Node1->Node6 + + + + + +Node7 + + +reporter + + + + + +Node1->Node7 + + + + + +Node3 + + +reactesp::ISRReaction::add + + + + + +Node2->Node3 + + + + + +Node5 + + +reactesp::TimedReaction::add + + + + + +Node4->Node5 + + + + + diff --git a/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.map b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.map new file mode 100644 index 0000000..a6179d8 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.md5 b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.md5 new file mode 100644 index 0000000..d20d43d --- /dev/null +++ b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.md5 @@ -0,0 +1 @@ +f78ea66108d4862d2fc3a916563eb12e \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.svg b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.svg new file mode 100644 index 0000000..a492936 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aa41a4d8986ed6c03bd6ad416ba134a4e_icgraph.svg @@ -0,0 +1,36 @@ + + + + + + +setup_io_pins + + +Node1 + + +setup_io_pins + + + + + +Node2 + + +setup + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/main_8cpp_aa6359e12c4743a5b1888ac194c199674_icgraph.dot b/docs/generated/docs/main_8cpp_aa6359e12c4743a5b1888ac194c199674_icgraph.dot deleted file mode 100644 index 522c2a4..0000000 --- a/docs/generated/docs/main_8cpp_aa6359e12c4743a5b1888ac194c199674_icgraph.dot +++ /dev/null @@ -1,14 +0,0 @@ -digraph "isr" -{ - // INTERACTIVE_SVG=YES - // LATEX_PDF_SIZE - bgcolor="transparent"; - edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; - node [fontname="Helvetica",fontsize="10",shape=record]; - rankdir="RL"; - Node1 [label="isr",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black",tooltip=" "]; - Node1 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node2 [label="ISRReaction::add",height=0.2,width=0.4,color="black",URL="$class_i_s_r_reaction.html#aba4a495b10cf265d41cbdb9790936072",tooltip=" "]; - Node2 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; - Node3 [label="ReactESP::onInterrupt",height=0.2,width=0.4,color="black",URL="$class_react_e_s_p.html#a02ce0511803b0d3a1fcec6bc56ff8b3f",tooltip="Create a new ISRReaction (interrupt reaction)"]; -} diff --git a/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.map b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.map new file mode 100644 index 0000000..66fb893 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.md5 b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.md5 new file mode 100644 index 0000000..80fa0e5 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.md5 @@ -0,0 +1 @@ +f0dd319497c684169c713e7b1610c16b \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.svg b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.svg new file mode 100644 index 0000000..b248736 --- /dev/null +++ b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_cgraph.svg @@ -0,0 +1,83 @@ + + + + + + +setup_serial + + +Node1 + + +setup_serial + + + + + +Node2 + + +reactesp::ReactESP +::onAvailable + + + + + +Node1->Node2 + + + + + +Node4 + + +reactesp::ReactESP +::onDelay + + + + + +Node1->Node4 + + + + + +Node3 + + +reactesp::UntimedReaction::add + + + + + +Node2->Node3 + + + + + +Node5 + + +reactesp::TimedReaction::add + + + + + +Node4->Node5 + + + + + diff --git a/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.map b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.map new file mode 100644 index 0000000..f6475ba --- /dev/null +++ b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.md5 b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.md5 new file mode 100644 index 0000000..bf9196e --- /dev/null +++ b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.md5 @@ -0,0 +1 @@ +74c59a97e56bda857b480fea20e765e2 \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.svg b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.svg new file mode 100644 index 0000000..d29c11b --- /dev/null +++ b/docs/generated/docs/main_8cpp_aabd20f4bed5cefc2278d071d9dafb01f_icgraph.svg @@ -0,0 +1,36 @@ + + + + + + +setup_serial + + +Node1 + + +setup_serial + + + + + +Node2 + + +setup + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.map b/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.map new file mode 100644 index 0000000..2ef301e --- /dev/null +++ b/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.md5 b/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.md5 new file mode 100644 index 0000000..704a6a3 --- /dev/null +++ b/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.md5 @@ -0,0 +1 @@ +8b5978094f3a8bd8de9f1ff2ac881c83 \ No newline at end of file diff --git a/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.svg b/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.svg new file mode 100644 index 0000000..510865e --- /dev/null +++ b/docs/generated/docs/main_8cpp_afe461d27b9c48d5921c00d521181f12f_cgraph.svg @@ -0,0 +1,37 @@ + + + + + + +loop + + +Node1 + + +loop + + + + + +Node2 + + +reactesp::ReactESP +::tick + + + + + +Node1->Node2 + + + + + diff --git a/docs/generated/docs/main_8cpp_source.html b/docs/generated/docs/main_8cpp_source.html index 628faae..c4e89f2 100644 --- a/docs/generated/docs/main_8cpp_source.html +++ b/docs/generated/docs/main_8cpp_source.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -96,63 +96,147 @@ Go to the documentation of this file.
1#include <Arduino.h>
2#include <ReactESP.h>
3
-
4#ifdef ESP32
-
5#define LED_PIN 2
-
6#define INPUT_PIN 13
-
7#define OUTPUT_PIN 15
-
8#elif defined(ESP8266)
-
9#define LED_PIN D2
-
10#define INPUT_PIN D5
-
11#define OUTPUT_PIN D4
-
12#endif
+
4using namespace reactesp;
+
5
+
6#define LED_PIN 2
+
7#define OUT_PIN 14 // D5
+
8#define INPUT_PIN1 12 // D6
+
9#define INPUT_PIN2 13 // D7
+
10
+
11
+
12#define NUM_TIMERS 20
13
-
14#define IO_REPEAT_DELAY 200
-
15
-
16volatile int ticks = 0;
-
17
-
18void ICACHE_RAM_ATTR isr() { ticks++; }
-
19
- -
21 Serial.begin(115200);
-
22
-
23 pinMode(LED_PIN, OUTPUT);
-
24 pinMode(INPUT_PIN, INPUT_PULLUP);
-
25
- -
27 static bool state = false;
-
28 digitalWrite(LED_PIN, state);
-
29 state = !state;
-
30 });
-
31
-
32 // attachInterrupt(INPUT_PIN, &isr, FALLING);
-
33 app.onInterrupt(INPUT_PIN, RISING, &isr);
-
34
-
35 app.onRepeat(1000, []() {
-
36 uint64_t now = micros64();
-
37 uint32_t now_high = now >> 32;
-
38 uint32_t now_low = now & 0xffffffff;
-
39 Serial.printf("Ticks: %d %08X %08X\n", ticks, now_high, now_low);
-
40 ticks = 0;
-
41 });
-
42
-
43 pinMode(OUTPUT_PIN, OUTPUT);
-
44
-
45 app.onRepeat(20, []() {
-
46 digitalWrite(OUTPUT_PIN, !digitalRead(OUTPUT_PIN));
-
47 });
-
48
-
49 Serial.println("First");
-
50 Serial.println("Second");
-
51});
+ + +
16
+ +
18
+
19void reporter() {
+
20 Serial.printf("Timer ticks: ");
+
21 for (int i=0; i<NUM_TIMERS; i++) {
+
22 Serial.printf("%d ", timer_ticks[i]);
+
23 timer_ticks[i] = 0;
+
24 }
+
25 Serial.printf("\n");
+
26 Serial.printf("Free mem: %d\n", system_get_free_heap_size());
+
27 Serial.printf("Ticks per second: %d\n", tick_counter);
+
28 tick_counter = 0;
+
29}
+
30
+ +
32 // create twenty timers
+
33
+
34 for (int i=0; i<NUM_TIMERS; i++) {
+
35 timer_ticks[i] = 0;
+
36 int delay = (i+1)*(i+1);
+
37 app.onRepeat(delay, [i]() {
+
38 timer_ticks[i]++;
+
39 });
+
40 }
+
41
+
42 // create one more timer to report the counted ticks
+
43
+
44 app.onRepeat(1000, reporter);
+
45}
+
46
+ +
48 static ISRReaction* ire2 = nullptr;
+
49 static int out_pin_state = 0;
+
50
+
51
+
52 // change OUT_PIN state every 900 ms
+
53 pinMode(OUT_PIN, OUTPUT);
+
54 app.onRepeat(900, [] () {
+
55 out_pin_state = !out_pin_state;
+
56 digitalWrite(OUT_PIN, out_pin_state);
+
57 });
+
58
+
59 auto reporter = [] (int pin) {
+
60 Serial.printf("Pin %d changed state.\n", pin);
+
61 };
+
62
+
63 // create an interrupt that always reports if PIN1 is rising
+
64 app.onInterrupt(INPUT_PIN1, RISING, std::bind(reporter, INPUT_PIN1));
+
65
+
66 // every 9s, toggle reporting PIN2 falling edge
+
67 app.onRepeat(9000, [&app, &reporter]() {
+
68 if (ire2==nullptr) {
+
69 ire2 = app.onInterrupt(INPUT_PIN2, FALLING, std::bind(reporter, INPUT_PIN2));
+
70 } else {
+
71 ire2->remove();
+
72 ire2 = nullptr;
+
73 }
+
74 });
+
75
+
76}
+
77
+ +
79 // if something is received on the serial port, turn the led off for one second
+
80 app.onAvailable(Serial, [&app] () {
+
81 static int reaction_counter = 0;
+
82
+
83 Serial.write(Serial.read());
+
84 digitalWrite(LED_PIN, HIGH);
+
85
+
86 reaction_counter++;
+
87
+
88 int current = reaction_counter;
+
89
+
90 app.onDelay(1000, [current] () {
+
91 if (reaction_counter==current) {
+
92 digitalWrite(LED_PIN, LOW);
+
93 }
+
94 });
+
95 });
+
96}
+
97
+ +
99 // increase the tick counter on every tick
+
100 app.onTick([]() {
+
101 tick_counter++;
+
102 });
+
103}
+
104
+
105void setup() {
+
106 Serial.begin(115200);
+
107 Serial.println("Starting");
+
108 pinMode(LED_PIN, OUTPUT);
+
109
+ + + + +
114}
+
115
+
116void loop() {
+
117 app.tick();
+
118}
-
Main class of a ReactESP program.
Definition: ReactESP.h:245
-
ISRReaction * onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)
Create a new ISRReaction (interrupt reaction)
Definition: ReactESP.cpp:182
-
RepeatReaction * onRepeatMicros(const uint64_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:169
-
RepeatReaction * onRepeat(const uint32_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:163
-
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()
Definition: main.cpp:18
-
volatile int ticks
Definition: main.cpp:16
-
#define IO_REPEAT_DELAY
Definition: main.cpp:14
+
Reaction that is triggered on an input pin change.
Definition: ReactESP.h:187
+ +
Main class of a ReactESP program.
Definition: ReactESP.h:247
+
StreamReaction * onAvailable(Stream &stream, const react_callback cb)
Create a new StreamReaction.
Definition: ReactESP.cpp:171
+
DelayReaction * onDelay(const uint32_t t, const react_callback cb)
Create a new DelayReaction.
Definition: ReactESP.cpp:145
+
void tick(void)
Definition: ReactESP.cpp:140
+
RepeatReaction * onRepeat(const uint32_t t, const react_callback cb)
Create a new RepeatReaction.
Definition: ReactESP.cpp:158
+
TickReaction * onTick(const react_callback cb)
Create a new TickReaction.
Definition: ReactESP.cpp:184
+
ISRReaction * onInterrupt(const uint8_t pin_number, int mode, const react_callback cb)
Create a new ISRReaction (interrupt reaction)
Definition: ReactESP.cpp:177
+
#define NUM_TIMERS
Definition: main.cpp:12
+
#define INPUT_PIN2
Definition: main.cpp:9
+
#define OUT_PIN
Definition: main.cpp:7
+
void setup_tick(ReactESP &app)
Definition: main.cpp:98
+
void setup()
Definition: main.cpp:105
+
void reporter()
Definition: main.cpp:19
+
int tick_counter
Definition: main.cpp:14
+
void setup_timers(ReactESP &app)
Definition: main.cpp:31
+
int timer_ticks[NUM_TIMERS]
Definition: main.cpp:15
+
void setup_io_pins(ReactESP &app)
Definition: main.cpp:47
+
ReactESP app
Definition: main.cpp:17
+
void setup_serial(ReactESP &app)
Definition: main.cpp:78
+
#define LED_PIN
Definition: main.cpp:6
+
#define INPUT_PIN1
Definition: main.cpp:8
+
void loop()
Definition: main.cpp:116
+
diff --git a/docs/generated/docs/menudata.js b/docs/generated/docs/menudata.js index 9face5c..727e23f 100644 --- a/docs/generated/docs/menudata.js +++ b/docs/generated/docs/menudata.js @@ -24,6 +24,11 @@ */ var menudata={children:[ {text:"Main Page",url:"index.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}, +{text:"Namespace Members",url:"namespacemembers.html",children:[ +{text:"All",url:"namespacemembers.html"}, +{text:"Typedefs",url:"namespacemembers_type.html"}]}]}, {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, @@ -62,5 +67,4 @@ var menudata={children:[ {text:"All",url:"globals.html"}, {text:"Functions",url:"globals_func.html"}, {text:"Variables",url:"globals_vars.html"}, -{text:"Typedefs",url:"globals_type.html"}, {text:"Macros",url:"globals_defs.html"}]}]}]} diff --git a/docs/generated/docs/namespacemembers.html b/docs/generated/docs/namespacemembers.html new file mode 100644 index 0000000..3efa283 --- /dev/null +++ b/docs/generated/docs/namespacemembers.html @@ -0,0 +1,106 @@ + + + + + + + +ReactESP: Namespace Members + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
Here is a list of all namespace members with links to the namespace documentation for each member:
+
+
+ + + + diff --git a/docs/generated/docs/globals_type.html b/docs/generated/docs/namespacemembers_type.html similarity index 90% rename from docs/generated/docs/globals_type.html rename to docs/generated/docs/namespacemembers_type.html index 249712b..976a1a0 100644 --- a/docs/generated/docs/globals_type.html +++ b/docs/generated/docs/namespacemembers_type.html @@ -5,7 +5,7 @@ -ReactESP: File Members +ReactESP: Namespace Members @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -91,8 +91,8 @@
 
diff --git a/docs/generated/docs/namespacereactesp.html b/docs/generated/docs/namespacereactesp.html new file mode 100644 index 0000000..dfc9a28 --- /dev/null +++ b/docs/generated/docs/namespacereactesp.html @@ -0,0 +1,182 @@ + + + + + + + +ReactESP: reactesp Namespace Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
reactesp Namespace Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Classes

class  DelayReaction
 Reaction that is triggered after a certain time delay. More...
 
class  ISRReaction
 Reaction that is triggered on an input pin change. More...
 
class  ReactESP
 Main class of a ReactESP program. More...
 
class  Reaction
 Reactions are code to be called when a given condition is fulfilled. More...
 
class  RepeatReaction
 Reaction that is triggered repeatedly. 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  TimedReaction
 TimedReactions are called based on elapsing of time. More...
 
struct  TriggerTimeCompare
 
class  UntimedReaction
 Reactions that are triggered based on something else than time. More...
 
+ + + + + +

+Typedefs

typedef std::function< void()> react_callback
 
typedef void(* isr_react_callback) (void *)
 
+

Typedef Documentation

+ +

◆ isr_react_callback

+ +
+
+ + + + +
typedef void(* reactesp::isr_react_callback) (void *)
+
+ +

Definition at line 13 of file ReactESP.h.

+ +
+
+ +

◆ react_callback

+ +
+
+ + + + +
typedef std::function<void()> reactesp::react_callback
+
+ +

Definition at line 12 of file ReactESP.h.

+ +
+
+
+
+ + + + diff --git a/docs/generated/docs/namespacereactesp.js b/docs/generated/docs/namespacereactesp.js new file mode 100644 index 0000000..9e44a4d --- /dev/null +++ b/docs/generated/docs/namespacereactesp.js @@ -0,0 +1,15 @@ +var namespacereactesp = +[ + [ "DelayReaction", "classreactesp_1_1_delay_reaction.html", "classreactesp_1_1_delay_reaction" ], + [ "ISRReaction", "classreactesp_1_1_i_s_r_reaction.html", "classreactesp_1_1_i_s_r_reaction" ], + [ "ReactESP", "classreactesp_1_1_react_e_s_p.html", "classreactesp_1_1_react_e_s_p" ], + [ "Reaction", "classreactesp_1_1_reaction.html", "classreactesp_1_1_reaction" ], + [ "RepeatReaction", "classreactesp_1_1_repeat_reaction.html", "classreactesp_1_1_repeat_reaction" ], + [ "StreamReaction", "classreactesp_1_1_stream_reaction.html", "classreactesp_1_1_stream_reaction" ], + [ "TickReaction", "classreactesp_1_1_tick_reaction.html", "classreactesp_1_1_tick_reaction" ], + [ "TimedReaction", "classreactesp_1_1_timed_reaction.html", "classreactesp_1_1_timed_reaction" ], + [ "TriggerTimeCompare", "structreactesp_1_1_trigger_time_compare.html", "structreactesp_1_1_trigger_time_compare" ], + [ "UntimedReaction", "classreactesp_1_1_untimed_reaction.html", "classreactesp_1_1_untimed_reaction" ], + [ "isr_react_callback", "namespacereactesp.html#a2b5792453cf14eaa49fd355ad1011482", null ], + [ "react_callback", "namespacereactesp.html#a1dfbc20eb5c3efa2665acac404585b81", null ] +]; \ No newline at end of file diff --git a/docs/generated/docs/namespaces.html b/docs/generated/docs/namespaces.html new file mode 100644 index 0000000..36c324a --- /dev/null +++ b/docs/generated/docs/namespaces.html @@ -0,0 +1,120 @@ + + + + + + + +ReactESP: Namespace List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
ReactESP 2.0.0 +
+
Asynchronous programming for the ESP microcontrollers
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
Namespace List
+
+
+
Here is a list of all namespaces with brief descriptions:
+
[detail level 12]
+ + + + + + + + + + + +
 Nreactesp
 CDelayReactionReaction that is triggered after a certain time delay
 CISRReactionReaction that is triggered on an input pin change
 CReactESPMain class of a ReactESP program
 CReactionReactions are code to be called when a given condition is fulfilled
 CRepeatReactionReaction that is triggered repeatedly
 CStreamReactionReaction that is triggered when there is input available at the given Arduino Stream
 CTickReactionReaction that is triggered unconditionally at each execution loop
 CTimedReactionTimedReactions are called based on elapsing of time
 CTriggerTimeCompare
 CUntimedReactionReactions that are triggered based on something else than time
+
+
+
+ + + + diff --git a/docs/generated/docs/namespaces_dup.js b/docs/generated/docs/namespaces_dup.js new file mode 100644 index 0000000..14a5bbb --- /dev/null +++ b/docs/generated/docs/namespaces_dup.js @@ -0,0 +1,4 @@ +var namespaces_dup = +[ + [ "reactesp", "namespacereactesp.html", "namespacereactesp" ] +]; \ No newline at end of file diff --git a/docs/generated/docs/navtreedata.js b/docs/generated/docs/navtreedata.js index 6e3d12c..32b36ee 100644 --- a/docs/generated/docs/navtreedata.js +++ b/docs/generated/docs/navtreedata.js @@ -25,6 +25,13 @@ var NAVTREE = [ [ "ReactESP", "index.html", [ + [ "Namespaces", "namespaces.html", [ + [ "Namespace List", "namespaces.html", "namespaces_dup" ], + [ "Namespace Members", "namespacemembers.html", [ + [ "All", "namespacemembers.html", null ], + [ "Typedefs", "namespacemembers_type.html", null ] + ] ] + ] ], [ "Classes", "annotated.html", [ [ "Class List", "annotated.html", "annotated_dup" ], [ "Class Index", "classes.html", null ], @@ -42,7 +49,6 @@ var NAVTREE = [ "All", "globals.html", null ], [ "Functions", "globals_func.html", null ], [ "Variables", "globals_vars.html", null ], - [ "Typedefs", "globals_type.html", null ], [ "Macros", "globals_defs.html", null ] ] ] ] ] diff --git a/docs/generated/docs/navtreeindex0.js b/docs/generated/docs/navtreeindex0.js index 95dda2e..372655e 100644 --- a/docs/generated/docs/navtreeindex0.js +++ b/docs/generated/docs/navtreeindex0.js @@ -1,98 +1,175 @@ var NAVTREEINDEX0 = { -"_react_e_s_p_8cpp.html":[1,0,0,1], -"_react_e_s_p_8cpp.html#a0b33edabd7f1c4e4a0bf32c67269be2f":[1,0,0,1,0], -"_react_e_s_p_8cpp.html#a7dfd9b79bc5a37d7df40207afbc5431f":[1,0,0,1,1], -"_react_e_s_p_8cpp_source.html":[1,0,0,1], -"_react_e_s_p_8h.html":[1,0,0,2], -"_react_e_s_p_8h.html#a67b5c9351881150cba489e7594e0c976":[1,0,0,2,10], -"_react_e_s_p_8h.html#aced18b35574cdf9238eeb6d2c997db7f":[1,0,0,2,11], -"_react_e_s_p_8h_source.html":[1,0,0,2], -"annotated.html":[0,0], -"class_delay_reaction.html":[0,0,0], -"class_delay_reaction.html#a27b07f8afc197ac54b6192c411d7e50b":[0,0,0,1], -"class_delay_reaction.html#a50777489f0975d07a81c39c0638d1a7e":[0,0,0,2], -"class_delay_reaction.html#ab8cabba2391d4f4d836f4f060425ddb0":[0,0,0,0], -"class_delay_reaction.html#af2a85d71205ad1cbf5f6471f17e91a6f":[0,0,0,3], -"class_i_s_r_reaction.html":[0,0,1], -"class_i_s_r_reaction.html#a6470d8b82a5066562ad9a2e169ea19b8":[0,0,1,3], -"class_i_s_r_reaction.html#a675599c657aa6aae62a1bc08510edfe5":[0,0,1,0], -"class_i_s_r_reaction.html#aab332af06426b145d73c1b46b4d7c3fd":[0,0,1,4], -"class_i_s_r_reaction.html#aba4a495b10cf265d41cbdb9790936072":[0,0,1,2], -"class_i_s_r_reaction.html#adca866ff1b4dd48450ab0076707221bd":[0,0,1,1], -"class_react_e_s_p.html":[0,0,2], -"class_react_e_s_p.html#a02ce0511803b0d3a1fcec6bc56ff8b3f":[0,0,2,4], -"class_react_e_s_p.html#a2a7018e7a5e89634e8e4385be51eafd4":[0,0,2,6], -"class_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348":[0,0,2,12], -"class_react_e_s_p.html#a5dafe71a8c9c2834c5c34cc86b820c9a":[0,0,2,0], -"class_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51":[0,0,2,11], -"class_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269":[0,0,2,10], -"class_react_e_s_p.html#a7da68d41f2a9790ab1aec2610bad07eb":[0,0,2,7], -"class_react_e_s_p.html#a831c11dd7f1a6e15d70785c3a990df93":[0,0,2,1], -"class_react_e_s_p.html#aa26556a0954d117dc5b8d925e5924cdf":[0,0,2,8], -"class_react_e_s_p.html#ab26769ff3e426972e87746749560ffc0":[0,0,2,2], -"class_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad":[0,0,2,14], -"class_react_e_s_p.html#ad5739bf0fedb24931f98762113161e95":[0,0,2,3], -"class_react_e_s_p.html#adb20144bde6e60b41e484d2f6f61d0f5":[0,0,2,5], -"class_react_e_s_p.html#aeefac464d9df930d020a321a63cdcf4b":[0,0,2,9], -"class_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d":[0,0,2,13], -"class_reaction.html":[0,0,3], -"class_reaction.html#a13fdfc7eef62041f7394eac1f0b53978":[0,0,3,4], -"class_reaction.html#a24cc0bd38eea8c50dd6718bb7a1c8051":[0,0,3,3], -"class_reaction.html#a349da2fef93c94095c264ead1f5ffcb8":[0,0,3,1], -"class_reaction.html#aea66093d451e22677190c38176b9fe40":[0,0,3,0], -"class_reaction.html#af88faf9664340633d6cc5f913ab4e105":[0,0,3,2], -"class_repeat_reaction.html":[0,0,4], -"class_repeat_reaction.html#a2c05598c7a03d60ec1088db1da5d851d":[0,0,4,2], -"class_repeat_reaction.html#a5b53f55d5b252708eb2348c4c3a55868":[0,0,4,1], -"class_repeat_reaction.html#a68c6ea9ade842d93ef967d977937f683":[0,0,4,0], -"class_stream_reaction.html":[0,0,5], -"class_stream_reaction.html#a902a27a4c687e6eac1255c4fad74bf17":[0,0,5,0], -"class_stream_reaction.html#aa874d5cc82b5392075da1262e318a703":[0,0,5,1], -"class_tick_reaction.html":[0,0,6], -"class_tick_reaction.html#a0928c0693f10acec61157027dd4658fe":[0,0,6,0], -"class_tick_reaction.html#aa4e6419363cef721057c990111542b93":[0,0,6,1], -"class_timed_reaction.html":[0,0,7], -"class_timed_reaction.html#a163d0232141ebe0d446d853969766a69":[0,0,7,3], -"class_timed_reaction.html#a2f26edad67264a6c4f4da7d7ebfbb661":[0,0,7,2], -"class_timed_reaction.html#a403ac811efb47fc24aae688b83309540":[0,0,7,12], -"class_timed_reaction.html#a431489308733484afc1f3b6b80289be1":[0,0,7,7], -"class_timed_reaction.html#a4a775a7624ba511ae80016e14b8d88f5":[0,0,7,1], -"class_timed_reaction.html#a4ff15ba9b01cc69b045aac06b896404c":[0,0,7,5], -"class_timed_reaction.html#a56eb9a737b11089358d34cc347f9fc7a":[0,0,7,9], -"class_timed_reaction.html#ac419476db7b8b64c6b13ff62334a95ad":[0,0,7,4], -"class_timed_reaction.html#acac370ae042f0561beecf528551ccad9":[0,0,7,8], -"class_timed_reaction.html#ad4a692b89c47ea51055534e8286532fa":[0,0,7,11], -"class_timed_reaction.html#ae4c582a52e93db97646f8fbb0bb1b909":[0,0,7,10], -"class_timed_reaction.html#af1653cd9ff0b545e95baec51cde2743c":[0,0,7,0], -"class_timed_reaction.html#af42d731961b6abcd508b48f4e007ebcf":[0,0,7,6], -"class_untimed_reaction.html":[0,0,9], -"class_untimed_reaction.html#a1e33cb5f40db3c477f0a476d63999770":[0,0,9,0], -"class_untimed_reaction.html#a52cdd4974e63425e6db056a50c9a51d6":[0,0,9,3], -"class_untimed_reaction.html#a803aa29ba1f5d9f0312d71e09ee83f15":[0,0,9,4], -"class_untimed_reaction.html#aaf8d78a83d9c8174a2e069cb6279a793":[0,0,9,2], -"class_untimed_reaction.html#acd2ff1b448599949c3ad1d2e80b23507":[0,0,9,1], -"classes.html":[0,1], -"dir_68267d1309a1af8e8297ef4c3efbcdba.html":[1,0,0], -"files.html":[1,0], -"functions.html":[0,3,0], -"functions_func.html":[0,3,1], -"functions_rela.html":[0,3,3], -"functions_vars.html":[0,3,2], -"globals.html":[1,1,0], -"globals_defs.html":[1,1,4], -"globals_func.html":[1,1,1], -"globals_type.html":[1,1,3], -"globals_vars.html":[1,1,2], -"hierarchy.html":[0,2], +"_react_e_s_p_8cpp.html":[2,0,0,1], +"_react_e_s_p_8cpp_source.html":[2,0,0,1], +"_react_e_s_p_8h.html":[2,0,0,2], +"_react_e_s_p_8h.html#a1dfbc20eb5c3efa2665acac404585b81":[2,0,0,2,11], +"_react_e_s_p_8h.html#a2b5792453cf14eaa49fd355ad1011482":[2,0,0,2,10], +"_react_e_s_p_8h_source.html":[2,0,0,2], +"annotated.html":[1,0], +"classes.html":[1,1], +"classreactesp_1_1_delay_reaction.html":[1,0,0,0], +"classreactesp_1_1_delay_reaction.html":[0,0,0,0], +"classreactesp_1_1_delay_reaction.html#a6fbe0cd7f47fc81abdade25f09eed5f8":[1,0,0,0,1], +"classreactesp_1_1_delay_reaction.html#a6fbe0cd7f47fc81abdade25f09eed5f8":[0,0,0,0,1], +"classreactesp_1_1_delay_reaction.html#aac5ab07009878644f0d9d1d5b2f7ce40":[0,0,0,0,0], +"classreactesp_1_1_delay_reaction.html#aac5ab07009878644f0d9d1d5b2f7ce40":[1,0,0,0,0], +"classreactesp_1_1_delay_reaction.html#ad7f7bab48635897fec696b139d59c134":[1,0,0,0,3], +"classreactesp_1_1_delay_reaction.html#ad7f7bab48635897fec696b139d59c134":[0,0,0,0,3], +"classreactesp_1_1_delay_reaction.html#af1fbdbee6c0c032d5acab763d315a34d":[0,0,0,0,2], +"classreactesp_1_1_delay_reaction.html#af1fbdbee6c0c032d5acab763d315a34d":[1,0,0,0,2], +"classreactesp_1_1_i_s_r_reaction.html":[1,0,0,1], +"classreactesp_1_1_i_s_r_reaction.html":[0,0,0,1], +"classreactesp_1_1_i_s_r_reaction.html#a850a9346562861c44a9bc3a20e13ba1f":[1,0,0,1,1], +"classreactesp_1_1_i_s_r_reaction.html#a850a9346562861c44a9bc3a20e13ba1f":[0,0,0,1,1], +"classreactesp_1_1_i_s_r_reaction.html#a9ccf4abc748379340fb0e97b77c3bc4d":[0,0,0,1,3], +"classreactesp_1_1_i_s_r_reaction.html#a9ccf4abc748379340fb0e97b77c3bc4d":[1,0,0,1,3], +"classreactesp_1_1_i_s_r_reaction.html#aa8a31d433ff7e8a112afd9461e5da479":[1,0,0,1,4], +"classreactesp_1_1_i_s_r_reaction.html#aa8a31d433ff7e8a112afd9461e5da479":[0,0,0,1,4], +"classreactesp_1_1_i_s_r_reaction.html#ac7b7efd14de7cd96df315e761f962d4a":[1,0,0,1,2], +"classreactesp_1_1_i_s_r_reaction.html#ac7b7efd14de7cd96df315e761f962d4a":[0,0,0,1,2], +"classreactesp_1_1_i_s_r_reaction.html#add1ee86128b01e211cac9126a8b485d3":[1,0,0,1,0], +"classreactesp_1_1_i_s_r_reaction.html#add1ee86128b01e211cac9126a8b485d3":[0,0,0,1,0], +"classreactesp_1_1_react_e_s_p.html":[0,0,0,2], +"classreactesp_1_1_react_e_s_p.html":[1,0,0,2], +"classreactesp_1_1_react_e_s_p.html#a42c88fbcd1f1ab9842517056448de6b5":[1,0,0,2,1], +"classreactesp_1_1_react_e_s_p.html#a42c88fbcd1f1ab9842517056448de6b5":[0,0,0,2,1], +"classreactesp_1_1_react_e_s_p.html#a4f51c39bd90492f6184872f6d91f14dd":[0,0,0,2,3], +"classreactesp_1_1_react_e_s_p.html#a4f51c39bd90492f6184872f6d91f14dd":[1,0,0,2,3], +"classreactesp_1_1_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348":[0,0,0,2,11], +"classreactesp_1_1_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348":[1,0,0,2,11], +"classreactesp_1_1_react_e_s_p.html#a5b25d026d1f26fb80b2c6659f3875fd8":[1,0,0,2,2], +"classreactesp_1_1_react_e_s_p.html#a5b25d026d1f26fb80b2c6659f3875fd8":[0,0,0,2,2], +"classreactesp_1_1_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51":[0,0,0,2,10], +"classreactesp_1_1_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51":[1,0,0,2,10], +"classreactesp_1_1_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269":[1,0,0,2,9], +"classreactesp_1_1_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269":[0,0,0,2,9], +"classreactesp_1_1_react_e_s_p.html#a683d99a3ed39a75337f01888c2240df0":[1,0,0,2,8], +"classreactesp_1_1_react_e_s_p.html#a683d99a3ed39a75337f01888c2240df0":[0,0,0,2,8], +"classreactesp_1_1_react_e_s_p.html#a914de417d6b11c6111df8bba25d5ed75":[1,0,0,2,5], +"classreactesp_1_1_react_e_s_p.html#a914de417d6b11c6111df8bba25d5ed75":[0,0,0,2,5], +"classreactesp_1_1_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad":[0,0,0,2,13], +"classreactesp_1_1_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad":[1,0,0,2,13], +"classreactesp_1_1_react_e_s_p.html#ab60d32aea4a5c8040d9fb46797ebd63e":[1,0,0,2,0], +"classreactesp_1_1_react_e_s_p.html#ab60d32aea4a5c8040d9fb46797ebd63e":[0,0,0,2,0], +"classreactesp_1_1_react_e_s_p.html#ad15637cf3778be71a156845bd069506a":[1,0,0,2,6], +"classreactesp_1_1_react_e_s_p.html#ad15637cf3778be71a156845bd069506a":[0,0,0,2,6], +"classreactesp_1_1_react_e_s_p.html#ae442c7e1e8084f46a900646957f1f9c8":[0,0,0,2,7], +"classreactesp_1_1_react_e_s_p.html#ae442c7e1e8084f46a900646957f1f9c8":[1,0,0,2,7], +"classreactesp_1_1_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d":[1,0,0,2,12], +"classreactesp_1_1_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d":[0,0,0,2,12], +"classreactesp_1_1_react_e_s_p.html#afa5876a2a33275dc7d0ba8214bb51ee7":[1,0,0,2,4], +"classreactesp_1_1_react_e_s_p.html#afa5876a2a33275dc7d0ba8214bb51ee7":[0,0,0,2,4], +"classreactesp_1_1_reaction.html":[1,0,0,3], +"classreactesp_1_1_reaction.html":[0,0,0,3], +"classreactesp_1_1_reaction.html#a4c90027a89d94464caa5bbd879e0a0b6":[1,0,0,3,1], +"classreactesp_1_1_reaction.html#a4c90027a89d94464caa5bbd879e0a0b6":[0,0,0,3,1], +"classreactesp_1_1_reaction.html#a5247229438081b450d9e5985d1371238":[0,0,0,3,4], +"classreactesp_1_1_reaction.html#a5247229438081b450d9e5985d1371238":[1,0,0,3,4], +"classreactesp_1_1_reaction.html#aae992e5175207c253af0529d0888272e":[0,0,0,3,2], +"classreactesp_1_1_reaction.html#aae992e5175207c253af0529d0888272e":[1,0,0,3,2], +"classreactesp_1_1_reaction.html#abc05ff856d46ceead9bb7e78368f386c":[1,0,0,3,0], +"classreactesp_1_1_reaction.html#abc05ff856d46ceead9bb7e78368f386c":[0,0,0,3,0], +"classreactesp_1_1_reaction.html#ad3d3f332d9552c27f6a00c907d8ca1bd":[1,0,0,3,3], +"classreactesp_1_1_reaction.html#ad3d3f332d9552c27f6a00c907d8ca1bd":[0,0,0,3,3], +"classreactesp_1_1_repeat_reaction.html":[1,0,0,4], +"classreactesp_1_1_repeat_reaction.html":[0,0,0,4], +"classreactesp_1_1_repeat_reaction.html#a55c79cf9f38829af00b2ea553596bbc4":[1,0,0,4,0], +"classreactesp_1_1_repeat_reaction.html#a55c79cf9f38829af00b2ea553596bbc4":[0,0,0,4,0], +"classreactesp_1_1_repeat_reaction.html#adcbabf4f8166101c34468565a72dbc6a":[1,0,0,4,2], +"classreactesp_1_1_repeat_reaction.html#adcbabf4f8166101c34468565a72dbc6a":[0,0,0,4,2], +"classreactesp_1_1_repeat_reaction.html#aebda92dd28d44efb915c62434913f2a7":[1,0,0,4,1], +"classreactesp_1_1_repeat_reaction.html#aebda92dd28d44efb915c62434913f2a7":[0,0,0,4,1], +"classreactesp_1_1_stream_reaction.html":[0,0,0,5], +"classreactesp_1_1_stream_reaction.html":[1,0,0,5], +"classreactesp_1_1_stream_reaction.html#a415ab42487fd4811fcbefc1dda8f125b":[0,0,0,5,0], +"classreactesp_1_1_stream_reaction.html#a415ab42487fd4811fcbefc1dda8f125b":[1,0,0,5,0], +"classreactesp_1_1_stream_reaction.html#aaacfadf2931a51f84fad46f8836f5407":[1,0,0,5,1], +"classreactesp_1_1_stream_reaction.html#aaacfadf2931a51f84fad46f8836f5407":[0,0,0,5,1], +"classreactesp_1_1_tick_reaction.html":[1,0,0,6], +"classreactesp_1_1_tick_reaction.html":[0,0,0,6], +"classreactesp_1_1_tick_reaction.html#a507fba43ad3fa7e7466654ad380ac65c":[1,0,0,6,1], +"classreactesp_1_1_tick_reaction.html#a507fba43ad3fa7e7466654ad380ac65c":[0,0,0,6,1], +"classreactesp_1_1_tick_reaction.html#adf4e60e642e2c268150ddc8232e5dad8":[0,0,0,6,0], +"classreactesp_1_1_tick_reaction.html#adf4e60e642e2c268150ddc8232e5dad8":[1,0,0,6,0], +"classreactesp_1_1_timed_reaction.html":[0,0,0,7], +"classreactesp_1_1_timed_reaction.html":[1,0,0,7], +"classreactesp_1_1_timed_reaction.html#a0f008c210ca872c62d01d2f8b71e1d7d":[1,0,0,7,2], +"classreactesp_1_1_timed_reaction.html#a0f008c210ca872c62d01d2f8b71e1d7d":[0,0,0,7,2], +"classreactesp_1_1_timed_reaction.html#a2494033d04540bf672ce91b080b0b8c6":[1,0,0,7,10], +"classreactesp_1_1_timed_reaction.html#a2494033d04540bf672ce91b080b0b8c6":[0,0,0,7,10], +"classreactesp_1_1_timed_reaction.html#a361492121a2ce2f76595886e6b93323f":[0,0,0,7,8], +"classreactesp_1_1_timed_reaction.html#a361492121a2ce2f76595886e6b93323f":[1,0,0,7,8], +"classreactesp_1_1_timed_reaction.html#a61a39ae3b7cf58657b69ad27bef4d6d5":[0,0,0,7,0], +"classreactesp_1_1_timed_reaction.html#a61a39ae3b7cf58657b69ad27bef4d6d5":[1,0,0,7,0], +"classreactesp_1_1_timed_reaction.html#a6243201b9a9ea88c7ddfc9b10441ffd8":[0,0,0,7,7], +"classreactesp_1_1_timed_reaction.html#a6243201b9a9ea88c7ddfc9b10441ffd8":[1,0,0,7,7], +"classreactesp_1_1_timed_reaction.html#aa32de4aadffb55da49678d662f9089de":[1,0,0,7,9], +"classreactesp_1_1_timed_reaction.html#aa32de4aadffb55da49678d662f9089de":[0,0,0,7,9], +"classreactesp_1_1_timed_reaction.html#aaa7dc721c043b0df6b1dee56bfc6ab3b":[0,0,0,7,4], +"classreactesp_1_1_timed_reaction.html#aaa7dc721c043b0df6b1dee56bfc6ab3b":[1,0,0,7,4], +"classreactesp_1_1_timed_reaction.html#ab53411bb9c37d8624b2d79d6cd6a73a9":[0,0,0,7,1], +"classreactesp_1_1_timed_reaction.html#ab53411bb9c37d8624b2d79d6cd6a73a9":[1,0,0,7,1], +"classreactesp_1_1_timed_reaction.html#ac8aa0c4d72900551791b4d276b5939a2":[0,0,0,7,6], +"classreactesp_1_1_timed_reaction.html#ac8aa0c4d72900551791b4d276b5939a2":[1,0,0,7,6], +"classreactesp_1_1_timed_reaction.html#ad139926f58b087f6e1f5fd86609190d3":[1,0,0,7,5], +"classreactesp_1_1_timed_reaction.html#ad139926f58b087f6e1f5fd86609190d3":[0,0,0,7,5], +"classreactesp_1_1_timed_reaction.html#ae6b490c9d7b56a41c24c011e13834772":[1,0,0,7,11], +"classreactesp_1_1_timed_reaction.html#ae6b490c9d7b56a41c24c011e13834772":[0,0,0,7,11], +"classreactesp_1_1_timed_reaction.html#ae8318817b65df5dee74911f863973063":[0,0,0,7,3], +"classreactesp_1_1_timed_reaction.html#ae8318817b65df5dee74911f863973063":[1,0,0,7,3], +"classreactesp_1_1_timed_reaction.html#aefccfe18abe4d6d83b2eae434be71e71":[1,0,0,7,12], +"classreactesp_1_1_timed_reaction.html#aefccfe18abe4d6d83b2eae434be71e71":[0,0,0,7,12], +"classreactesp_1_1_untimed_reaction.html":[1,0,0,9], +"classreactesp_1_1_untimed_reaction.html":[0,0,0,9], +"classreactesp_1_1_untimed_reaction.html#a64eae7e0443bd1146a8ad61730c79647":[1,0,0,9,3], +"classreactesp_1_1_untimed_reaction.html#a64eae7e0443bd1146a8ad61730c79647":[0,0,0,9,3], +"classreactesp_1_1_untimed_reaction.html#a69503862f7b8e8033a2f401c9152a283":[0,0,0,9,2], +"classreactesp_1_1_untimed_reaction.html#a69503862f7b8e8033a2f401c9152a283":[1,0,0,9,2], +"classreactesp_1_1_untimed_reaction.html#a806d843f7e6767bdab056f0eec241832":[1,0,0,9,1], +"classreactesp_1_1_untimed_reaction.html#a806d843f7e6767bdab056f0eec241832":[0,0,0,9,1], +"classreactesp_1_1_untimed_reaction.html#aa960a5b8adc44a1c8e0800b6e9a697f7":[0,0,0,9,4], +"classreactesp_1_1_untimed_reaction.html#aa960a5b8adc44a1c8e0800b6e9a697f7":[1,0,0,9,4], +"classreactesp_1_1_untimed_reaction.html#ad09151db8e445f748f4b84e2fe9472c6":[0,0,0,9,0], +"classreactesp_1_1_untimed_reaction.html#ad09151db8e445f748f4b84e2fe9472c6":[1,0,0,9,0], +"dir_68267d1309a1af8e8297ef4c3efbcdba.html":[2,0,0], +"files.html":[2,0], +"functions.html":[1,3,0], +"functions_func.html":[1,3,1], +"functions_rela.html":[1,3,3], +"functions_vars.html":[1,3,2], +"globals.html":[2,1,0], +"globals_defs.html":[2,1,3], +"globals_func.html":[2,1,1], +"globals_vars.html":[2,1,2], +"hierarchy.html":[1,2], "index.html":[], -"main_8cpp.html":[1,0,0,0], -"main_8cpp.html#a828c6621f8cb3fef163c4b1f0c7e56c5":[1,0,0,0,2], -"main_8cpp.html#aa6359e12c4743a5b1888ac194c199674":[1,0,0,0,1], -"main_8cpp.html#ab97230fdf86fd49a50dbcc8e44fdf9cc":[1,0,0,0,3], -"main_8cpp.html#ad64fdff6a92cd05ce2adf27c0adaf065":[1,0,0,0,0], -"main_8cpp_source.html":[1,0,0,0], +"main_8cpp.html":[2,0,0,0], +"main_8cpp.html#a34ad18456588200cc4dd40de41ba33f6":[2,0,0,0,3], +"main_8cpp.html#a34c3d0a01760642883ba48bceddc2712":[2,0,0,0,1], +"main_8cpp.html#a4077bef57f7b230360d3c9fd61abe7b7":[2,0,0,0,4], +"main_8cpp.html#a4e12b91752b35a5f3a628424fcd5d73b":[2,0,0,0,10], +"main_8cpp.html#a4fc01d736fe50cf5b977f755b675f11d":[2,0,0,0,7], +"main_8cpp.html#a58acc222e959363ee034cea9488ef627":[2,0,0,0,6], +"main_8cpp.html#a6a8cac11201c2aa688c56aa3d8ae4e60":[2,0,0,0,13], +"main_8cpp.html#a8b0ce963bacb63827eb79b51bc74a551":[2,0,0,0,11], +"main_8cpp.html#a9747497b4cd5b5c68c9ff49d3ded14a4":[2,0,0,0,14], +"main_8cpp.html#aa41a4d8986ed6c03bd6ad416ba134a4e":[2,0,0,0,8], +"main_8cpp.html#aaa2ffd80e6f851dc6bb43c95a2c7d26f":[2,0,0,0,12], +"main_8cpp.html#aabd20f4bed5cefc2278d071d9dafb01f":[2,0,0,0,9], +"main_8cpp.html#ab4553be4db9860d940f81d7447173b2f":[2,0,0,0,2], +"main_8cpp.html#af0a45111dfe499bdcb17708f49a57308":[2,0,0,0,0], +"main_8cpp.html#afe461d27b9c48d5921c00d521181f12f":[2,0,0,0,5], +"main_8cpp_source.html":[2,0,0,0], +"namespacemembers.html":[0,1,0], +"namespacemembers_type.html":[0,1,1], +"namespacereactesp.html":[0,0,0], +"namespacereactesp.html#a1dfbc20eb5c3efa2665acac404585b81":[0,0,0,11], +"namespacereactesp.html#a2b5792453cf14eaa49fd355ad1011482":[0,0,0,10], +"namespaces.html":[0,0], "pages.html":[], -"struct_trigger_time_compare.html":[0,0,8], -"struct_trigger_time_compare.html#a8c43f2a1e90a47ea77876a76522ced21":[0,0,8,0] +"structreactesp_1_1_trigger_time_compare.html":[0,0,0,8], +"structreactesp_1_1_trigger_time_compare.html":[1,0,0,8], +"structreactesp_1_1_trigger_time_compare.html#a55ebdf386aa363af20658b165e7460a6":[0,0,0,8,0], +"structreactesp_1_1_trigger_time_compare.html#a55ebdf386aa363af20658b165e7460a6":[1,0,0,8,0] }; diff --git a/docs/generated/docs/search/all_0.js b/docs/generated/docs/search/all_0.js index a4fb8c4..213fd0b 100644 --- a/docs/generated/docs/search/all_0.js +++ b/docs/generated/docs/search/all_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['add_0',['add',['../class_reaction.html#a349da2fef93c94095c264ead1f5ffcb8',1,'Reaction::add()'],['../class_timed_reaction.html#a163d0232141ebe0d446d853969766a69',1,'TimedReaction::add()'],['../class_untimed_reaction.html#aaf8d78a83d9c8174a2e069cb6279a793',1,'UntimedReaction::add()'],['../class_i_s_r_reaction.html#aba4a495b10cf265d41cbdb9790936072',1,'ISRReaction::add()']]], - ['app_1',['app',['../class_react_e_s_p.html#a0af13aed55f3b30703e027ff2d761774',1,'ReactESP::app()'],['../main_8cpp.html#a828c6621f8cb3fef163c4b1f0c7e56c5',1,'app(): main.cpp']]] + ['add_0',['add',['../classreactesp_1_1_reaction.html#a4c90027a89d94464caa5bbd879e0a0b6',1,'reactesp::Reaction::add()'],['../classreactesp_1_1_timed_reaction.html#ae8318817b65df5dee74911f863973063',1,'reactesp::TimedReaction::add()'],['../classreactesp_1_1_untimed_reaction.html#a69503862f7b8e8033a2f401c9152a283',1,'reactesp::UntimedReaction::add()'],['../classreactesp_1_1_i_s_r_reaction.html#ac7b7efd14de7cd96df315e761f962d4a',1,'reactesp::ISRReaction::add()']]], + ['app_1',['app',['../classreactesp_1_1_react_e_s_p.html#a69f6dd499c2f65613e82ea466ed88298',1,'reactesp::ReactESP::app()'],['../main_8cpp.html#aaa2ffd80e6f851dc6bb43c95a2c7d26f',1,'app(): main.cpp']]] ]; diff --git a/docs/generated/docs/search/all_1.js b/docs/generated/docs/search/all_1.js index 822b4d5..4e2083e 100644 --- a/docs/generated/docs/search/all_1.js +++ b/docs/generated/docs/search/all_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['callback_0',['callback',['../class_reaction.html#a13fdfc7eef62041f7394eac1f0b53978',1,'Reaction']]] + ['callback_0',['callback',['../classreactesp_1_1_reaction.html#a5247229438081b450d9e5985d1371238',1,'reactesp::Reaction']]] ]; diff --git a/docs/generated/docs/search/all_2.js b/docs/generated/docs/search/all_2.js index 22420d4..5efeb24 100644 --- a/docs/generated/docs/search/all_2.js +++ b/docs/generated/docs/search/all_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['delayreaction_0',['DelayReaction',['../class_delay_reaction.html',1,'DelayReaction'],['../class_delay_reaction.html#ab8cabba2391d4f4d836f4f060425ddb0',1,'DelayReaction::DelayReaction(const uint32_t delay, const react_callback callback)'],['../class_delay_reaction.html#a27b07f8afc197ac54b6192c411d7e50b',1,'DelayReaction::DelayReaction(const uint64_t delay, const react_callback callback)']]] + ['delayreaction_0',['DelayReaction',['../classreactesp_1_1_delay_reaction.html#aac5ab07009878644f0d9d1d5b2f7ce40',1,'reactesp::DelayReaction::DelayReaction(const uint32_t delay, const react_callback callback)'],['../classreactesp_1_1_delay_reaction.html#a6fbe0cd7f47fc81abdade25f09eed5f8',1,'reactesp::DelayReaction::DelayReaction(const uint64_t delay, const react_callback callback)'],['../classreactesp_1_1_delay_reaction.html',1,'reactesp::DelayReaction']]] ]; diff --git a/docs/generated/docs/search/all_3.js b/docs/generated/docs/search/all_3.js index 5f51b38..4f6183b 100644 --- a/docs/generated/docs/search/all_3.js +++ b/docs/generated/docs/search/all_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['enabled_0',['enabled',['../class_timed_reaction.html#ae4c582a52e93db97646f8fbb0bb1b909',1,'TimedReaction']]] + ['enabled_0',['enabled',['../classreactesp_1_1_timed_reaction.html#a2494033d04540bf672ce91b080b0b8c6',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/all_4.js b/docs/generated/docs/search/all_4.js index e081307..e2e6873 100644 --- a/docs/generated/docs/search/all_4.js +++ b/docs/generated/docs/search/all_4.js @@ -1,5 +1,5 @@ var searchData= [ - ['gettriggertime_0',['getTriggerTime',['../class_timed_reaction.html#ac419476db7b8b64c6b13ff62334a95ad',1,'TimedReaction']]], - ['gettriggertimemicros_1',['getTriggerTimeMicros',['../class_timed_reaction.html#a4ff15ba9b01cc69b045aac06b896404c',1,'TimedReaction']]] + ['gettriggertime_0',['getTriggerTime',['../classreactesp_1_1_timed_reaction.html#aaa7dc721c043b0df6b1dee56bfc6ab3b',1,'reactesp::TimedReaction']]], + ['gettriggertimemicros_1',['getTriggerTimeMicros',['../classreactesp_1_1_timed_reaction.html#ad139926f58b087f6e1f5fd86609190d3',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/all_5.js b/docs/generated/docs/search/all_5.js index eeeb30a..d95fc25 100644 --- a/docs/generated/docs/search/all_5.js +++ b/docs/generated/docs/search/all_5.js @@ -1,9 +1,9 @@ var searchData= [ - ['interval_0',['interval',['../class_timed_reaction.html#ad4a692b89c47ea51055534e8286532fa',1,'TimedReaction']]], - ['io_5frepeat_5fdelay_1',['IO_REPEAT_DELAY',['../main_8cpp.html#ad64fdff6a92cd05ce2adf27c0adaf065',1,'main.cpp']]], - ['isenabled_2',['isEnabled',['../class_timed_reaction.html#af42d731961b6abcd508b48f4e007ebcf',1,'TimedReaction']]], - ['isr_3',['isr',['../main_8cpp.html#aa6359e12c4743a5b1888ac194c199674',1,'main.cpp']]], - ['isr_5freact_5fcallback_4',['isr_react_callback',['../_react_e_s_p_8h.html#a67b5c9351881150cba489e7594e0c976',1,'ReactESP.h']]], - ['isrreaction_5',['ISRReaction',['../class_i_s_r_reaction.html',1,'ISRReaction'],['../class_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269',1,'ReactESP::ISRReaction()'],['../class_i_s_r_reaction.html#a675599c657aa6aae62a1bc08510edfe5',1,'ISRReaction::ISRReaction()']]] + ['input_5fpin1_0',['INPUT_PIN1',['../main_8cpp.html#af0a45111dfe499bdcb17708f49a57308',1,'main.cpp']]], + ['input_5fpin2_1',['INPUT_PIN2',['../main_8cpp.html#a34c3d0a01760642883ba48bceddc2712',1,'main.cpp']]], + ['interval_2',['interval',['../classreactesp_1_1_timed_reaction.html#ae6b490c9d7b56a41c24c011e13834772',1,'reactesp::TimedReaction']]], + ['isenabled_3',['isEnabled',['../classreactesp_1_1_timed_reaction.html#ac8aa0c4d72900551791b4d276b5939a2',1,'reactesp::TimedReaction']]], + ['isr_5freact_5fcallback_4',['isr_react_callback',['../namespacereactesp.html#a2b5792453cf14eaa49fd355ad1011482',1,'reactesp']]], + ['isrreaction_5',['ISRReaction',['../classreactesp_1_1_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269',1,'reactesp::ReactESP::ISRReaction()'],['../classreactesp_1_1_i_s_r_reaction.html#add1ee86128b01e211cac9126a8b485d3',1,'reactesp::ISRReaction::ISRReaction()'],['../classreactesp_1_1_i_s_r_reaction.html',1,'reactesp::ISRReaction']]] ]; diff --git a/docs/generated/docs/search/all_6.js b/docs/generated/docs/search/all_6.js index c06ff2b..ba37ba3 100644 --- a/docs/generated/docs/search/all_6.js +++ b/docs/generated/docs/search/all_6.js @@ -1,5 +1,6 @@ var searchData= [ - ['last_5ftrigger_5ftime_0',['last_trigger_time',['../class_timed_reaction.html#a403ac811efb47fc24aae688b83309540',1,'TimedReaction']]], - ['loop_1',['loop',['../_react_e_s_p_8cpp.html#a0b33edabd7f1c4e4a0bf32c67269be2f',1,'ReactESP.cpp']]] + ['last_5ftrigger_5ftime_0',['last_trigger_time',['../classreactesp_1_1_timed_reaction.html#aefccfe18abe4d6d83b2eae434be71e71',1,'reactesp::TimedReaction']]], + ['led_5fpin_1',['LED_PIN',['../main_8cpp.html#ab4553be4db9860d940f81d7447173b2f',1,'main.cpp']]], + ['loop_2',['loop',['../main_8cpp.html#afe461d27b9c48d5921c00d521181f12f',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/all_8.js b/docs/generated/docs/search/all_8.js index db04a62..647ccaf 100644 --- a/docs/generated/docs/search/all_8.js +++ b/docs/generated/docs/search/all_8.js @@ -1,12 +1,4 @@ var searchData= [ - ['onavailable_0',['onAvailable',['../class_react_e_s_p.html#a831c11dd7f1a6e15d70785c3a990df93',1,'ReactESP']]], - ['ondelay_1',['onDelay',['../class_react_e_s_p.html#ab26769ff3e426972e87746749560ffc0',1,'ReactESP']]], - ['ondelaymicros_2',['onDelayMicros',['../class_react_e_s_p.html#ad5739bf0fedb24931f98762113161e95',1,'ReactESP']]], - ['oninterrupt_3',['onInterrupt',['../class_react_e_s_p.html#a02ce0511803b0d3a1fcec6bc56ff8b3f',1,'ReactESP']]], - ['onrepeat_4',['onRepeat',['../class_react_e_s_p.html#adb20144bde6e60b41e484d2f6f61d0f5',1,'ReactESP']]], - ['onrepeatmicros_5',['onRepeatMicros',['../class_react_e_s_p.html#a2a7018e7a5e89634e8e4385be51eafd4',1,'ReactESP']]], - ['ontick_6',['onTick',['../class_react_e_s_p.html#a7da68d41f2a9790ab1aec2610bad07eb',1,'ReactESP']]], - ['operator_28_29_7',['operator()',['../struct_trigger_time_compare.html#a8c43f2a1e90a47ea77876a76522ced21',1,'TriggerTimeCompare']]], - ['operator_3c_8',['operator<',['../class_timed_reaction.html#a431489308733484afc1f3b6b80289be1',1,'TimedReaction']]] + ['num_5ftimers_0',['NUM_TIMERS',['../main_8cpp.html#a34ad18456588200cc4dd40de41ba33f6',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/all_9.js b/docs/generated/docs/search/all_9.js index f2102c4..2dd94f5 100644 --- a/docs/generated/docs/search/all_9.js +++ b/docs/generated/docs/search/all_9.js @@ -1,10 +1,13 @@ var searchData= [ - ['react_5fcallback_0',['react_callback',['../_react_e_s_p_8h.html#aced18b35574cdf9238eeb6d2c997db7f',1,'ReactESP.h']]], - ['reactesp_1',['ReactESP',['../class_react_e_s_p.html',1,'ReactESP'],['../class_react_e_s_p.html#a5dafe71a8c9c2834c5c34cc86b820c9a',1,'ReactESP::ReactESP()']]], - ['reactesp_2ecpp_2',['ReactESP.cpp',['../_react_e_s_p_8cpp.html',1,'']]], - ['reactesp_2eh_3',['ReactESP.h',['../_react_e_s_p_8h.html',1,'']]], - ['reaction_4',['Reaction',['../class_reaction.html',1,'Reaction'],['../class_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51',1,'ReactESP::Reaction()'],['../class_reaction.html#aea66093d451e22677190c38176b9fe40',1,'Reaction::Reaction(react_callback callback)']]], - ['remove_5',['remove',['../class_reaction.html#af88faf9664340633d6cc5f913ab4e105',1,'Reaction::remove()'],['../class_timed_reaction.html#acac370ae042f0561beecf528551ccad9',1,'TimedReaction::remove()'],['../class_untimed_reaction.html#a52cdd4974e63425e6db056a50c9a51d6',1,'UntimedReaction::remove()'],['../class_i_s_r_reaction.html#a6470d8b82a5066562ad9a2e169ea19b8',1,'ISRReaction::remove()']]], - ['repeatreaction_6',['RepeatReaction',['../class_repeat_reaction.html',1,'RepeatReaction'],['../class_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348',1,'ReactESP::RepeatReaction()'],['../class_repeat_reaction.html#a68c6ea9ade842d93ef967d977937f683',1,'RepeatReaction::RepeatReaction(const uint32_t interval, const react_callback callback)'],['../class_repeat_reaction.html#a5b53f55d5b252708eb2348c4c3a55868',1,'RepeatReaction::RepeatReaction(const uint64_t interval, const react_callback callback)']]] + ['onavailable_0',['onAvailable',['../classreactesp_1_1_react_e_s_p.html#a42c88fbcd1f1ab9842517056448de6b5',1,'reactesp::ReactESP']]], + ['ondelay_1',['onDelay',['../classreactesp_1_1_react_e_s_p.html#a5b25d026d1f26fb80b2c6659f3875fd8',1,'reactesp::ReactESP']]], + ['ondelaymicros_2',['onDelayMicros',['../classreactesp_1_1_react_e_s_p.html#a4f51c39bd90492f6184872f6d91f14dd',1,'reactesp::ReactESP']]], + ['oninterrupt_3',['onInterrupt',['../classreactesp_1_1_react_e_s_p.html#afa5876a2a33275dc7d0ba8214bb51ee7',1,'reactesp::ReactESP']]], + ['onrepeat_4',['onRepeat',['../classreactesp_1_1_react_e_s_p.html#a914de417d6b11c6111df8bba25d5ed75',1,'reactesp::ReactESP']]], + ['onrepeatmicros_5',['onRepeatMicros',['../classreactesp_1_1_react_e_s_p.html#ad15637cf3778be71a156845bd069506a',1,'reactesp::ReactESP']]], + ['ontick_6',['onTick',['../classreactesp_1_1_react_e_s_p.html#ae442c7e1e8084f46a900646957f1f9c8',1,'reactesp::ReactESP']]], + ['operator_28_29_7',['operator()',['../structreactesp_1_1_trigger_time_compare.html#a55ebdf386aa363af20658b165e7460a6',1,'reactesp::TriggerTimeCompare']]], + ['operator_3c_8',['operator<',['../classreactesp_1_1_timed_reaction.html#a6243201b9a9ea88c7ddfc9b10441ffd8',1,'reactesp::TimedReaction']]], + ['out_5fpin_9',['OUT_PIN',['../main_8cpp.html#a4077bef57f7b230360d3c9fd61abe7b7',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/all_a.js b/docs/generated/docs/search/all_a.js index dcade30..8175a4f 100644 --- a/docs/generated/docs/search/all_a.js +++ b/docs/generated/docs/search/all_a.js @@ -1,5 +1,12 @@ var searchData= [ - ['setup_0',['setup',['../class_react_e_s_p.html#aa26556a0954d117dc5b8d925e5924cdf',1,'ReactESP::setup()'],['../_react_e_s_p_8cpp.html#a7dfd9b79bc5a37d7df40207afbc5431f',1,'setup(void): ReactESP.cpp']]], - ['streamreaction_1',['StreamReaction',['../class_stream_reaction.html',1,'StreamReaction'],['../class_stream_reaction.html#a902a27a4c687e6eac1255c4fad74bf17',1,'StreamReaction::StreamReaction()']]] + ['react_5fcallback_0',['react_callback',['../namespacereactesp.html#a1dfbc20eb5c3efa2665acac404585b81',1,'reactesp']]], + ['reactesp_1',['reactesp',['../namespacereactesp.html',1,'']]], + ['reactesp_2',['ReactESP',['../classreactesp_1_1_react_e_s_p.html#ab60d32aea4a5c8040d9fb46797ebd63e',1,'reactesp::ReactESP::ReactESP()'],['../classreactesp_1_1_react_e_s_p.html',1,'reactesp::ReactESP']]], + ['reactesp_2ecpp_3',['ReactESP.cpp',['../_react_e_s_p_8cpp.html',1,'']]], + ['reactesp_2eh_4',['ReactESP.h',['../_react_e_s_p_8h.html',1,'']]], + ['reaction_5',['Reaction',['../classreactesp_1_1_reaction.html',1,'reactesp::Reaction'],['../classreactesp_1_1_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51',1,'reactesp::ReactESP::Reaction()'],['../classreactesp_1_1_reaction.html#abc05ff856d46ceead9bb7e78368f386c',1,'reactesp::Reaction::Reaction(react_callback callback)']]], + ['remove_6',['remove',['../classreactesp_1_1_reaction.html#aae992e5175207c253af0529d0888272e',1,'reactesp::Reaction::remove()'],['../classreactesp_1_1_timed_reaction.html#a361492121a2ce2f76595886e6b93323f',1,'reactesp::TimedReaction::remove()'],['../classreactesp_1_1_untimed_reaction.html#a64eae7e0443bd1146a8ad61730c79647',1,'reactesp::UntimedReaction::remove()'],['../classreactesp_1_1_i_s_r_reaction.html#a9ccf4abc748379340fb0e97b77c3bc4d',1,'reactesp::ISRReaction::remove()']]], + ['repeatreaction_7',['RepeatReaction',['../classreactesp_1_1_repeat_reaction.html',1,'reactesp::RepeatReaction'],['../classreactesp_1_1_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348',1,'reactesp::ReactESP::RepeatReaction()'],['../classreactesp_1_1_repeat_reaction.html#a55c79cf9f38829af00b2ea553596bbc4',1,'reactesp::RepeatReaction::RepeatReaction(const uint32_t interval, const react_callback callback)'],['../classreactesp_1_1_repeat_reaction.html#aebda92dd28d44efb915c62434913f2a7',1,'reactesp::RepeatReaction::RepeatReaction(const uint64_t interval, const react_callback callback)']]], + ['reporter_8',['reporter',['../main_8cpp.html#a58acc222e959363ee034cea9488ef627',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/all_b.js b/docs/generated/docs/search/all_b.js index 0c662c3..7e659dc 100644 --- a/docs/generated/docs/search/all_b.js +++ b/docs/generated/docs/search/all_b.js @@ -1,8 +1,9 @@ var searchData= [ - ['tick_0',['tick',['../class_reaction.html#a24cc0bd38eea8c50dd6718bb7a1c8051',1,'Reaction::tick()'],['../class_timed_reaction.html#a56eb9a737b11089358d34cc347f9fc7a',1,'TimedReaction::tick()'],['../class_delay_reaction.html#af2a85d71205ad1cbf5f6471f17e91a6f',1,'DelayReaction::tick()'],['../class_repeat_reaction.html#a2c05598c7a03d60ec1088db1da5d851d',1,'RepeatReaction::tick()'],['../class_untimed_reaction.html#a803aa29ba1f5d9f0312d71e09ee83f15',1,'UntimedReaction::tick()'],['../class_stream_reaction.html#aa874d5cc82b5392075da1262e318a703',1,'StreamReaction::tick()'],['../class_tick_reaction.html#aa4e6419363cef721057c990111542b93',1,'TickReaction::tick()'],['../class_i_s_r_reaction.html#aab332af06426b145d73c1b46b4d7c3fd',1,'ISRReaction::tick()'],['../class_react_e_s_p.html#aeefac464d9df930d020a321a63cdcf4b',1,'ReactESP::tick()']]], - ['tickreaction_1',['TickReaction',['../class_tick_reaction.html',1,'TickReaction'],['../class_tick_reaction.html#a0928c0693f10acec61157027dd4658fe',1,'TickReaction::TickReaction()']]], - ['ticks_2',['ticks',['../main_8cpp.html#ab97230fdf86fd49a50dbcc8e44fdf9cc',1,'main.cpp']]], - ['timedreaction_3',['TimedReaction',['../class_timed_reaction.html',1,'TimedReaction'],['../class_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d',1,'ReactESP::TimedReaction()'],['../class_timed_reaction.html#af1653cd9ff0b545e95baec51cde2743c',1,'TimedReaction::TimedReaction(const uint32_t interval, const react_callback callback)'],['../class_timed_reaction.html#a4a775a7624ba511ae80016e14b8d88f5',1,'TimedReaction::TimedReaction(const uint64_t interval, const react_callback callback)']]], - ['triggertimecompare_4',['TriggerTimeCompare',['../struct_trigger_time_compare.html',1,'']]] + ['setup_0',['setup',['../main_8cpp.html#a4fc01d736fe50cf5b977f755b675f11d',1,'main.cpp']]], + ['setup_5fio_5fpins_1',['setup_io_pins',['../main_8cpp.html#aa41a4d8986ed6c03bd6ad416ba134a4e',1,'main.cpp']]], + ['setup_5fserial_2',['setup_serial',['../main_8cpp.html#aabd20f4bed5cefc2278d071d9dafb01f',1,'main.cpp']]], + ['setup_5ftick_3',['setup_tick',['../main_8cpp.html#a4e12b91752b35a5f3a628424fcd5d73b',1,'main.cpp']]], + ['setup_5ftimers_4',['setup_timers',['../main_8cpp.html#a8b0ce963bacb63827eb79b51bc74a551',1,'main.cpp']]], + ['streamreaction_5',['StreamReaction',['../classreactesp_1_1_stream_reaction.html',1,'reactesp::StreamReaction'],['../classreactesp_1_1_stream_reaction.html#a415ab42487fd4811fcbefc1dda8f125b',1,'reactesp::StreamReaction::StreamReaction()']]] ]; diff --git a/docs/generated/docs/search/all_c.js b/docs/generated/docs/search/all_c.js index f57020b..8c92ae3 100644 --- a/docs/generated/docs/search/all_c.js +++ b/docs/generated/docs/search/all_c.js @@ -1,4 +1,9 @@ var searchData= [ - ['untimedreaction_0',['UntimedReaction',['../class_untimed_reaction.html',1,'UntimedReaction'],['../class_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad',1,'ReactESP::UntimedReaction()'],['../class_untimed_reaction.html#a1e33cb5f40db3c477f0a476d63999770',1,'UntimedReaction::UntimedReaction()']]] + ['tick_0',['tick',['../classreactesp_1_1_reaction.html#ad3d3f332d9552c27f6a00c907d8ca1bd',1,'reactesp::Reaction::tick()'],['../classreactesp_1_1_timed_reaction.html#aa32de4aadffb55da49678d662f9089de',1,'reactesp::TimedReaction::tick()'],['../classreactesp_1_1_delay_reaction.html#ad7f7bab48635897fec696b139d59c134',1,'reactesp::DelayReaction::tick()'],['../classreactesp_1_1_repeat_reaction.html#adcbabf4f8166101c34468565a72dbc6a',1,'reactesp::RepeatReaction::tick()'],['../classreactesp_1_1_untimed_reaction.html#aa960a5b8adc44a1c8e0800b6e9a697f7',1,'reactesp::UntimedReaction::tick()'],['../classreactesp_1_1_stream_reaction.html#aaacfadf2931a51f84fad46f8836f5407',1,'reactesp::StreamReaction::tick()'],['../classreactesp_1_1_tick_reaction.html#a507fba43ad3fa7e7466654ad380ac65c',1,'reactesp::TickReaction::tick()'],['../classreactesp_1_1_i_s_r_reaction.html#aa8a31d433ff7e8a112afd9461e5da479',1,'reactesp::ISRReaction::tick()'],['../classreactesp_1_1_react_e_s_p.html#a683d99a3ed39a75337f01888c2240df0',1,'reactesp::ReactESP::tick()']]], + ['tick_5fcounter_1',['tick_counter',['../main_8cpp.html#a6a8cac11201c2aa688c56aa3d8ae4e60',1,'main.cpp']]], + ['tickreaction_2',['TickReaction',['../classreactesp_1_1_tick_reaction.html',1,'reactesp::TickReaction'],['../classreactesp_1_1_tick_reaction.html#adf4e60e642e2c268150ddc8232e5dad8',1,'reactesp::TickReaction::TickReaction()']]], + ['timedreaction_3',['TimedReaction',['../classreactesp_1_1_timed_reaction.html',1,'reactesp::TimedReaction'],['../classreactesp_1_1_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d',1,'reactesp::ReactESP::TimedReaction()'],['../classreactesp_1_1_timed_reaction.html#a61a39ae3b7cf58657b69ad27bef4d6d5',1,'reactesp::TimedReaction::TimedReaction(const uint32_t interval, const react_callback callback)'],['../classreactesp_1_1_timed_reaction.html#ab53411bb9c37d8624b2d79d6cd6a73a9',1,'reactesp::TimedReaction::TimedReaction(const uint64_t interval, const react_callback callback)']]], + ['timer_5fticks_4',['timer_ticks',['../main_8cpp.html#a9747497b4cd5b5c68c9ff49d3ded14a4',1,'main.cpp']]], + ['triggertimecompare_5',['TriggerTimeCompare',['../structreactesp_1_1_trigger_time_compare.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/all_d.js b/docs/generated/docs/search/all_d.js index c2d103d..a7b55a4 100644 --- a/docs/generated/docs/search/all_d.js +++ b/docs/generated/docs/search/all_d.js @@ -1,7 +1,4 @@ var searchData= [ - ['_7edelayreaction_0',['~DelayReaction',['../class_delay_reaction.html#a50777489f0975d07a81c39c0638d1a7e',1,'DelayReaction']]], - ['_7eisrreaction_1',['~ISRReaction',['../class_i_s_r_reaction.html#adca866ff1b4dd48450ab0076707221bd',1,'ISRReaction']]], - ['_7etimedreaction_2',['~TimedReaction',['../class_timed_reaction.html#a2f26edad67264a6c4f4da7d7ebfbb661',1,'TimedReaction']]], - ['_7euntimedreaction_3',['~UntimedReaction',['../class_untimed_reaction.html#acd2ff1b448599949c3ad1d2e80b23507',1,'UntimedReaction']]] + ['untimedreaction_0',['UntimedReaction',['../classreactesp_1_1_untimed_reaction.html',1,'reactesp::UntimedReaction'],['../classreactesp_1_1_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad',1,'reactesp::ReactESP::UntimedReaction()'],['../classreactesp_1_1_untimed_reaction.html#ad09151db8e445f748f4b84e2fe9472c6',1,'reactesp::UntimedReaction::UntimedReaction()']]] ]; diff --git a/docs/generated/docs/search/all_e.html b/docs/generated/docs/search/all_e.html new file mode 100644 index 0000000..c1f4e6e --- /dev/null +++ b/docs/generated/docs/search/all_e.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/generated/docs/search/all_e.js b/docs/generated/docs/search/all_e.js new file mode 100644 index 0000000..541972d --- /dev/null +++ b/docs/generated/docs/search/all_e.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['_7edelayreaction_0',['~DelayReaction',['../classreactesp_1_1_delay_reaction.html#af1fbdbee6c0c032d5acab763d315a34d',1,'reactesp::DelayReaction']]], + ['_7eisrreaction_1',['~ISRReaction',['../classreactesp_1_1_i_s_r_reaction.html#a850a9346562861c44a9bc3a20e13ba1f',1,'reactesp::ISRReaction']]], + ['_7etimedreaction_2',['~TimedReaction',['../classreactesp_1_1_timed_reaction.html#a0f008c210ca872c62d01d2f8b71e1d7d',1,'reactesp::TimedReaction']]], + ['_7euntimedreaction_3',['~UntimedReaction',['../classreactesp_1_1_untimed_reaction.html#a806d843f7e6767bdab056f0eec241832',1,'reactesp::UntimedReaction']]] +]; diff --git a/docs/generated/docs/search/classes_0.js b/docs/generated/docs/search/classes_0.js index fca8bc0..b1efc55 100644 --- a/docs/generated/docs/search/classes_0.js +++ b/docs/generated/docs/search/classes_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['delayreaction_0',['DelayReaction',['../class_delay_reaction.html',1,'']]] + ['delayreaction_0',['DelayReaction',['../classreactesp_1_1_delay_reaction.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/classes_1.js b/docs/generated/docs/search/classes_1.js index c1b8f39..134c9c7 100644 --- a/docs/generated/docs/search/classes_1.js +++ b/docs/generated/docs/search/classes_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['isrreaction_0',['ISRReaction',['../class_i_s_r_reaction.html',1,'']]] + ['isrreaction_0',['ISRReaction',['../classreactesp_1_1_i_s_r_reaction.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/classes_2.js b/docs/generated/docs/search/classes_2.js index 6e11e6b..0ad084a 100644 --- a/docs/generated/docs/search/classes_2.js +++ b/docs/generated/docs/search/classes_2.js @@ -1,6 +1,6 @@ var searchData= [ - ['reactesp_0',['ReactESP',['../class_react_e_s_p.html',1,'']]], - ['reaction_1',['Reaction',['../class_reaction.html',1,'']]], - ['repeatreaction_2',['RepeatReaction',['../class_repeat_reaction.html',1,'']]] + ['reactesp_0',['ReactESP',['../classreactesp_1_1_react_e_s_p.html',1,'reactesp']]], + ['reaction_1',['Reaction',['../classreactesp_1_1_reaction.html',1,'reactesp']]], + ['repeatreaction_2',['RepeatReaction',['../classreactesp_1_1_repeat_reaction.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/classes_3.js b/docs/generated/docs/search/classes_3.js index 3970ec8..73f893e 100644 --- a/docs/generated/docs/search/classes_3.js +++ b/docs/generated/docs/search/classes_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['streamreaction_0',['StreamReaction',['../class_stream_reaction.html',1,'']]] + ['streamreaction_0',['StreamReaction',['../classreactesp_1_1_stream_reaction.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/classes_4.js b/docs/generated/docs/search/classes_4.js index 27e9c1a..10f33b0 100644 --- a/docs/generated/docs/search/classes_4.js +++ b/docs/generated/docs/search/classes_4.js @@ -1,6 +1,6 @@ var searchData= [ - ['tickreaction_0',['TickReaction',['../class_tick_reaction.html',1,'']]], - ['timedreaction_1',['TimedReaction',['../class_timed_reaction.html',1,'']]], - ['triggertimecompare_2',['TriggerTimeCompare',['../struct_trigger_time_compare.html',1,'']]] + ['tickreaction_0',['TickReaction',['../classreactesp_1_1_tick_reaction.html',1,'reactesp']]], + ['timedreaction_1',['TimedReaction',['../classreactesp_1_1_timed_reaction.html',1,'reactesp']]], + ['triggertimecompare_2',['TriggerTimeCompare',['../structreactesp_1_1_trigger_time_compare.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/classes_5.js b/docs/generated/docs/search/classes_5.js index 8b45f1a..4d56175 100644 --- a/docs/generated/docs/search/classes_5.js +++ b/docs/generated/docs/search/classes_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['untimedreaction_0',['UntimedReaction',['../class_untimed_reaction.html',1,'']]] + ['untimedreaction_0',['UntimedReaction',['../classreactesp_1_1_untimed_reaction.html',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/defines_0.js b/docs/generated/docs/search/defines_0.js index 5945836..84b076c 100644 --- a/docs/generated/docs/search/defines_0.js +++ b/docs/generated/docs/search/defines_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['io_5frepeat_5fdelay_0',['IO_REPEAT_DELAY',['../main_8cpp.html#ad64fdff6a92cd05ce2adf27c0adaf065',1,'main.cpp']]] + ['input_5fpin1_0',['INPUT_PIN1',['../main_8cpp.html#af0a45111dfe499bdcb17708f49a57308',1,'main.cpp']]], + ['input_5fpin2_1',['INPUT_PIN2',['../main_8cpp.html#a34c3d0a01760642883ba48bceddc2712',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/defines_1.html b/docs/generated/docs/search/defines_1.html new file mode 100644 index 0000000..4cd8fbb --- /dev/null +++ b/docs/generated/docs/search/defines_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/generated/docs/search/defines_1.js b/docs/generated/docs/search/defines_1.js new file mode 100644 index 0000000..33a81e5 --- /dev/null +++ b/docs/generated/docs/search/defines_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['led_5fpin_0',['LED_PIN',['../main_8cpp.html#ab4553be4db9860d940f81d7447173b2f',1,'main.cpp']]] +]; diff --git a/docs/generated/docs/search/defines_2.html b/docs/generated/docs/search/defines_2.html new file mode 100644 index 0000000..3c91913 --- /dev/null +++ b/docs/generated/docs/search/defines_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/generated/docs/search/defines_2.js b/docs/generated/docs/search/defines_2.js new file mode 100644 index 0000000..647ccaf --- /dev/null +++ b/docs/generated/docs/search/defines_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['num_5ftimers_0',['NUM_TIMERS',['../main_8cpp.html#a34ad18456588200cc4dd40de41ba33f6',1,'main.cpp']]] +]; diff --git a/docs/generated/docs/search/defines_3.html b/docs/generated/docs/search/defines_3.html new file mode 100644 index 0000000..edf5137 --- /dev/null +++ b/docs/generated/docs/search/defines_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/generated/docs/search/defines_3.js b/docs/generated/docs/search/defines_3.js new file mode 100644 index 0000000..07b68dc --- /dev/null +++ b/docs/generated/docs/search/defines_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['out_5fpin_0',['OUT_PIN',['../main_8cpp.html#a4077bef57f7b230360d3c9fd61abe7b7',1,'main.cpp']]] +]; diff --git a/docs/generated/docs/search/functions_0.js b/docs/generated/docs/search/functions_0.js index 39dfa90..c5db3ae 100644 --- a/docs/generated/docs/search/functions_0.js +++ b/docs/generated/docs/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['add_0',['add',['../class_reaction.html#a349da2fef93c94095c264ead1f5ffcb8',1,'Reaction::add()'],['../class_timed_reaction.html#a163d0232141ebe0d446d853969766a69',1,'TimedReaction::add()'],['../class_untimed_reaction.html#aaf8d78a83d9c8174a2e069cb6279a793',1,'UntimedReaction::add()'],['../class_i_s_r_reaction.html#aba4a495b10cf265d41cbdb9790936072',1,'ISRReaction::add()']]] + ['add_0',['add',['../classreactesp_1_1_reaction.html#a4c90027a89d94464caa5bbd879e0a0b6',1,'reactesp::Reaction::add()'],['../classreactesp_1_1_timed_reaction.html#ae8318817b65df5dee74911f863973063',1,'reactesp::TimedReaction::add()'],['../classreactesp_1_1_untimed_reaction.html#a69503862f7b8e8033a2f401c9152a283',1,'reactesp::UntimedReaction::add()'],['../classreactesp_1_1_i_s_r_reaction.html#ac7b7efd14de7cd96df315e761f962d4a',1,'reactesp::ISRReaction::add()']]] ]; diff --git a/docs/generated/docs/search/functions_1.js b/docs/generated/docs/search/functions_1.js index 1bd37c6..7733216 100644 --- a/docs/generated/docs/search/functions_1.js +++ b/docs/generated/docs/search/functions_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['delayreaction_0',['DelayReaction',['../class_delay_reaction.html#ab8cabba2391d4f4d836f4f060425ddb0',1,'DelayReaction::DelayReaction(const uint32_t delay, const react_callback callback)'],['../class_delay_reaction.html#a27b07f8afc197ac54b6192c411d7e50b',1,'DelayReaction::DelayReaction(const uint64_t delay, const react_callback callback)']]] + ['delayreaction_0',['DelayReaction',['../classreactesp_1_1_delay_reaction.html#aac5ab07009878644f0d9d1d5b2f7ce40',1,'reactesp::DelayReaction::DelayReaction(const uint32_t delay, const react_callback callback)'],['../classreactesp_1_1_delay_reaction.html#a6fbe0cd7f47fc81abdade25f09eed5f8',1,'reactesp::DelayReaction::DelayReaction(const uint64_t delay, const react_callback callback)']]] ]; diff --git a/docs/generated/docs/search/functions_2.js b/docs/generated/docs/search/functions_2.js index e081307..e2e6873 100644 --- a/docs/generated/docs/search/functions_2.js +++ b/docs/generated/docs/search/functions_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['gettriggertime_0',['getTriggerTime',['../class_timed_reaction.html#ac419476db7b8b64c6b13ff62334a95ad',1,'TimedReaction']]], - ['gettriggertimemicros_1',['getTriggerTimeMicros',['../class_timed_reaction.html#a4ff15ba9b01cc69b045aac06b896404c',1,'TimedReaction']]] + ['gettriggertime_0',['getTriggerTime',['../classreactesp_1_1_timed_reaction.html#aaa7dc721c043b0df6b1dee56bfc6ab3b',1,'reactesp::TimedReaction']]], + ['gettriggertimemicros_1',['getTriggerTimeMicros',['../classreactesp_1_1_timed_reaction.html#ad139926f58b087f6e1f5fd86609190d3',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/functions_3.js b/docs/generated/docs/search/functions_3.js index 7197064..eb64236 100644 --- a/docs/generated/docs/search/functions_3.js +++ b/docs/generated/docs/search/functions_3.js @@ -1,6 +1,5 @@ var searchData= [ - ['isenabled_0',['isEnabled',['../class_timed_reaction.html#af42d731961b6abcd508b48f4e007ebcf',1,'TimedReaction']]], - ['isr_1',['isr',['../main_8cpp.html#aa6359e12c4743a5b1888ac194c199674',1,'main.cpp']]], - ['isrreaction_2',['ISRReaction',['../class_i_s_r_reaction.html#a675599c657aa6aae62a1bc08510edfe5',1,'ISRReaction']]] + ['isenabled_0',['isEnabled',['../classreactesp_1_1_timed_reaction.html#ac8aa0c4d72900551791b4d276b5939a2',1,'reactesp::TimedReaction']]], + ['isrreaction_1',['ISRReaction',['../classreactesp_1_1_i_s_r_reaction.html#add1ee86128b01e211cac9126a8b485d3',1,'reactesp::ISRReaction']]] ]; diff --git a/docs/generated/docs/search/functions_4.js b/docs/generated/docs/search/functions_4.js index 279904e..a51e7c6 100644 --- a/docs/generated/docs/search/functions_4.js +++ b/docs/generated/docs/search/functions_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['loop_0',['loop',['../_react_e_s_p_8cpp.html#a0b33edabd7f1c4e4a0bf32c67269be2f',1,'ReactESP.cpp']]] + ['loop_0',['loop',['../main_8cpp.html#afe461d27b9c48d5921c00d521181f12f',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/functions_5.js b/docs/generated/docs/search/functions_5.js index db04a62..f8a5246 100644 --- a/docs/generated/docs/search/functions_5.js +++ b/docs/generated/docs/search/functions_5.js @@ -1,12 +1,12 @@ var searchData= [ - ['onavailable_0',['onAvailable',['../class_react_e_s_p.html#a831c11dd7f1a6e15d70785c3a990df93',1,'ReactESP']]], - ['ondelay_1',['onDelay',['../class_react_e_s_p.html#ab26769ff3e426972e87746749560ffc0',1,'ReactESP']]], - ['ondelaymicros_2',['onDelayMicros',['../class_react_e_s_p.html#ad5739bf0fedb24931f98762113161e95',1,'ReactESP']]], - ['oninterrupt_3',['onInterrupt',['../class_react_e_s_p.html#a02ce0511803b0d3a1fcec6bc56ff8b3f',1,'ReactESP']]], - ['onrepeat_4',['onRepeat',['../class_react_e_s_p.html#adb20144bde6e60b41e484d2f6f61d0f5',1,'ReactESP']]], - ['onrepeatmicros_5',['onRepeatMicros',['../class_react_e_s_p.html#a2a7018e7a5e89634e8e4385be51eafd4',1,'ReactESP']]], - ['ontick_6',['onTick',['../class_react_e_s_p.html#a7da68d41f2a9790ab1aec2610bad07eb',1,'ReactESP']]], - ['operator_28_29_7',['operator()',['../struct_trigger_time_compare.html#a8c43f2a1e90a47ea77876a76522ced21',1,'TriggerTimeCompare']]], - ['operator_3c_8',['operator<',['../class_timed_reaction.html#a431489308733484afc1f3b6b80289be1',1,'TimedReaction']]] + ['onavailable_0',['onAvailable',['../classreactesp_1_1_react_e_s_p.html#a42c88fbcd1f1ab9842517056448de6b5',1,'reactesp::ReactESP']]], + ['ondelay_1',['onDelay',['../classreactesp_1_1_react_e_s_p.html#a5b25d026d1f26fb80b2c6659f3875fd8',1,'reactesp::ReactESP']]], + ['ondelaymicros_2',['onDelayMicros',['../classreactesp_1_1_react_e_s_p.html#a4f51c39bd90492f6184872f6d91f14dd',1,'reactesp::ReactESP']]], + ['oninterrupt_3',['onInterrupt',['../classreactesp_1_1_react_e_s_p.html#afa5876a2a33275dc7d0ba8214bb51ee7',1,'reactesp::ReactESP']]], + ['onrepeat_4',['onRepeat',['../classreactesp_1_1_react_e_s_p.html#a914de417d6b11c6111df8bba25d5ed75',1,'reactesp::ReactESP']]], + ['onrepeatmicros_5',['onRepeatMicros',['../classreactesp_1_1_react_e_s_p.html#ad15637cf3778be71a156845bd069506a',1,'reactesp::ReactESP']]], + ['ontick_6',['onTick',['../classreactesp_1_1_react_e_s_p.html#ae442c7e1e8084f46a900646957f1f9c8',1,'reactesp::ReactESP']]], + ['operator_28_29_7',['operator()',['../structreactesp_1_1_trigger_time_compare.html#a55ebdf386aa363af20658b165e7460a6',1,'reactesp::TriggerTimeCompare']]], + ['operator_3c_8',['operator<',['../classreactesp_1_1_timed_reaction.html#a6243201b9a9ea88c7ddfc9b10441ffd8',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/functions_6.js b/docs/generated/docs/search/functions_6.js index d62357e..8ee68af 100644 --- a/docs/generated/docs/search/functions_6.js +++ b/docs/generated/docs/search/functions_6.js @@ -1,7 +1,8 @@ var searchData= [ - ['reactesp_0',['ReactESP',['../class_react_e_s_p.html#a5dafe71a8c9c2834c5c34cc86b820c9a',1,'ReactESP']]], - ['reaction_1',['Reaction',['../class_reaction.html#aea66093d451e22677190c38176b9fe40',1,'Reaction']]], - ['remove_2',['remove',['../class_reaction.html#af88faf9664340633d6cc5f913ab4e105',1,'Reaction::remove()'],['../class_timed_reaction.html#acac370ae042f0561beecf528551ccad9',1,'TimedReaction::remove()'],['../class_untimed_reaction.html#a52cdd4974e63425e6db056a50c9a51d6',1,'UntimedReaction::remove()'],['../class_i_s_r_reaction.html#a6470d8b82a5066562ad9a2e169ea19b8',1,'ISRReaction::remove()']]], - ['repeatreaction_3',['RepeatReaction',['../class_repeat_reaction.html#a68c6ea9ade842d93ef967d977937f683',1,'RepeatReaction::RepeatReaction(const uint32_t interval, const react_callback callback)'],['../class_repeat_reaction.html#a5b53f55d5b252708eb2348c4c3a55868',1,'RepeatReaction::RepeatReaction(const uint64_t interval, const react_callback callback)']]] + ['reactesp_0',['ReactESP',['../classreactesp_1_1_react_e_s_p.html#ab60d32aea4a5c8040d9fb46797ebd63e',1,'reactesp::ReactESP']]], + ['reaction_1',['Reaction',['../classreactesp_1_1_reaction.html#abc05ff856d46ceead9bb7e78368f386c',1,'reactesp::Reaction']]], + ['remove_2',['remove',['../classreactesp_1_1_reaction.html#aae992e5175207c253af0529d0888272e',1,'reactesp::Reaction::remove()'],['../classreactesp_1_1_timed_reaction.html#a361492121a2ce2f76595886e6b93323f',1,'reactesp::TimedReaction::remove()'],['../classreactesp_1_1_untimed_reaction.html#a64eae7e0443bd1146a8ad61730c79647',1,'reactesp::UntimedReaction::remove()'],['../classreactesp_1_1_i_s_r_reaction.html#a9ccf4abc748379340fb0e97b77c3bc4d',1,'reactesp::ISRReaction::remove()']]], + ['repeatreaction_3',['RepeatReaction',['../classreactesp_1_1_repeat_reaction.html#a55c79cf9f38829af00b2ea553596bbc4',1,'reactesp::RepeatReaction::RepeatReaction(const uint32_t interval, const react_callback callback)'],['../classreactesp_1_1_repeat_reaction.html#aebda92dd28d44efb915c62434913f2a7',1,'reactesp::RepeatReaction::RepeatReaction(const uint64_t interval, const react_callback callback)']]], + ['reporter_4',['reporter',['../main_8cpp.html#a58acc222e959363ee034cea9488ef627',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/search/functions_7.js b/docs/generated/docs/search/functions_7.js index 88a050d..6e89eb0 100644 --- a/docs/generated/docs/search/functions_7.js +++ b/docs/generated/docs/search/functions_7.js @@ -1,5 +1,9 @@ var searchData= [ - ['setup_0',['setup',['../class_react_e_s_p.html#aa26556a0954d117dc5b8d925e5924cdf',1,'ReactESP::setup()'],['../_react_e_s_p_8cpp.html#a7dfd9b79bc5a37d7df40207afbc5431f',1,'setup(): ReactESP.cpp']]], - ['streamreaction_1',['StreamReaction',['../class_stream_reaction.html#a902a27a4c687e6eac1255c4fad74bf17',1,'StreamReaction']]] + ['setup_0',['setup',['../main_8cpp.html#a4fc01d736fe50cf5b977f755b675f11d',1,'main.cpp']]], + ['setup_5fio_5fpins_1',['setup_io_pins',['../main_8cpp.html#aa41a4d8986ed6c03bd6ad416ba134a4e',1,'main.cpp']]], + ['setup_5fserial_2',['setup_serial',['../main_8cpp.html#aabd20f4bed5cefc2278d071d9dafb01f',1,'main.cpp']]], + ['setup_5ftick_3',['setup_tick',['../main_8cpp.html#a4e12b91752b35a5f3a628424fcd5d73b',1,'main.cpp']]], + ['setup_5ftimers_4',['setup_timers',['../main_8cpp.html#a8b0ce963bacb63827eb79b51bc74a551',1,'main.cpp']]], + ['streamreaction_5',['StreamReaction',['../classreactesp_1_1_stream_reaction.html#a415ab42487fd4811fcbefc1dda8f125b',1,'reactesp::StreamReaction']]] ]; diff --git a/docs/generated/docs/search/functions_8.js b/docs/generated/docs/search/functions_8.js index 06b9e2f..3f07a81 100644 --- a/docs/generated/docs/search/functions_8.js +++ b/docs/generated/docs/search/functions_8.js @@ -1,6 +1,6 @@ var searchData= [ - ['tick_0',['tick',['../class_reaction.html#a24cc0bd38eea8c50dd6718bb7a1c8051',1,'Reaction::tick()'],['../class_timed_reaction.html#a56eb9a737b11089358d34cc347f9fc7a',1,'TimedReaction::tick()'],['../class_delay_reaction.html#af2a85d71205ad1cbf5f6471f17e91a6f',1,'DelayReaction::tick()'],['../class_repeat_reaction.html#a2c05598c7a03d60ec1088db1da5d851d',1,'RepeatReaction::tick()'],['../class_untimed_reaction.html#a803aa29ba1f5d9f0312d71e09ee83f15',1,'UntimedReaction::tick()'],['../class_stream_reaction.html#aa874d5cc82b5392075da1262e318a703',1,'StreamReaction::tick()'],['../class_tick_reaction.html#aa4e6419363cef721057c990111542b93',1,'TickReaction::tick()'],['../class_i_s_r_reaction.html#aab332af06426b145d73c1b46b4d7c3fd',1,'ISRReaction::tick()'],['../class_react_e_s_p.html#aeefac464d9df930d020a321a63cdcf4b',1,'ReactESP::tick()']]], - ['tickreaction_1',['TickReaction',['../class_tick_reaction.html#a0928c0693f10acec61157027dd4658fe',1,'TickReaction']]], - ['timedreaction_2',['TimedReaction',['../class_timed_reaction.html#af1653cd9ff0b545e95baec51cde2743c',1,'TimedReaction::TimedReaction(const uint32_t interval, const react_callback callback)'],['../class_timed_reaction.html#a4a775a7624ba511ae80016e14b8d88f5',1,'TimedReaction::TimedReaction(const uint64_t interval, const react_callback callback)']]] + ['tick_0',['tick',['../classreactesp_1_1_reaction.html#ad3d3f332d9552c27f6a00c907d8ca1bd',1,'reactesp::Reaction::tick()'],['../classreactesp_1_1_timed_reaction.html#aa32de4aadffb55da49678d662f9089de',1,'reactesp::TimedReaction::tick()'],['../classreactesp_1_1_delay_reaction.html#ad7f7bab48635897fec696b139d59c134',1,'reactesp::DelayReaction::tick()'],['../classreactesp_1_1_repeat_reaction.html#adcbabf4f8166101c34468565a72dbc6a',1,'reactesp::RepeatReaction::tick()'],['../classreactesp_1_1_untimed_reaction.html#aa960a5b8adc44a1c8e0800b6e9a697f7',1,'reactesp::UntimedReaction::tick()'],['../classreactesp_1_1_stream_reaction.html#aaacfadf2931a51f84fad46f8836f5407',1,'reactesp::StreamReaction::tick()'],['../classreactesp_1_1_tick_reaction.html#a507fba43ad3fa7e7466654ad380ac65c',1,'reactesp::TickReaction::tick()'],['../classreactesp_1_1_i_s_r_reaction.html#aa8a31d433ff7e8a112afd9461e5da479',1,'reactesp::ISRReaction::tick()'],['../classreactesp_1_1_react_e_s_p.html#a683d99a3ed39a75337f01888c2240df0',1,'reactesp::ReactESP::tick()']]], + ['tickreaction_1',['TickReaction',['../classreactesp_1_1_tick_reaction.html#adf4e60e642e2c268150ddc8232e5dad8',1,'reactesp::TickReaction']]], + ['timedreaction_2',['TimedReaction',['../classreactesp_1_1_timed_reaction.html#a61a39ae3b7cf58657b69ad27bef4d6d5',1,'reactesp::TimedReaction::TimedReaction(const uint32_t interval, const react_callback callback)'],['../classreactesp_1_1_timed_reaction.html#ab53411bb9c37d8624b2d79d6cd6a73a9',1,'reactesp::TimedReaction::TimedReaction(const uint64_t interval, const react_callback callback)']]] ]; diff --git a/docs/generated/docs/search/functions_9.js b/docs/generated/docs/search/functions_9.js index 83fcbc2..0f56d39 100644 --- a/docs/generated/docs/search/functions_9.js +++ b/docs/generated/docs/search/functions_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['untimedreaction_0',['UntimedReaction',['../class_untimed_reaction.html#a1e33cb5f40db3c477f0a476d63999770',1,'UntimedReaction']]] + ['untimedreaction_0',['UntimedReaction',['../classreactesp_1_1_untimed_reaction.html#ad09151db8e445f748f4b84e2fe9472c6',1,'reactesp::UntimedReaction']]] ]; diff --git a/docs/generated/docs/search/functions_a.js b/docs/generated/docs/search/functions_a.js index c2d103d..541972d 100644 --- a/docs/generated/docs/search/functions_a.js +++ b/docs/generated/docs/search/functions_a.js @@ -1,7 +1,7 @@ var searchData= [ - ['_7edelayreaction_0',['~DelayReaction',['../class_delay_reaction.html#a50777489f0975d07a81c39c0638d1a7e',1,'DelayReaction']]], - ['_7eisrreaction_1',['~ISRReaction',['../class_i_s_r_reaction.html#adca866ff1b4dd48450ab0076707221bd',1,'ISRReaction']]], - ['_7etimedreaction_2',['~TimedReaction',['../class_timed_reaction.html#a2f26edad67264a6c4f4da7d7ebfbb661',1,'TimedReaction']]], - ['_7euntimedreaction_3',['~UntimedReaction',['../class_untimed_reaction.html#acd2ff1b448599949c3ad1d2e80b23507',1,'UntimedReaction']]] + ['_7edelayreaction_0',['~DelayReaction',['../classreactesp_1_1_delay_reaction.html#af1fbdbee6c0c032d5acab763d315a34d',1,'reactesp::DelayReaction']]], + ['_7eisrreaction_1',['~ISRReaction',['../classreactesp_1_1_i_s_r_reaction.html#a850a9346562861c44a9bc3a20e13ba1f',1,'reactesp::ISRReaction']]], + ['_7etimedreaction_2',['~TimedReaction',['../classreactesp_1_1_timed_reaction.html#a0f008c210ca872c62d01d2f8b71e1d7d',1,'reactesp::TimedReaction']]], + ['_7euntimedreaction_3',['~UntimedReaction',['../classreactesp_1_1_untimed_reaction.html#a806d843f7e6767bdab056f0eec241832',1,'reactesp::UntimedReaction']]] ]; diff --git a/docs/generated/docs/search/namespaces_0.html b/docs/generated/docs/search/namespaces_0.html new file mode 100644 index 0000000..4bedca0 --- /dev/null +++ b/docs/generated/docs/search/namespaces_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/generated/docs/search/namespaces_0.js b/docs/generated/docs/search/namespaces_0.js new file mode 100644 index 0000000..73a5de8 --- /dev/null +++ b/docs/generated/docs/search/namespaces_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['reactesp_0',['reactesp',['../namespacereactesp.html',1,'']]] +]; diff --git a/docs/generated/docs/search/related_0.js b/docs/generated/docs/search/related_0.js index d2ca79d..9d1f6e9 100644 --- a/docs/generated/docs/search/related_0.js +++ b/docs/generated/docs/search/related_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['isrreaction_0',['ISRReaction',['../class_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269',1,'ReactESP']]] + ['isrreaction_0',['ISRReaction',['../classreactesp_1_1_react_e_s_p.html#a6181e312f42c9b243cf44b38fe310269',1,'reactesp::ReactESP']]] ]; diff --git a/docs/generated/docs/search/related_1.js b/docs/generated/docs/search/related_1.js index 09e5e2a..46dc30d 100644 --- a/docs/generated/docs/search/related_1.js +++ b/docs/generated/docs/search/related_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['reaction_0',['Reaction',['../class_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51',1,'ReactESP']]], - ['repeatreaction_1',['RepeatReaction',['../class_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348',1,'ReactESP']]] + ['reaction_0',['Reaction',['../classreactesp_1_1_react_e_s_p.html#a5f86463029cca47f8aa15ff8cd5b9e51',1,'reactesp::ReactESP']]], + ['repeatreaction_1',['RepeatReaction',['../classreactesp_1_1_react_e_s_p.html#a539b4fe2115897ce16658443ea39f348',1,'reactesp::ReactESP']]] ]; diff --git a/docs/generated/docs/search/related_2.js b/docs/generated/docs/search/related_2.js index 15d9dc7..dcc4425 100644 --- a/docs/generated/docs/search/related_2.js +++ b/docs/generated/docs/search/related_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['timedreaction_0',['TimedReaction',['../class_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d',1,'ReactESP']]] + ['timedreaction_0',['TimedReaction',['../classreactesp_1_1_react_e_s_p.html#af650768845083eb3a0ec1493679bd20d',1,'reactesp::ReactESP']]] ]; diff --git a/docs/generated/docs/search/related_3.js b/docs/generated/docs/search/related_3.js index 45f4d20..f35a571 100644 --- a/docs/generated/docs/search/related_3.js +++ b/docs/generated/docs/search/related_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['untimedreaction_0',['UntimedReaction',['../class_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad',1,'ReactESP']]] + ['untimedreaction_0',['UntimedReaction',['../classreactesp_1_1_react_e_s_p.html#ab45ae4a88e6fcc0191e9f4d682bc34ad',1,'reactesp::ReactESP']]] ]; diff --git a/docs/generated/docs/search/searchdata.js b/docs/generated/docs/search/searchdata.js index 9a3885f..58f7de8 100644 --- a/docs/generated/docs/search/searchdata.js +++ b/docs/generated/docs/search/searchdata.js @@ -1,36 +1,39 @@ var indexSectionsWithContent = { - 0: "acdegilmorstu~", + 0: "acdegilmnorstu~", 1: "dirstu", - 2: "mr", - 3: "adgilorstu~", - 4: "aceilt", - 5: "ir", - 6: "irtu", - 7: "i" + 2: "r", + 3: "mr", + 4: "adgilorstu~", + 5: "aceilt", + 6: "ir", + 7: "irtu", + 8: "ilno" }; var indexSectionNames = { 0: "all", 1: "classes", - 2: "files", - 3: "functions", - 4: "variables", - 5: "typedefs", - 6: "related", - 7: "defines" + 2: "namespaces", + 3: "files", + 4: "functions", + 5: "variables", + 6: "typedefs", + 7: "related", + 8: "defines" }; var indexSectionLabels = { 0: "All", 1: "Classes", - 2: "Files", - 3: "Functions", - 4: "Variables", - 5: "Typedefs", - 6: "Friends", - 7: "Macros" + 2: "Namespaces", + 3: "Files", + 4: "Functions", + 5: "Variables", + 6: "Typedefs", + 7: "Friends", + 8: "Macros" }; diff --git a/docs/generated/docs/search/typedefs_0.js b/docs/generated/docs/search/typedefs_0.js index 7a5e1b0..33a8794 100644 --- a/docs/generated/docs/search/typedefs_0.js +++ b/docs/generated/docs/search/typedefs_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['isr_5freact_5fcallback_0',['isr_react_callback',['../_react_e_s_p_8h.html#a67b5c9351881150cba489e7594e0c976',1,'ReactESP.h']]] + ['isr_5freact_5fcallback_0',['isr_react_callback',['../namespacereactesp.html#a2b5792453cf14eaa49fd355ad1011482',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/typedefs_1.js b/docs/generated/docs/search/typedefs_1.js index 0a4ae22..5cbbfbb 100644 --- a/docs/generated/docs/search/typedefs_1.js +++ b/docs/generated/docs/search/typedefs_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['react_5fcallback_0',['react_callback',['../_react_e_s_p_8h.html#aced18b35574cdf9238eeb6d2c997db7f',1,'ReactESP.h']]] + ['react_5fcallback_0',['react_callback',['../namespacereactesp.html#a1dfbc20eb5c3efa2665acac404585b81',1,'reactesp']]] ]; diff --git a/docs/generated/docs/search/variables_0.js b/docs/generated/docs/search/variables_0.js index 97f1f00..b2717fd 100644 --- a/docs/generated/docs/search/variables_0.js +++ b/docs/generated/docs/search/variables_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['app_0',['app',['../class_react_e_s_p.html#a0af13aed55f3b30703e027ff2d761774',1,'ReactESP::app()'],['../main_8cpp.html#a828c6621f8cb3fef163c4b1f0c7e56c5',1,'app(): main.cpp']]] + ['app_0',['app',['../classreactesp_1_1_react_e_s_p.html#a69f6dd499c2f65613e82ea466ed88298',1,'reactesp::ReactESP::app()'],['../main_8cpp.html#aaa2ffd80e6f851dc6bb43c95a2c7d26f',1,'app(): main.cpp']]] ]; diff --git a/docs/generated/docs/search/variables_1.js b/docs/generated/docs/search/variables_1.js index 822b4d5..4e2083e 100644 --- a/docs/generated/docs/search/variables_1.js +++ b/docs/generated/docs/search/variables_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['callback_0',['callback',['../class_reaction.html#a13fdfc7eef62041f7394eac1f0b53978',1,'Reaction']]] + ['callback_0',['callback',['../classreactesp_1_1_reaction.html#a5247229438081b450d9e5985d1371238',1,'reactesp::Reaction']]] ]; diff --git a/docs/generated/docs/search/variables_2.js b/docs/generated/docs/search/variables_2.js index 5f51b38..4f6183b 100644 --- a/docs/generated/docs/search/variables_2.js +++ b/docs/generated/docs/search/variables_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['enabled_0',['enabled',['../class_timed_reaction.html#ae4c582a52e93db97646f8fbb0bb1b909',1,'TimedReaction']]] + ['enabled_0',['enabled',['../classreactesp_1_1_timed_reaction.html#a2494033d04540bf672ce91b080b0b8c6',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/variables_3.js b/docs/generated/docs/search/variables_3.js index 007c8e8..088e16e 100644 --- a/docs/generated/docs/search/variables_3.js +++ b/docs/generated/docs/search/variables_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['interval_0',['interval',['../class_timed_reaction.html#ad4a692b89c47ea51055534e8286532fa',1,'TimedReaction']]] + ['interval_0',['interval',['../classreactesp_1_1_timed_reaction.html#ae6b490c9d7b56a41c24c011e13834772',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/variables_4.js b/docs/generated/docs/search/variables_4.js index 5010de7..bbb4ce4 100644 --- a/docs/generated/docs/search/variables_4.js +++ b/docs/generated/docs/search/variables_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['last_5ftrigger_5ftime_0',['last_trigger_time',['../class_timed_reaction.html#a403ac811efb47fc24aae688b83309540',1,'TimedReaction']]] + ['last_5ftrigger_5ftime_0',['last_trigger_time',['../classreactesp_1_1_timed_reaction.html#aefccfe18abe4d6d83b2eae434be71e71',1,'reactesp::TimedReaction']]] ]; diff --git a/docs/generated/docs/search/variables_5.js b/docs/generated/docs/search/variables_5.js index a4ba9a2..3eae9fd 100644 --- a/docs/generated/docs/search/variables_5.js +++ b/docs/generated/docs/search/variables_5.js @@ -1,4 +1,5 @@ var searchData= [ - ['ticks_0',['ticks',['../main_8cpp.html#ab97230fdf86fd49a50dbcc8e44fdf9cc',1,'main.cpp']]] + ['tick_5fcounter_0',['tick_counter',['../main_8cpp.html#a6a8cac11201c2aa688c56aa3d8ae4e60',1,'main.cpp']]], + ['timer_5fticks_1',['timer_ticks',['../main_8cpp.html#a9747497b4cd5b5c68c9ff49d3ded14a4',1,'main.cpp']]] ]; diff --git a/docs/generated/docs/struct_trigger_time_compare.js b/docs/generated/docs/struct_trigger_time_compare.js deleted file mode 100644 index fd4e3ab..0000000 --- a/docs/generated/docs/struct_trigger_time_compare.js +++ /dev/null @@ -1,4 +0,0 @@ -var struct_trigger_time_compare = -[ - [ "operator()", "struct_trigger_time_compare.html#a8c43f2a1e90a47ea77876a76522ced21", null ] -]; \ No newline at end of file diff --git a/docs/generated/docs/struct_trigger_time_compare-members.html b/docs/generated/docs/structreactesp_1_1_trigger_time_compare-members.html similarity index 84% rename from docs/generated/docs/struct_trigger_time_compare-members.html rename to docs/generated/docs/structreactesp_1_1_trigger_time_compare-members.html index 29a0e1e..9ea2c7c 100644 --- a/docs/generated/docs/struct_trigger_time_compare-members.html +++ b/docs/generated/docs/structreactesp_1_1_trigger_time_compare-members.html @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -90,13 +90,13 @@
-
TriggerTimeCompare Member List
+
reactesp::TriggerTimeCompare Member List
-

This is the complete list of members for TriggerTimeCompare, including all inherited members.

+

This is the complete list of members for reactesp::TriggerTimeCompare, including all inherited members.

- +
operator()(TimedReaction *a, TimedReaction *b)TriggerTimeCompareinline
operator()(TimedReaction *a, TimedReaction *b)reactesp::TriggerTimeCompareinline
diff --git a/docs/generated/docs/struct_trigger_time_compare.html b/docs/generated/docs/structreactesp_1_1_trigger_time_compare.html similarity index 76% rename from docs/generated/docs/struct_trigger_time_compare.html rename to docs/generated/docs/structreactesp_1_1_trigger_time_compare.html index 5b22906..56e6f1c 100644 --- a/docs/generated/docs/struct_trigger_time_compare.html +++ b/docs/generated/docs/structreactesp_1_1_trigger_time_compare.html @@ -5,7 +5,7 @@ -ReactESP: TriggerTimeCompare Struct Reference +ReactESP: reactesp::TriggerTimeCompare Struct Reference @@ -32,7 +32,7 @@ -
ReactESP 1.0.1-alpha +
ReactESP 2.0.0
Asynchronous programming for the ESP microcontrollers
@@ -71,7 +71,7 @@
@@ -92,8 +92,8 @@
-
TriggerTimeCompare Struct Reference
+List of all members
+
reactesp::TriggerTimeCompare Struct Reference
@@ -101,15 +101,15 @@ - - + +

Public Member Functions

bool operator() (TimedReaction *a, TimedReaction *b)
 
bool operator() (TimedReaction *a, TimedReaction *b)
 

Detailed Description

-

Definition at line 85 of file ReactESP.h.

+

Definition at line 87 of file ReactESP.h.

Member Function Documentation

- -

◆ operator()()

+ +

◆ operator()()

@@ -118,15 +118,15 @@

- + - + - + @@ -142,7 +142,7 @@

-

Definition at line 86 of file ReactESP.h.

+

Definition at line 88 of file ReactESP.h.

@@ -154,7 +154,7 @@

diff --git a/docs/generated/docs/structreactesp_1_1_trigger_time_compare.js b/docs/generated/docs/structreactesp_1_1_trigger_time_compare.js new file mode 100644 index 0000000..0af4cd3 --- /dev/null +++ b/docs/generated/docs/structreactesp_1_1_trigger_time_compare.js @@ -0,0 +1,4 @@ +var structreactesp_1_1_trigger_time_compare = +[ + [ "operator()", "structreactesp_1_1_trigger_time_compare.html#a55ebdf386aa363af20658b165e7460a6", null ] +]; \ No newline at end of file From d5468e6c8294003d2b44b9cddbdc02e96dbeae22 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Sat, 27 Nov 2021 13:27:27 +0200 Subject: [PATCH 18/18] Add a README section on v1 vs v2 changes --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 36612e3..ac11e86 100644 --- a/README.md +++ b/README.md @@ -248,3 +248,32 @@ Remove the reaction from the execution queue. - [`Minimal`](examples/minimal/src/main.cpp): A minimal example with two timers switching the LED state. - [`Torture test`](examples/torture_test/src/main.cpp): A stress test of twenty simultaneous repeat reactions as well as a couple of interrupts, a stream, and a tick reaction. For kicks, try changing `NUM_TIMERS` to 200. Program performance will be practically unchanged! + +## Changes between version 1 and 2 + +ReactESP version 2 has changed the software initialization approach from version 1. +Version 1 implemented the Arduino framework standard `setup()` and `loop()` functions behind the scenes, +and a user just instantiated a ReactESP object and provided a setup function as an argument: + + ReactESP app([]() { + app.onDelay(...); + }); + +While this approach was "neat", it was also confusing to many users familiar with the Arduino framework. Therefore, ReactESP version 2 has reverted back to the more conventional approach: + + ReactESP app; + + void setup() { + app.onDelay(...); + } + + void loop() { + app.tick(); + } + +Note the changes: +- ReactESP app object is instantiated without any arguments +- There is an explicit `setup()` function. + Its contents can be copied verbatim from the version 1 lambda function. +- There is an explicit `loop()` function. + `app.tick()` must be called in the loop.

bool TriggerTimeCompare::operator() bool reactesp::TriggerTimeCompare::operator() (TimedReactionTimedReaction a,
TimedReactionTimedReaction b