Skip to content

Commit ec60c56

Browse files
committed
Unified config naming across ESPToolKit libraries
1 parent 39d0585 commit ec60c56

3 files changed

Lines changed: 26 additions & 24 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,14 @@ Explore `examples/Basic/Basic.ino` for a complete sketch that demonstrates all t
7272
- Control helpers: `pause*`, `resume*`, `toggleRunStatus*`, `clear*`, `ESPTimerStatus getStatus(id)`.
7373

7474
`ESPTimerConfig` knobs (per task type):
75-
- Stack sizes (`stack_size_timeout`, `stack_size_interval`, `stack_size_sec`, `stack_size_ms`, `stack_size_min`).
76-
- Priorities (`priority_timeout`, …).
77-
- Core affinity (`core_*`, `-1` = no pin).
75+
- Stack sizes (`stackSizeTimeout`, `stackSizeInterval`, `stackSizeSec`, `stackSizeMs`, `stackSizeMin`).
76+
- Priorities (`priorityTimeout`, …).
77+
- Core affinity (`core*`, `-1` = no pin).
7878

7979
`ESPTimerStatus` reports `Invalid`, `Running`, `Paused`, `Stopped`, or `Completed`.
8080

81+
Stack sizes are expressed in bytes.
82+
8183
## Restrictions
8284
- Designed for ESP32 boards where FreeRTOS is available (Arduino-ESP32 or ESP-IDF). Other MCUs are untested.
8385
- Requires C++17 due to heavy use of `std::function` and lambdas.

src/esp_timer/timer.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ void ESPTimer::init(const ESPTimerConfig& cfg) {
4646
(void)ok; // avoid warning in non-assert builds
4747
};
4848

49-
createTask(timeoutTaskTrampoline, "ESPTmrTimeout", cfg_.stack_size_timeout, cfg_.priority_timeout, &hTimeout_, cfg_.core_timeout);
50-
createTask(intervalTaskTrampoline, "ESPTmrInterval", cfg_.stack_size_interval, cfg_.priority_interval, &hInterval_, cfg_.core_interval);
51-
createTask(secTaskTrampoline, "ESPTmrSec", cfg_.stack_size_sec, cfg_.priority_sec, &hSec_, cfg_.core_sec);
52-
createTask(msTaskTrampoline, "ESPTmrMs", cfg_.stack_size_ms, cfg_.priority_ms, &hMs_, cfg_.core_ms);
53-
createTask(minTaskTrampoline, "ESPTmrMin", cfg_.stack_size_min, cfg_.priority_min, &hMin_, cfg_.core_min);
49+
createTask(timeoutTaskTrampoline, "ESPTmrTimeout", cfg_.stackSizeTimeout, cfg_.priorityTimeout, &hTimeout_, cfg_.coreTimeout);
50+
createTask(intervalTaskTrampoline, "ESPTmrInterval", cfg_.stackSizeInterval, cfg_.priorityInterval, &hInterval_, cfg_.coreInterval);
51+
createTask(secTaskTrampoline, "ESPTmrSec", cfg_.stackSizeSec, cfg_.prioritySec, &hSec_, cfg_.coreSec);
52+
createTask(msTaskTrampoline, "ESPTmrMs", cfg_.stackSizeMs, cfg_.priorityMs, &hMs_, cfg_.coreMs);
53+
createTask(minTaskTrampoline, "ESPTmrMin", cfg_.stackSizeMin, cfg_.priorityMin, &hMin_, cfg_.coreMin);
5454

5555
initialized_ = true;
5656
}

src/esp_timer/timer.h

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,26 @@ enum class ESPTimerStatus : uint8_t {
1717
};
1818

1919
struct ESPTimerConfig {
20-
// Stack sizes per task type (in words on ESP-IDF, bytes on Arduino build)
21-
uint16_t stack_size_timeout = 4096;
22-
uint16_t stack_size_interval = 4096;
23-
uint16_t stack_size_sec = 4096;
24-
uint16_t stack_size_ms = 4096;
25-
uint16_t stack_size_min = 4096;
20+
// Stack sizes per task type (bytes)
21+
uint16_t stackSizeTimeout = 4096 * sizeof(StackType_t);
22+
uint16_t stackSizeInterval = 4096 * sizeof(StackType_t);
23+
uint16_t stackSizeSec = 4096 * sizeof(StackType_t);
24+
uint16_t stackSizeMs = 4096 * sizeof(StackType_t);
25+
uint16_t stackSizeMin = 4096 * sizeof(StackType_t);
2626

2727
// Priorities per task
28-
UBaseType_t priority_timeout = 1;
29-
UBaseType_t priority_interval = 1;
30-
UBaseType_t priority_sec = 1;
31-
UBaseType_t priority_ms = 2; // default slightly higher as it wakes up more often
32-
UBaseType_t priority_min = 1;
28+
UBaseType_t priorityTimeout = 1;
29+
UBaseType_t priorityInterval = 1;
30+
UBaseType_t prioritySec = 1;
31+
UBaseType_t priorityMs = 2; // default slightly higher as it wakes up more often
32+
UBaseType_t priorityMin = 1;
3333

3434
// Core affinity (-1 means no pin/any core)
35-
int8_t core_timeout = -1;
36-
int8_t core_interval = -1;
37-
int8_t core_sec = -1;
38-
int8_t core_ms = -1;
39-
int8_t core_min = -1;
35+
int8_t coreTimeout = -1;
36+
int8_t coreInterval = -1;
37+
int8_t coreSec = -1;
38+
int8_t coreMs = -1;
39+
int8_t coreMin = -1;
4040
};
4141

4242
class ESPTimer {

0 commit comments

Comments
 (0)