Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete first version #3

Merged
merged 73 commits into from
Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from 71 commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
8b876c7
astyle: Add configuration
matthijskooijman Sep 14, 2022
601b444
Add BSP code
matthijskooijman Jun 23, 2022
44cc7e7
update.sh: Add script
matthijskooijman Jun 23, 2022
fc8f214
fix-includes.py: Add script
matthijskooijman Jun 23, 2022
681f7cd
Add STM32CubeWL 1.2.0 code verbatim
matthijskooijman Jun 23, 2022
0961053
Add timer driver based on RTC HAL
matthijskooijman Jun 23, 2022
bad5c4a
STM32LoRaWAN: Add main library class
matthijskooijman Jun 23, 2022
1de4cff
First: Add initial example
matthijskooijman Jun 23, 2022
ad79b77
Make timer_if debug printing work
matthijskooijman Aug 2, 2022
126f539
Doxyfile: Add default doxygen configuration
matthijskooijman Aug 11, 2022
f70a76b
Doxyfile: Configure for this project
matthijskooijman Aug 11, 2022
3133a1f
STM32LoRaWAN: Make class mostly complete
matthijskooijman Aug 11, 2022
f365b4e
Add more debug output
matthijskooijman Aug 11, 2022
a3846bd
workflows: Publish doxygen docs to Github Pages
matthijskooijman Aug 30, 2022
8701813
STM32LoRaWAN::joinOTAA: Make blocking
matthijskooijman Sep 1, 2022
220e5f9
STM32LoRaWAN::send: Expand ternary if
matthijskooijman Sep 1, 2022
8bb12a3
STM32LoRaWAN::MacMcpsIndication: Fix typo rx port variable
matthijskooijman Sep 1, 2022
99813f4
STM32LoRaWAN::dutyCycle: Fix warning doxygen tag
matthijskooijman Sep 1, 2022
78820f0
STM32LoRaWAN: Fix naming convention for nwk_key_set
matthijskooijman Sep 1, 2022
3da4dfa
STM32LoRaWAN::endPacket: Make blocking
matthijskooijman Sep 1, 2022
b5be8c8
STM32LoRaWAN::failure: Add printf format attribute
matthijskooijman Sep 2, 2022
60218eb
STM32LoRaWAN: Implement channel management
matthijskooijman Sep 2, 2022
931f366
STM32LoRaWAN: Remove unneeded doxygen comment
matthijskooijman Sep 2, 2022
bee59ff
STM32LoRaWAN: Remove resolved TODO
matthijskooijman Sep 2, 2022
c906403
LoraSendAndReceive: add example
matthijskooijman Sep 2, 2022
cf3236a
STM32LoRaWAN: Implement frame counter querying
matthijskooijman Sep 2, 2022
1f56e3e
STM32LoRaWAN: Implement MacProcessNotify callback
matthijskooijman Sep 2, 2022
39f9914
docs: Add some overview documentation (incomplete)
matthijskooijman Sep 2, 2022
5d640e7
BSP: remove some outdated TODOs
matthijskooijman Sep 2, 2022
e99f789
STM32LoRaWAN: Reorder methods for doxygen
matthijskooijman Sep 2, 2022
efd85ab
Basic: Rename First.ino example to Basic
matthijskooijman Sep 12, 2022
95b81c0
Basic: Improve example
matthijskooijman Sep 12, 2022
5c92a61
README: Clarify license
matthijskooijman Sep 12, 2022
5cc542f
STM32LoRaWAN: Add license header to main library files
matthijskooijman Sep 12, 2022
915ade7
STM32LoRaWAN::setMaintainNeededCallback: Add method
matthijskooijman Sep 12, 2022
8adffe1
STM32LoRaWAN: Fix comment typo
matthijskooijman Sep 12, 2022
207bf46
docs: Make overview documentation complete
matthijskooijman Sep 12, 2022
ee2756e
README: Point to doxygen documentation
matthijskooijman Sep 12, 2022
2642d5d
Doxygen: Disable all graphs
matthijskooijman Sep 12, 2022
4769b4a
codespell: Move options into .codespellrc
matthijskooijman Sep 12, 2022
2505c1b
STM32LoRaWAN: Fix comment typos
matthijskooijman Sep 12, 2022
b7752d7
Revert parts of "Add more debug output"
matthijskooijman Sep 13, 2022
181af28
STM32CubeWL: Add additional debug output
matthijskooijman Sep 13, 2022
f58f57e
STM32CubeWL: Fix RX timing issue due to relative timestamps
matthijskooijman Sep 13, 2022
00b82ff
STM32LoRaWAN: Add some more \NotInMKRWAN tags
matthijskooijman Sep 13, 2022
51abd8a
Basic: Halt when join fails
matthijskooijman Sep 13, 2022
fe823ab
Basic: Remove trailing space on RX data line
matthijskooijman Sep 13, 2022
752b5d3
Basic: Leave datarate set at default
matthijskooijman Sep 13, 2022
93b0e4e
Basic: Report failure of endPacket()
matthijskooijman Sep 13, 2022
6365b06
SimpleAsync: Add example of async API
matthijskooijman Sep 14, 2022
54d994b
ScheduledAsync: Add more complex asynchronous example
matthijskooijman Sep 14, 2022
34af18f
STM32LoRaWAN::send: Fix printf format in error message
matthijskooijman Sep 14, 2022
2d3ee27
STM32LoRaWAN::powerdB: Document valid value range
matthijskooijman Sep 14, 2022
e0f4493
STM32LoRaWAN::setMaintainNeededCallback: Implement
matthijskooijman Sep 14, 2022
62d3909
STM32LoRaWAN::joinOTAA: Slightly improve ordering in comment
matthijskooijman Sep 14, 2022
c656238
docs: Document how duty cycles are enforced
matthijskooijman Sep 14, 2022
a983513
docs: Fix comment typos
matthijskooijman Sep 14, 2022
3540bfc
Basic: Remove unused include
matthijskooijman Sep 14, 2022
f46ac85
LoraSendAndReceive: Update comment
matthijskooijman Sep 14, 2022
6a8c48d
docs: Document the new async examples
matthijskooijman Sep 14, 2022
25f6598
Basic: Check return value of joinOTAA/joinABP
matthijskooijman Sep 14, 2022
94db740
workflows: Run astyle check
matthijskooijman Sep 14, 2022
8d90ad8
README: Document codespell and astyle
matthijskooijman Sep 14, 2022
b33c65c
ignore-unused-warning.py: Add script
fpistm Sep 23, 2022
2862d94
STM32CubeWL: Run ignore-unused-warning.py
matthijskooijman Sep 27, 2022
59a3a39
BSP: Fix unused argument warnings in timer_if
matthijskooijman Sep 27, 2022
930687a
STM32CubeWL: Fix printf format warnings
matthijskooijman Sep 27, 2022
9835779
fixup! ScheduledAsync: Add more complex asynchronous example
matthijskooijman Sep 27, 2022
b5c582c
fixup! SimpleAsync: Add example of async API
matthijskooijman Sep 27, 2022
ec4d855
LoraSendAndReceive: Remove call to deprecated minPollInterval
matthijskooijman Sep 27, 2022
5436c82
LoraSendAndReceive: Fix signed vs unsigned warning
matthijskooijman Sep 27, 2022
68f73d0
STM32LoRaWAN: add keywords.txt
fpistm Oct 5, 2022
627602b
fix(docs): remove doxygen warnings
fpistm Oct 6, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 67 additions & 0 deletions .astylerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# STM32duino code style definition file for astyle

