Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
BasedOnStyle: LLVM
ColumnLimit: 100
BinPackArguments: false
BinPackParameters: false
AllowAllArgumentsOnNextLine: false
AlignAfterOpenBracket: BlockIndent
UseTab: ForIndentation
IndentWidth: 4
TabWidth: 4
ContinuationIndentWidth: 4
AllowShortFunctionsOnASingleLine: None
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8

[*.{c,cc,cpp,h,hpp,ino}]
indent_style = tab
indent_size = tab
tab_width = 4
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.venv
build/
build_prev_runner/
.vscode
19 changes: 19 additions & 0 deletions .vscode/bin/clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#!/usr/bin/env bash

set -euo pipefail

if command -v clang-format >/dev/null 2>&1; then
exec clang-format "$@"
fi

_home_dir="${HOME:-}"
if [ -n "$_home_dir" ]; then
_candidate="$(ls -1d "$_home_dir"/.vscode/extensions/ms-vscode.cpptools-*-linux-x64/LLVM/bin/clang-format 2>/dev/null | tail -n 1 || true)"
if [ -n "$_candidate" ] && [ -x "$_candidate" ]; then
exec "$_candidate" "$@"
fi
fi

echo "clang-format executable not found." >&2
echo "Install clang-format system-wide or install/update ms-vscode.cpptools." >&2
exit 127
9 changes: 9 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"recommendations": [
"pioarduino.pioarduino-ide",
"xaver.clang-format"
],
"unwantedRecommendations": [
"ms-vscode.cpptools-extension-pack"
]
}
30 changes: 30 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"files.associations": {
"*.ino": "cpp"
},
"editor.defaultFormatter": "xaver.clang-format",
"C_Cpp.formatting": "Disabled",
"clang-format.style": "file",
"clang-format.executable": "${workspaceRoot}/.vscode/bin/clang-format",
"[cpp]": {
"editor.defaultFormatter": "xaver.clang-format",
"editor.detectIndentation": false,
"editor.insertSpaces": false,
"editor.tabSize": 4,
"editor.formatOnSave": true
},
"[c]": {
"editor.defaultFormatter": "xaver.clang-format",
"editor.detectIndentation": false,
"editor.insertSpaces": false,
"editor.tabSize": 4,
"editor.formatOnSave": true
},
"[arduino]": {
"editor.defaultFormatter": "xaver.clang-format",
"editor.detectIndentation": false,
"editor.insertSpaces": false,
"editor.tabSize": 4,
"editor.formatOnSave": true
}
}
12 changes: 12 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Format Firmware Sources",
"type": "shell",
"command": "bash ${workspaceFolder}/scripts/format_cpp.sh",
"group": "build",
"problemMatcher": []
}
]
}
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ Stack sizes are expressed in bytes.
## Tests
A native host test suite is still being assembled. For now rely on the `examples/` sketches (build with PlatformIO or Arduino IDE) to verify integration, and consider adding regression tests when contributing changes.

## Formatting Baseline

This repository follows the firmware formatting baseline from `esptoolkit-template`:
- `.clang-format` is the source of truth for C/C++/INO layout.
- `.editorconfig` enforces tabs (`tab_width = 4`), LF endings, and final newline.
- Format all tracked firmware sources with `bash scripts/format_cpp.sh`.

## License
ESPWorker is released under the [MIT License](LICENSE.md).

Expand Down
26 changes: 14 additions & 12 deletions examples/basic_lambda_worker/basic_lambda_worker.ino
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,30 @@
ESPWorker worker;

ESPWorker::Config workerConfig = {
.maxWorkers = 16,
.stackSizeBytes = 2048,
.priority = 1,
.coreId = tskNO_AFFINITY,
.enableExternalStacks = true,
.maxWorkers = 16,
.stackSizeBytes = 2048,
.priority = 1,
.coreId = tskNO_AFFINITY,
.enableExternalStacks = true,
};

