Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
122 commits
Select commit Hold shift + click to select a range
eafd532
Added a bunch of new methods
Sep 26, 2025
6dbe585
Add mthod to compare config data, fixed name of setConfigDataAsync to…
Sep 28, 2025
8e0d33c
Restructured the code, add methods to set the command timeout, update…
Sep 28, 2025
cf070ff
Debug macros move to own file, changed settings to allow for debug level
Sep 28, 2025
224514b
WIP setConfigData(), sequence processing changed/simplyfied
Sep 28, 2025
af53db3
setConfigData rewrite completed.
Sep 29, 2025
57f3961
Changed names of config methods to start with configure. Updated comm…
Sep 29, 2025
f11c676
Naming improved
Sep 29, 2025
9bbfa54
Workflow splitted
Sep 29, 2025
e2e8104
Version nr increased, keywords updated
Sep 29, 2025
727e526
Added workflow to update docu
Sep 29, 2025
2bcf8e9
Added workflow code
Sep 29, 2025
870df0e
Dumped automaticy docu creation
Sep 29, 2025
ce41673
A bit closer to the past version
Sep 29, 2025
fdc6d08
Added another example, updated the other examples, added default valu…
Sep 29, 2025
cce8f3a
Automatic docu generation added
Sep 29, 2025
e8640f2
Update documentation
actions-user Sep 29, 2025
5aec2ff
Groups added to docu
Sep 29, 2025
2d0d7c6
Update documentation
actions-user Sep 29, 2025
58270ae
Disable graphwiz
Sep 29, 2025
fe2f6ac
Groups added to comments/docu.
Sep 29, 2025
e5b4a64
Update documentation
actions-user Sep 29, 2025
21b0f1e
Fixes to make groups work (i hope)
Sep 29, 2025
0952636
Update documentation
actions-user Sep 29, 2025
0f4e767
Multigroup testing
Sep 29, 2025
137d1ed
Update documentation
actions-user Sep 29, 2025
5e4c853
Added topic index instead of groups
Sep 29, 2025
79839f5
Update documentation
actions-user Sep 29, 2025
76c5dd0
all ingroup directives dumped
Sep 29, 2025
fd8bf2c
StaticData struct implemented and code to fill it adjusted
Sep 30, 2025
cad7304
Update documentation
actions-user Sep 30, 2025
816fde3
Comments added
Sep 30, 2025
92af298
New example added
Sep 30, 2025
15d455b
Update documentation
actions-user Sep 30, 2025
0ad1247
Comments extended
Sep 30, 2025
74bebfe
Update documentation
actions-user Sep 30, 2025
494ca86
Still working on examples docs
Sep 30, 2025
c4adbf5
Update documentation
actions-user Sep 30, 2025
ce67721
Still working on example docu
Sep 30, 2025
b7a6aea
Update documentation
actions-user Sep 30, 2025
251d2b5
Added an example group
Sep 30, 2025
d0efe07
Update documentation
actions-user Sep 30, 2025
a542ae2
Test with @example
Sep 30, 2025
3bdc9fe
Update documentation
actions-user Sep 30, 2025
a739aa9
Still docu work
Sep 30, 2025
5b3ae29
Update documentation
actions-user Sep 30, 2025
0c97ff5
Reverted examples to org version
Sep 30, 2025
3b8f0af
Example sketches updated
Sep 30, 2025
ff6df7a
Loads o fixes and updates
Oct 1, 2025
a1a033a
Update documentation
actions-user Oct 1, 2025
d6cc179
Various fixes to the lib, unit test working
Oct 2, 2025
5719542
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 2, 2025
f0fefff
Update documentation
actions-user Oct 2, 2025
6233ec4
Debug macros updated, comments added
Oct 2, 2025
96ba213
Usedata removed
Oct 2, 2025
b7dbad0
UserData remove in examples
Oct 2, 2025
a1c8c17
DEBUG_PRINTS added, small docu change
Oct 3, 2025
caa593a
Retry logiic added to sendCommandAsync, 1 retry configured for enable…
Oct 3, 2025
bd8aac4
Retry logic works. It seems we have no more enable conrfig mode failu…
Oct 3, 2025
78de8ac
Docu extended
Oct 3, 2025
3e246d2
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 3, 2025
84168bc
Update documentation
actions-user Oct 3, 2025
9df4e7a
Docu extended
Oct 3, 2025
fd0d303
Update documentation
actions-user Oct 3, 2025
a9c9b89
Name changed
Oct 3, 2025
1b5a064
Update documentation
actions-user Oct 3, 2025
b37dec2
Some improvements
Oct 3, 2025
6086a18
Update documentation
actions-user Oct 3, 2025
d82200d
References added to docu
Oct 3, 2025
ab6020d
Update documentation
actions-user Oct 3, 2025
43cfdc9
DOcu improvements
Oct 3, 2025
b44ee73
Many changes and a lot up updated docu.
Oct 4, 2025
556da0f
Update documentation
actions-user Oct 4, 2025
ce14fc5
Minor docu fixes
Oct 4, 2025
d4cbf46
Update documentation
actions-user Oct 4, 2025
0ff7489
Docu fixes
Oct 4, 2025
c6f9eed
Update documentation
actions-user Oct 4, 2025
6439433
Added sections and subsections
Oct 4, 2025
f2948bc
Update documentation
actions-user Oct 4, 2025
782bdb9
Docu fixes
Oct 4, 2025
62c0ef1
Update documentation
actions-user Oct 4, 2025
9cc0601
updated
Oct 4, 2025
b4d6dab
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 4, 2025
475385e
Update documentation
actions-user Oct 4, 2025
4494d75
Another try
Oct 4, 2025
10c1313
Update documentation
actions-user Oct 4, 2025
a235ce7
Typo fixed
Oct 4, 2025
30ed773
Update documentation
actions-user Oct 4, 2025
42bb376
Maybe this will work
Oct 4, 2025
0338060
Update documentation
actions-user Oct 4, 2025
e495c25
More docu work
Oct 4, 2025
4b1208c
Update documentation
actions-user Oct 4, 2025
c4f854b
Img path fixed
Oct 4, 2025
0cba930
Update documentation
actions-user Oct 4, 2025
2e2231a
Mino adjustments
Oct 4, 2025
273e279
Update documentation
actions-user Oct 4, 2025
3750477
Included image of sensor
Oct 4, 2025
e536cb6
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 4, 2025
22de447
Update documentation
actions-user Oct 4, 2025
f57037e
Fix processAck declaration name
lizardking Oct 4, 2025
c268e89
Update documentation
actions-user Oct 4, 2025
d1fd6b7
Merge pull request #15 from lizardking/codex/check-spelling-and-repla…
lizardking Oct 4, 2025
6d5ac9b
Typo fixed
Oct 4, 2025
fcc5263
Update documentation
actions-user Oct 4, 2025
1875732
More typos fixed
Oct 4, 2025
77ad3a2
Added libs
Oct 4, 2025
e0f5334
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 4, 2025
2d42cd3
Update documentation
actions-user Oct 4, 2025
3b2fd16
Removed image
Oct 4, 2025
71789a1
Libs updated
Oct 4, 2025
96d4666
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 4, 2025
0503e27
Update documentation
actions-user Oct 4, 2025
c98c3a4
Spaces added
Oct 5, 2025
a88a1a7
Another attemopt to integrate required libs
Oct 5, 2025
429a8fa
Merge branch 'dev' of https://github.com/lizardking/LD2410Async into dev
Oct 5, 2025
40fb4e9
Another try
Oct 5, 2025
836a7df
Docu generation updated
Oct 5, 2025
b271953
Docu moce to gh-pages. Removed old docu
Oct 5, 2025
5cda99e
Added bdge for docu
Oct 5, 2025
5f2ddd4
Added release workflow, adjusted docu workflow, added release badge t…
Oct 5, 2025
da10b7b
Workflow fixed
Oct 5, 2025
876abe4
Updated
Oct 5, 2025
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
21 changes: 21 additions & 0 deletions .github/workflows/arduinoLint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Arduino Lint

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
workflow_dispatch:

