Skip to content

Update doc/README.md #614

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Dec 5, 2020
Merged

Update doc/README.md #614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This directory contains documentation on the use and implementation of the LMIC.

## Usage documentation

- [`LMIC-v3.0.99.pdf`](./LoRaWAN-v3.0.99.pdf): API documentation on the LMIC as of 3.0.99. Generally the differences between 3.0.99 and 3.2 were bug fixes.
- [`LMIC-v3.0.99.pdf`](./LMIC-v3.0.99.pdf): API documentation on the LMIC as of 3.0.99. Generally the differences between 3.0.99 and 3.2 were bug fixes.

## Background information

Expand All @@ -13,7 +13,7 @@ This directory contains documentation on the use and implementation of the LMIC.
## Implementation documentation

- [`RadioDriver.md`](./RadioDriver.md): documentation of the radio driver interface.
- [`LMIC-structure.pdf`](./LMIC-structure.pdf): a structural diagram of the LMIC. This is somewhat UML like.
- [`LMIC-structure-diagram.pdf`](./LMIC-structure-diagram.pdf): a structural diagram of the LMIC. This is somewhat UML like.
- [`LMIC-FSM.pdf`](./LMIC-FSM.pdf): the operating logic of the LMIC, modeled as a finite state machine. As of version 3.2, this model is idealized; the actual implementation is not an explicit state machine. However, if you search for `os_setCallback()` and `os_setTimedCallback()`, you will see the links between event callbacks, and that will generally correspond to the implementation. The FSM diagram doesn't show class-B or class-C operation as yet.

## Historical information
Expand Down