void setup() {
Serial.begin(115200);
while (!Serial) {}
Serial.begin(115200);
while (!Serial) {
}

worker.init(workerConfig);
worker.init(workerConfig);

// Spawn a default job
auto testJob = worker.spawn([](){
// Spawn a default job
auto testJob = worker.spawn([]() {
Serial.println("[Worker] task is triggered!");
vTaskDelay(pdMS_TO_TICKS(1000));
});
testJob.handler->wait(); // Wait for the job to finish, indefinietly
Serial.println("[Worker] task is completed!");

worker.deinit();
worker.deinit();
}

void loop() {}
void loop() {
}
30 changes: 16 additions & 14 deletions examples/basic_worker/basic_worker.ino
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,32 @@
ESPWorker worker;

ESPWorker::Config workerConfig = {
.maxWorkers = 16,
.stackSizeBytes = 4096,
.priority = 1,
.coreId = tskNO_AFFINITY,
.enableExternalStacks = true,
.maxWorkers = 16,
.stackSizeBytes = 4096,
.priority = 1,
.coreId = tskNO_AFFINITY,
.enableExternalStacks = true,
};

void jobFunction(){
Serial.println("[Worker] task is triggered!");
void jobFunction() {
Serial.println("[Worker] task is triggered!");
vTaskDelay(pdMS_TO_TICKS(1000));
}

void setup() {
Serial.begin(115200);
while (!Serial) {}
Serial.begin(115200);
while (!Serial) {
}

worker.init(workerConfig);
worker.init(workerConfig);

// Spawn a default job
auto testJob = worker.spawn(jobFunction);
// Spawn a default job
auto testJob = worker.spawn(jobFunction);
testJob.handler->wait(); // Wait for the job to finish, indefinietly
Serial.println("[Worker] task is completed!");

worker.deinit();
worker.deinit();
}

void loop() {}
void loop() {
}
44 changes: 23 additions & 21 deletions examples/psram_stack/psram_stack.ino
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,38 @@
ESPWorker worker;

ESPWorker::Config workerConfig = {
.maxWorkers = 16,
.stackSizeBytes = 2048,
.priority = 1,
.coreId = tskNO_AFFINITY,
.enableExternalStacks = true,
.maxWorkers = 16,
.stackSizeBytes = 2048,
.priority = 1,
.coreId = tskNO_AFFINITY,
.enableExternalStacks = true,
};

void printPSRAM(const char* tag){
uint32_t freePSRAM = ESP.getFreePsram();
Serial.printf("[%s] Free PSRAM: %u bytes\n", tag, freePSRAM);
void printPSRAM(const char *tag) {
uint32_t freePSRAM = ESP.getFreePsram();
Serial.printf("[%s] Free PSRAM: %u bytes\n", tag, freePSRAM);
}

void setup() {
Serial.begin(115200);
while (!Serial) {}
Serial.begin(115200);
while (!Serial) {
}

worker.init(workerConfig);
worker.init(workerConfig);

printPSRAM("Initial");
printPSRAM("Initial");

// Spawn a default job with psram stack
auto testJob = worker.spawnExt([](){
Serial.println("[Worker] This task stack uses PSRAM!");
printPSRAM("Inside job");
});
// Spawn a default job with psram stack
auto testJob = worker.spawnExt([]() {
Serial.println("[Worker] This task stack uses PSRAM!");
printPSRAM("Inside job");
});

testJob.handler->wait(); // Wait for the job to finish, indefinietly
printPSRAM("After job completed");
testJob.handler->wait(); // Wait for the job to finish, indefinietly
printPSRAM("After job completed");

worker.deinit();
worker.deinit();
}

void loop() {}
void loop() {
}
24 changes: 24 additions & 0 deletions scripts/format_cpp.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/usr/bin/env bash

set -euo pipefail

_repo_root="$(git rev-parse --show-toplevel 2>/dev/null || pwd)"
_clang_format="${_repo_root}/.vscode/bin/clang-format"

if [ ! -x "${_clang_format}" ]; then
echo "clang-format wrapper not found: ${_clang_format}" >&2
exit 1
fi

mapfile -d '' _format_files < <(
git -C "${_repo_root}" ls-files -z -- '*.c' '*.cc' '*.cpp' '*.h' '*.hpp' '*.ino'
)

if [ "${#_format_files[@]}" -eq 0 ]; then
echo "No tracked C/C++/INO files found to format."
exit 0
fi

"${_clang_format}" -i --style=file "${_format_files[@]}"

echo "Formatted ${#_format_files[@]} files."
Loading