# Don't create backup files, let git handle it
suffix=none

# K&R style
style=kr

# 1 TBS addition to k&r, add braces to one liners
# Use -j as it was changed in astyle from brackets to braces, this way it is compatible with older astyle versions
-j

# 2 spaces, convert tabs to spaces
indent=spaces=2
convert-tabs
lineend=linux

# Indent switches and cases
indent-classes
indent-switches
indent-cases
indent-col1-comments
indent-preproc-block

# Remove spaces in and around parentheses
unpad-paren

# Insert a space after if, while, for, and around operators
pad-header
pad-oper

# Pointer/reference operators go next to the name (on the right)
align-pointer=name
align-reference=name

# Attach { for classes and namespaces
attach-namespaces
attach-classes

# Extend longer lines, define maximum 120 value. This results in aligned code,
# otherwise the lines are broken and not consistent
max-continuation-indent=120

# if you like one-liners, keep them
keep-one-line-statements

#remove-comment-prefix

# Do not error our when a directory is excluded that does not contain
# any files to process
ignore-exclude-errors

# Exclude some files
exclude=.git
exclude=docs
exclude=api-docs
# These files are taken verbatim from STM32CubeWL, so minimize changes
# to them
exclude=src/STM32CubeWL
exclude=src/BSP/timer_if.c
exclude=src/BSP/timer_if.h
exclude=src/BSP/rtc.c
exclude=src/BSP/rtc.h

# Allow oneline blocks, to allow very small functions to be defined
# on a single line in header files.
keep-one-line-blocks
7 changes: 7 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[codespell]
skip = ./src/STM32CubeWL,./src/BSP/timer_if.*,./api-docs,./.git
# The presence of these values enables them
check-filenames =
check-hidden =
# In the event of a false positive, add the word in all lower case to this value (comma-separated string)
ignore-words-list = wan
6 changes: 0 additions & 6 deletions .github/workflows/CodeSpell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,3 @@ jobs:
# See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
- name: Spell check
uses: codespell-project/actions-codespell@master
with:
check_filenames: true
check_hidden: true
# In the event of a false positive, add the word in all lower case to this file:
ignore-words-list: "./extras/codespell-ignore-words-list.txt"
exclude_file: src/STM32CubeWL
16 changes: 16 additions & 0 deletions .github/workflows/check-astyle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Check code formatting with astyle

on:
push

jobs:
check:
name: Check for astyle errors
runs-on: ubuntu-latest

steps:
- run: sudo apt install astyle
- uses: actions/checkout@v3
- run: astyle --project=.astylerc --recursive '*.c' '*.h' '*.ino'
# If anything changed, this will fail and show the needed changes
- run: git diff --exit-code
15 changes: 15 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Doxygen GitHub Pages Deploy Action

on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: DenverCoder1/doxygen-github-pages-action@v1.1.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
folder: api-docs