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: .github/ISSUE_TEMPLATE/00-support-request.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,19 @@ assignees: terrillmoore
7
7
8
8
---
9
9
10
+
**Consider raising support questions on the forum first**
11
+
12
+
There is a discussion site, [forum.mcci.io](https://forum.mcci.io), which includes a [category focused on the Arduino LMIC](https://forum.mcci.io/c/device-software/arduino-lmic/5). Unless you're sure that your problem is a bug in the LMIC, it would be great if you can try for help there first. That will keep issues focused on work that needs to be done by the developers.
13
+
10
14
**Describe your question or issue**
11
-
A clear and concise description of the problem you're facing and what you'd like help with.
15
+
16
+
Please give a clear and concise description of the problem you're facing and what you'd like help with.
12
17
13
18
**Environment**
14
19
15
-
This information is all important; it's hard to help without a complete set of answers.
20
+
This information is very important; it's hard to help without a complete set of answers.
16
21
17
-
- Version of LMIC being used:
22
+
- Version of LMIC being used. If using the latest github mainline, let us know, otherwise state the version.
18
23
- Version of Arduino IDE being used:
19
24
- Network provider (The Things Network, Swisscom, ChirpStack, etc.)
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/10-bug_report.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,28 +9,32 @@ assignees: terrillmoore
9
9
10
10
**Describe the bug**
11
11
12
-
A clear and concise description of what the bug is. _If you're not sure it's a bug, please file a Support Request instead._ A bug is a problem in the code, where you do something that the documentation says should work, but doesn't; _and_ you have reason to believe it's not working due to a defect in the code.
12
+
A clear and concise description of what the bug is. _If you're not sure it's a bug, please consider opening a discussion at [forum.mcci.io](https://forum.mcci.io/c/device-software/arduino-lmic/5), or file a Support Request instead._ A bug is a problem in the code, where you do something that the documentation says should work, but doesn't; _and_ you have reason to believe it's not working due to a defect in the code.
13
13
14
14
Wireless is tricky; if in doubt, start with a support request, rather than a bug report.
15
15
16
16
**Environment**
17
17
18
-
- Version of LMIC being used:
19
-
- Version of Arduino IDE being used:
18
+
- Version of LMIC being used. If using the latest GitHub mainline, let us know, otherwise state the version.
19
+
- Version of Arduino IDE being used.
20
20
- Network provider (The Things Network, Swisscom, ChirpStack, etc.)
If this is an existing document, please include the full path to the file.
15
+
16
+
If there's a need for a new document, please suggest the places in existing docs that should link to it.
17
+
18
+
Make sure you mention the version, and please also check the current version at GitHub, to be sure that the problem hasn't already been corrected for a pending release.
19
+
20
+
**What changes are needed?**
21
+
22
+
Indicate the changes you think are needed. Explicit help is always better. File a PR with your changes if possible!
Copy file name to clipboardExpand all lines: README.md
+83-59Lines changed: 83 additions & 59 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
- [Support Open Source Hardware and Software](#support-open-source-hardware-and-software)
111
+
- [Support Open Source Hardware and Software](#support-open-source-hardware-and-software)
105
112
106
113
<!-- /TOC -->
107
114
<!-- markdownlint-restore -->
@@ -120,6 +127,16 @@ To install this library:
120
127
121
128
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
@@ -462,7 +479,7 @@ The following boards are pre-integrated.
> To help you know if you have to worry, we'll call such boards "pre-integrated" and prefix each section with suitable guidance.
482
500
@@ -1220,6 +1238,12 @@ function uflt12f(rawUflt12)
1220
1238
1221
1239
## Release History
1222
1240
1241
+
- v3.3.0 is primarily a maintenance and roll-up release.
1242
+
1243
+
- Added [LoRaWAN-at-a-glance](doc/LoRaWAN-at-a-glance.pdf) and a [state diagram of the LMIC](doc/LMIC-FSM.pdf).
1244
+
- 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)).
1245
+
- 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)).
1246
+
1223
1247
- v3.2.0 has the following changes:
1224
1248
1225
1249
-[#550](https://github.com/mcci-catena/arduino-lmic/issue/550) fixes debug prints in `ttn-otaa.ino`.
0 commit comments