|
40 | 40 | * @details Enables tracking when the current execution took place relative to when it was scheduled. |
41 | 41 | * Provides getStartDelay() and getOverrun() methods for performance monitoring. |
42 | 42 | */ |
43 | | -// #define _TASK_TIMECRITICAL |
44 | 43 |
|
45 | 44 | /** |
46 | 45 | * @def _TASK_SLEEP_ON_IDLE_RUN |
47 | 46 | * @brief Enable 1 ms SLEEP_IDLE powerdowns between runs if no callback methods were invoked during the pass |
48 | 47 | * @details When enabled, the scheduler will place the processor into IDLE sleep mode for approximately 1 ms |
49 | 48 | * after what is determined to be an "idle" pass. AVR boards only. |
50 | 49 | */ |
51 | | -// #define _TASK_SLEEP_ON_IDLE_RUN |
52 | 50 |
|
53 | 51 | /** |
54 | 52 | * @def _TASK_STATUS_REQUEST |
55 | 53 | * @brief Compile with support for StatusRequest functionality |
56 | 54 | * @details Enables triggering tasks on status change events in addition to time-based scheduling. |
57 | 55 | * Allows tasks to wait on an event and signal event completion to each other. |
58 | 56 | */ |
59 | | -// #define _TASK_STATUS_REQUEST |
60 | 57 |
|
61 | 58 | /** |
62 | 59 | * @def _TASK_WDT_IDS |
63 | 60 | * @brief Compile with support for watchdog timer control points and task IDs |
64 | 61 | * @details Each task can be assigned an ID and Control Points can be defined within tasks |
65 | 62 | * for watchdog timer integration and error handling. |
66 | 63 | */ |
67 | | -// #define _TASK_WDT_IDS |
68 | 64 |
|
69 | 65 | /** |
70 | 66 | * @def _TASK_LTS_POINTER |
71 | 67 | * @brief Compile with support for local task storage pointer |
72 | 68 | * @details LTS is a generic (void*) pointer that can reference a variable or structure |
73 | 69 | * specific to a particular task, allowing the same callback code for multiple tasks. |
74 | 70 | */ |
75 | | -// #define _TASK_LTS_POINTER |
76 | 71 |
|
77 | 72 | /** |
78 | 73 | * @def _TASK_PRIORITY |
79 | 74 | * @brief Support for layered scheduling priority |
80 | 75 | * @details Enables task prioritization by creating several schedulers and organizing them in priority layers. |
81 | 76 | * Higher priority tasks are evaluated more frequently. |
82 | 77 | */ |
83 | | -// #define _TASK_PRIORITY |
84 | 78 |
|
85 | 79 | /** |
86 | 80 | * @def _TASK_MICRO_RES |
87 | 81 | * @brief Support for microsecond resolution |
88 | 82 | * @details Enables microsecond scheduling resolution instead of default millisecond resolution. |
89 | 83 | * All time-relevant parameters will be treated as microseconds. |
90 | 84 | */ |
91 | | -// #define _TASK_MICRO_RES |
92 | 85 |
|
93 | 86 | /** |
94 | 87 | * @def _TASK_STD_FUNCTION |
95 | 88 | * @brief Support for std::function (ESP8266/ESP32 ONLY) |
96 | 89 | * @details Enables support for standard functions instead of function pointers for callbacks. |
97 | 90 | */ |
98 | | -// #define _TASK_STD_FUNCTION |
99 | 91 |
|
100 | 92 | /** |
101 | 93 | * @def _TASK_DEBUG |
102 | 94 | * @brief Make all methods and variables public for debug purposes |
103 | 95 | * @details Should not be used in production. Exposes all private and protected members as public. |
104 | 96 | */ |
105 | | -// #define _TASK_DEBUG |
106 | 97 |
|
107 | 98 | /** |
108 | 99 | * @def _TASK_INLINE |
109 | 100 | * @brief Make all methods "inline" |
110 | 101 | * @details Needed to support some multi-tab, multi-file implementations. Lets compiler optimize. |
111 | 102 | */ |
112 | | -// #define _TASK_INLINE |
113 | 103 |
|
114 | 104 | /** |
115 | 105 | * @def _TASK_TIMEOUT |
116 | 106 | * @brief Support for overall task timeout |
117 | 107 | * @details Any task can be set to time out after a certain period, and timeout can be reset. |
118 | 108 | * Can be used as an individual Task's watchdog timer. |
119 | 109 | */ |
120 | | -// #define _TASK_TIMEOUT |
121 | 110 |
|
122 | 111 | /** |
123 | 112 | * @def _TASK_OO_CALLBACKS |
124 | 113 | * @brief Support for callbacks via inheritance |
125 | 114 | * @details Useful for implementing Tasks as classes derived from the Task class. |
126 | 115 | * Enables dynamic binding for object-oriented callback approach. |
127 | 116 | */ |
128 | | -// #define _TASK_OO_CALLBACKS |
129 | 117 |
|
130 | 118 | /** |
131 | 119 | * @def _TASK_EXPOSE_CHAIN |
132 | 120 | * @brief Methods to access tasks in the task chain |
133 | 121 | * @details Provides access to scheduling chain methods and tasks on the chain. |
134 | 122 | */ |
135 | | -// #define _TASK_EXPOSE_CHAIN |
136 | 123 |
|
137 | 124 | /** |
138 | 125 | * @def _TASK_SCHEDULING_OPTIONS |
139 | 126 | * @brief Support for multiple scheduling options |
140 | 127 | * @details Enables different task scheduling options like TASK_SCHEDULE, TASK_SCHEDULE_NC, and TASK_INTERVAL. |
141 | 128 | */ |
142 | | -// #define _TASK_SCHEDULING_OPTIONS |
143 | 129 |
|
144 | 130 | /** |
145 | 131 | * @def _TASK_SELF_DESTRUCT |
146 | 132 | * @brief Enable tasks to "self-destruct" after disable |
147 | 133 | * @details Tasks can be set to automatically delete themselves when disabled. |
148 | 134 | */ |
149 | | -// #define _TASK_SELF_DESTRUCT |
150 | 135 |
|
151 | 136 | /** |
152 | 137 | * @def _TASK_TICKLESS |
153 | 138 | * @brief Enable support for tickless sleep on FreeRTOS |
154 | 139 | * @details Enables support for tickless sleep mode on FreeRTOS systems. |
155 | 140 | */ |
156 | | -// #define _TASK_TICKLESS |
157 | 141 |
|
158 | 142 | /** |
159 | 143 | * @def _TASK_DO_NOT_YIELD |
160 | 144 | * @brief Disable yield() method in execute() for ESP chips |
161 | 145 | * @details Disables automatic yielding in the execute loop for ESP-based systems. |
162 | 146 | */ |
163 | | -// #define _TASK_DO_NOT_YIELD |
164 | 147 |
|
165 | 148 | /** |
166 | 149 | * @def _TASK_ISR_SUPPORT |
167 | 150 | * @brief For ESP chips - place control methods in IRAM |
168 | 151 | * @details Places critical control methods in IRAM for ESP8266/ESP32 interrupt support. |
169 | 152 | */ |
170 | | -// #define _TASK_ISR_SUPPORT |
171 | 153 |
|
172 | 154 | /** |
173 | 155 | * @def _TASK_NON_ARDUINO |
174 | 156 | * @brief For non-Arduino use |
175 | 157 | * @details Enables compilation for non-Arduino environments. |
176 | 158 | */ |
177 | | -// #define _TASK_NON_ARDUINO |
178 | 159 |
|
179 | 160 | /** |
180 | 161 | * @def _TASK_HEADER_AND_CPP |
181 | 162 | * @brief Compile CPP file (non-Arduino IDE platforms) |
182 | 163 | * @details For non-Arduino IDE platforms that require explicit CPP compilation. |
183 | 164 | */ |
184 | | -// #define _TASK_HEADER_AND_CPP |
185 | 165 |
|
186 | 166 | /** |
187 | 167 | * @def _TASK_THREAD_SAFE |
188 | 168 | * @brief Enable additional checking for thread safety |
189 | 169 | * @details Uses an internal mutex to protect task scheduling methods from preemption. |
190 | 170 | * Recommended for ESP32 and other MCUs running under preemptive schedulers like FreeRTOS. |
191 | 171 | */ |
192 | | -// #define _TASK_THREAD_SAFE |
193 | 172 |
|
194 | 173 | /** @} */ // End of CompileTimeOptions group |
195 | 174 |
|
|
0 commit comments