STM32LoRaWAN

STM32Lorawan -Bibliothek

Diese Bibliothek unterstützt die Lorawan -Kommunikation mithilfe des STM32WL55 -Mikrocontroller (mit eingebettetem Lora -Radio) innerhalb der Umgebung von Arduino Develop (zusammen mit dem STM32Duino -Kern mit Version 2.4.0 oder höher).

Diese Bibliothek bietet eine API, die der API der Arduino MKRWAN -Bibliothek (einschließlich undokumentierter Methoden) sehr ähnlich ist, sodass alle für beide Bibliotheken geschriebenen Skizzen in der Regel auch zum anderen funktionieren sollten (jedoch nach unten für einige Vorbehalte).

Dokumentation

Übersicht und Referenzdokumentation ist in den Quellcode eingebettet und kann online unter GitHub angezeigt werden.

Um die Dokumentation selbst zu generieren, führen Sie einfach den Befehl doxygen (keine Optionen erforderlich) im Stamm dieses Repositorys aus. Dadurch werden die HTML-Dokumentation im Subdadum der api-docs erstellt.

Ausführen von Schecks

Dieses Repository ist so eingerichtet, dass einige Schecks in GitHub -Workflows automatisch ausgeführt werden. Sie können sie auch lokal wie folgt ausführen.

Führen Sie den Befehl einfach ohne Optionen aus, wenn Sie die Rechtschreibfehler im Code ohne Optionen ausführen.

 codespell

Für Astyle müssen Sie einige Optionen übergeben. Dies wird automatisch Stilfehler beheben, sodass dies wahrscheinlich am besten nach der Inszenierung aller Änderungen durchgeführt wird, sodass Sie leicht sehen können, was sich geändert hat. Hinzufügen --dry-run um nur zu sehen, welche Dateien geändert werden müssen (zeigten jedoch nicht die vorgenommenen Änderungen an).

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

(Sie können auch ARTISTIC_STYLE_PROJECT_OPTIONS=.astylerc in Ihrer Umgebung und weglassen --project -Option)

Lizenz

Diese Bibliothek basiert auf Loramac-Node, die von Semtech entwickelt wurden und mit umfangreichen Modifikationen und Ergänzungen von STMICROELECRECTRONICS vorgenommen werden.

Der in dieser Bibliothek enthaltene Code ist unter der überarbeiteten BSD -Lizenz lizenziert. Der vollständige Lizenztext befindet sich auch in der Lizenzdatei und auch in einzelnen Quelldateien.