jobs:
lint:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Arduino Lint
uses: arduino/arduino-lint-action@v1
with:
compliance: strict
10 changes: 5 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,7 @@ jobs:
- name: Checkout
uses: actions/checkout@v3

- name: Arduino Lint
uses: arduino/arduino-lint-action@v1
with:
compliance: strict


- name: Cache Arduino platform
uses: actions/cache@v3
Expand All @@ -52,7 +49,10 @@ jobs:
with:
platforms: ${{ matrix.platforms }}
fqbn: ${{ matrix.board.fqbn }}
libraries: ${{ env.LIBRARIES }}
libraries: |
- name: "Async TCP"
- name: "ESP Async WebServer"
- source-path: .
enable-deltas-report: false
sketch-paths: |
- examples
Expand Down
56 changes: 56 additions & 0 deletions .github/workflows/createRelease.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Create Release

on:
release:
types: [published]
workflow_dispatch:

jobs:
release:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Extract version from release tag
id: version
run: |
TAG_NAME="${{ github.event.release.tag_name }}"
echo "tag_name=$TAG_NAME" >> $GITHUB_OUTPUT
echo "Version detected: $TAG_NAME"

- name: Validate library version
run: |
echo "Checking library.properties..."
grep -E '^version=' library.properties || { echo "Error: version missing"; exit 1; }

