Repository files navigation

This library provides support for LoRaWAN communication using theSTM32WL55 microcontroller (with embedded LoRa radio) inside the Arduinodevelop environment (together with thestm32duinocore with version2.4.0 or later).

This library offers an API that is highly similar to the API offered bytheArduino MKRWANlibrary(including undocumented methods) so any sketches written for eitherlibrary should usually work on the other too (but note below for somecaveats).

Overview and reference documentation is embedded in the source code andcan beviewed online on Github.

To generate the documentation yourself, simply run thedoxygen command(no options needed) in the root of this repository. This will produceHTML documentation in theapi-docs subdirectory.

This repository is set up to run some checks in github workflowsautomatically. You can also run them locally as follows.

For codespell spell checking, just run the command without options, itwill tell you about any spelling errors in the code.

codespell

For astyle, you need to pass a few options. This will automatically fixstyle errors, so this is probably best done after staging all changes,so you can easily see what was changed. Add--dry-run to only seewhich files need to be changed (does not display the changes made,though).

astyle --project=.astylerc --recursive '*.c' '*.h' '*.ino'

(you can also setARTISTIC_STYLE_PROJECT_OPTIONS=.astylerc in yourenvironment and omit--project option)

This library is based on LoRaMac-node developed by semtech, withextensive modifications and additions made by STMicroelectronics.

All code included in this library is licensed under theRevised BSDlicense, the full licensetext can be found in theLICENSE file and in individual source filesas well.