You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-4Lines changed: 27 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,21 @@ modified to run in the Arduino environment, allowing using the SX1272,
5
5
SX1276 transceivers and compatible modules (such as some HopeRF RFM9x
6
6
modules and the Murata LoRa modules).
7
7
8
-
This library mostly exposes the functions defined by LMIC, it makes no
8
+
Information about the LoRaWAN protocol is summarized in [LoRaWAN-at-a-glance](doc/LoRaWAN-at-a-glance.pdf). Full information is available from the [LoRa Alliance](https://lora-alliance.org).
9
+
10
+
A support forum is available at [forum.mcci.io](https://forum.mcci.io/c/device-software/arduino-lmic/5).
11
+
12
+
The base Arduino library mostly exposes the functions defined by LMIC. It makes no
9
13
attempt to wrap them in a higher level API that is more in the Arduino
10
14
style. To find out how to use the library itself, see the examples, or
11
-
see the PDF file in the doc subdirectory.
15
+
see the PDF files in the doc subdirectory.
12
16
13
-
The [MCCI `arduino-lorawan`](https://github.com/mcci-catena/arduino-lorawan) library provides a higher level, more Arduino-like wrapper which may be useful.
17
+
A separate library, [MCCI `arduino-lorawan`](https://github.com/mcci-catena/arduino-lorawan), provides a higher level, more Arduino-like wrapper which may be useful.
14
18
15
19
This library requires Arduino IDE version 1.6.6 or above, since it
For more info, see [https://www.arduino.cc/en/Guide/Libraries](https://www.arduino.cc/en/Guide/Libraries).
122
129
130
+
## Getting Help
131
+
132
+
### If it's not working
133
+
134
+
Ask questions at [`forum.mcci.io`](https://forum.mcci.io/c/device-software/arduino-lmic/5). Wireless is tricky, so don't be afraid to ask. The LMIC has been used successfully in a lot of applications, but it's common to have problems getting it working. To keep the code size down, there are not a lot of debugging features, and the features are not always easy to use.
135
+
136
+
### If you've found a bug
137
+
138
+
Raise a GitHub issue at [`github.com/mcci-catena/arduino-lmic`](https://github.com/mcci-catena/arduino-lmic/issues/).
139
+
123
140
## Features
124
141
125
142
The LMIC library provides a fairly complete LoRaWAN Class A and Class B
@@ -1220,6 +1237,12 @@ function uflt12f(rawUflt12)
1220
1237
1221
1238
## Release History
1222
1239
1240
+
- v3.3.0 is primarily a maintenance and roll-up release.
1241
+
1242
+
- Added [LoRaWAN-at-a-glance](doc/LoRaWAN-at-a-glance.pdf) and a [state diagram of the LMIC](doc/LMIC-FSM.pdf).
1243
+
- Several PRs from Matthijs Kooijman to improve compatibility with the original Arduino LMIC ([#608](https://github.com/mcci-catena/arduino-lmic/issue/608), [#609](https://github.com/mcci-catena/arduino-lmic/issue/609)).
1244
+
- Numerous documentation improvements contributed by the community ([#431](https://github.com/mcci-catena/arduino-lmic/issue/), [#612](https://github.com/mcci-catena/arduino-lmic/issue/612), [#614](https://github.com/mcci-catena/arduino-lmic/issue/614), [#625](https://github.com/mcci-catena/arduino-lmic/issue/625)).
1245
+
1223
1246
- v3.2.0 has the following changes:
1224
1247
1225
1248
-[#550](https://github.com/mcci-catena/arduino-lmic/issue/550) fixes debug prints in `ttn-otaa.ino`.
0 commit comments