PROP_VERSION=$(grep -E '^version=' library.properties | cut -d'=' -f2)
TAG_NAME="${{ github.event.release.tag_name }}"
TAG_VERSION="${TAG_NAME#v}" # Remove leading 'v' in Bash

if [ "$PROP_VERSION" != "$TAG_VERSION" ]; then
echo "Version mismatch: library.properties ($PROP_VERSION) vs tag ($TAG_NAME)"
exit 1
fi

echo "Version match confirmed"

- name: Package library
run: |
mkdir -p dist
ZIP_FILE="LD2410Async-${{ steps.version.outputs.tag_name }}.zip"
echo "Packaging library as $ZIP_FILE ..."
zip -r "dist/$ZIP_FILE" . -x "*.git*" "dist/*" ".github/*" "docs/*" "__MACOSX"

- name: Upload ZIP to existing GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ steps.version.outputs.tag_name }}
name: "LD2410Async ${{ steps.version.outputs.tag_name }}"
files: dist/*.zip
append_body: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33 changes: 33 additions & 0 deletions .github/workflows/generateDoxygenDocu.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Generate Documentation

on:
# Run when a release is created or published
release:
types: [published]

# Allow manual trigger from the Actions tab
workflow_dispatch:

jobs:
doxygen:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Ensures tags are available (useful for versioned docs)

- name: Generate Doxygen documentation
uses: mattnotmitt/doxygen-action@v1
with:
doxyfile-path: ./Doxyfile

- name: Deploy documentation to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
publish_branch: gh-pages
force_orphan: true
keep_files: false
74 changes: 74 additions & 0 deletions Doxyfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Doxyfile for LD2410Async C++ Library
# Suitable for GitHub Actions workflow in .github/workflows/generateDoxygenDocu.yml

# Project related configuration
PROJECT_NAME = "LD2410Async"
PROJECT_BRIEF = "Asynchronous Arduino ESP32 library for the LD2410 mmWave radar sensor"
OUTPUT_DIRECTORY = docs
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_ANON_NSPACES = YES
SORT_MEMBER_DOCS = YES
SORT_GROUP_NAMES = YES



# Input
INPUT = src examples dox
FILE_PATTERNS = *.h *.cpp *.ino *.dox *.md
EXTENSION_MAPPING = ino=C++
RECURSIVE = YES
IMAGE_PATH = gfx

# Source code browsing
SOURCE_BROWSER = YES
INLINE_SOURCES = FALSE
STRIP_CODE_COMMENTS = NO

# HTML output
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80

# LaTeX output (disabled)
GENERATE_LATEX = NO

# Dot/Graphviz support
HAVE_DOT = NO
CALL_GRAPH = NO
CALLER_GRAPH = NO
CLASS_DIAGRAMS = NO
COLLABORATION_GRAPH= NO
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
GRAPHICAL_HIERARCHY= NO
DOT_MULTI_TARGETS = NO

# Warnings
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES

# Misc
QUIET = NO
GENERATE_TREEVIEW = YES
FULL_PATH_NAMES = NO
STRIP_FROM_PATH = src examples

# Repository link (optional, for GitHub integration)
# Set to your repo if you want source browsing links
# HTML_DYNAMIC_SECTIONS = YES
# PROJECT_LOGO =

# If you want Markdown support
MARKDOWN_SUPPORT = YES

# If you want to document private members, set EXTRACT_PRIVATE = YES

# End of Doxyfile
2 changes: 1 addition & 1 deletion LD2410Async.sln
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.14.36511.14 d17.14
VisualStudioVersion = 17.14.36511.14
MinimumVisualStudioVersion = 10.0.40219.1
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "LD2410Async", "LD2410Async.vcxitems", "{76DB4135-DB0F-4430-958C-2109370DCD97}"
EndProject
Expand Down
23 changes: 23 additions & 0 deletions LD2410Async.vcxitems
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,28 @@
<!-- <ClInclude Include="$(MSBuildThisFileDirectory)LD2410Async.h" /> -->
<None Include="$(MSBuildThisFileDirectory).gitattributes" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\build.yml" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\arduinoLint.yml" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\createRelease.yml" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\generateDoxygenDocu.yml" />
<None Include="$(MSBuildThisFileDirectory).gitignore" />
<None Include="$(MSBuildThisFileDirectory)Doxyfile" />
<None Include="$(MSBuildThisFileDirectory)dox\Async Commands And Processing.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Data Structures.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Examples.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Inactivity Handling.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Installation.md" />
<None Include="$(MSBuildThisFileDirectory)dox\mainPage.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Notes And Best Practices.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Operation Modes.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Troubleshooting.md" />
<None Include="$(MSBuildThisFileDirectory)examples\basicPresenceDetection\basicPresenceDetection.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\changeConfig\changeConfig.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\changeDistanceResolution\changeDistanceResolution.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\enableConfigModeTest\enableConfigModeTest.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\receiveData\receiveData.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\simplePresenceDetectionWebservice\simplePresenceDetectionWebservice.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\tortureTest\tortureTest.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\unitTest\unitTest.ino" />
<None Include="$(MSBuildThisFileDirectory)LICENSE" />
<None Include="$(MSBuildThisFileDirectory)README.md" />
</ItemGroup>
Expand All @@ -34,6 +52,11 @@
</ItemGroup>
<ItemGroup>
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410CommandBuilder.h" />
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410Debug.h" />
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410Defs.h" />
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410Types.h" />
</ItemGroup>
<ItemGroup>
<Image Include="$(MSBuildThisFileDirectory)gfx\LD2410.jpg" />
</ItemGroup>
</Project>
29 changes: 28 additions & 1 deletion LD2410Async.vcxitems.filters
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,31 @@
</ItemGroup>
<ItemGroup>
<None Include="$(MSBuildThisFileDirectory)LICENSE" />
<None Include="$(MSBuildThisFileDirectory)README.md" />
<None Include="$(MSBuildThisFileDirectory)examples\changeConfig\changeConfig.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\changeDistanceResolution\changeDistanceResolution.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\receiveData\receiveData.ino" />
<None Include="$(MSBuildThisFileDirectory).gitattributes" />
<None Include="$(MSBuildThisFileDirectory).gitignore" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\build.yml" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\arduinoLint.yml" />
<None Include="$(MSBuildThisFileDirectory)examples\basicPresenceDetection\basicPresenceDetection.ino" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\generateDoxygenDocu.yml" />
<None Include="$(MSBuildThisFileDirectory)Doxyfile" />
<None Include="$(MSBuildThisFileDirectory)examples\simplePresenceDetectionWebservice\simplePresenceDetectionWebservice.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\unitTest\unitTest.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\tortureTest\tortureTest.ino" />
<None Include="$(MSBuildThisFileDirectory)examples\enableConfigModeTest\enableConfigModeTest.ino" />
<None Include="$(MSBuildThisFileDirectory)dox\Async Commands And Processing.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Data Structures.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Inactivity Handling.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Installation.md" />
<None Include="$(MSBuildThisFileDirectory)dox\mainPage.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Notes And Best Practices.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Operation Modes.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Troubleshooting.md" />
<None Include="$(MSBuildThisFileDirectory)README.md" />
<None Include="$(MSBuildThisFileDirectory)dox\Examples.md" />
<None Include="$(MSBuildThisFileDirectory).github\workflows\createRelease.yml" />
</ItemGroup>
<ItemGroup>
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410CommandBuilder.h">
Expand All @@ -39,5 +57,14 @@
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410Defs.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410Types.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="$(MSBuildThisFileDirectory)src\LD2410Debug.h">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<Image Include="$(MSBuildThisFileDirectory)gfx\LD2410.jpg" />
</ItemGroup>
</Project>
Loading