This directory contains documentation on the use and implementation of the LMIC.
Online browsable documentation (including API docs generated by Doxygen) is available at the GitHub Pages site.
- Configuration Reference -- compile-time settings for region, radio, LoRaWAN version, and all
LMIC_ENABLE_*/DISABLE_*macros - Timing -- protocol timing, clock error compensation, and interrupt handling
- Class C Guide -- Class C continuous receive mode: compile-time and runtime configuration, API reference, usage examples
- Hardware Configuration -- wiring, pin mapping, and
HalConfiguration_tfor non-pre-integrated boards - Encoding Utilities --
sflt16,uflt16,sflt12,uflt12format descriptions and JavaScript decoder functions - Adding Regions -- step-by-step guide for adding a new LoRaWAN regional configuration
LMIC-v5.0.0.pdf-- API documentation (based on original IBM documentation, adapted for this library). Note: update to v6.0.0 is pending.LMIC-v5.0.0-redline.pdf-- changes since last document update, marked up by Litera Workshare Compare.
RadioDriver.md-- radio driver interface specification (os_radio()commands, parameters, and results)
LMIC-structure-diagram.pdf-- structural diagram of the LMIC (UML-like, created with Cadifra)LMIC-FSM.pdf-- operating logic modeled as a finite state machine. As of version 3.2, this model is idealized; the actual implementation uses event callbacks viaos_setCallback()/os_setTimedCallback().LoRaWAN-at-a-glance.pdf-- wall chart summarizing key features of the LoRaWAN 1.0.3 protocol (source: Visio file)
../src/se/README.md-- overview of the secure element abstraction and driver tree
IBM-DISCLAIMER.txtandIBM-release-notes.txtare artifacts of the original IBM distribution, retained for reference.
Source files are included for documents that have separate sources.
- The source for the API documentation is a Microsoft Word file.
- The source for "LoRaWAN at a glance" is a Visio file.
- The sources for LMIC-FSM and LMIC-structure are Cadifra files.