Skip to content

Commit 86edfc7

Browse files
committed
Fix #633: prepare for v3.3.0 release
1 parent 30de518 commit 86edfc7

File tree

3 files changed

+29
-6
lines changed

3 files changed

+29
-6
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,21 @@ modified to run in the Arduino environment, allowing using the SX1272,
55
SX1276 transceivers and compatible modules (such as some HopeRF RFM9x
66
modules and the Murata LoRa modules).
77

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
913
attempt to wrap them in a higher level API that is more in the Arduino
1014
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.
1216

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.
1418

1519
This library requires Arduino IDE version 1.6.6 or above, since it
1620
requires C99 mode to be enabled by default.
1721

18-
[![GitHub release](https://img.shields.io/github/release/mcci-catena/arduino-lmic.svg)](https://github.com/mcci-catena/arduino-lmic/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/arduino-lmic/latest.svg)](https://github.com/mcci-catena/arduino-lmic/compare/v3.2.0...master) [![Build Status](https://travis-ci.com/mcci-catena/arduino-lmic.svg?branch=master)](https://travis-ci.com/mcci-catena/arduino-lmic)
22+
[![GitHub release](https://img.shields.io/github/release/mcci-catena/arduino-lmic.svg)](https://github.com/mcci-catena/arduino-lmic/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/arduino-lmic/latest.svg)](https://github.com/mcci-catena/arduino-lmic/compare/v3.3.0...master) [![Build Status](https://travis-ci.com/mcci-catena/arduino-lmic.svg?branch=master)](https://travis-ci.com/mcci-catena/arduino-lmic)
1923

2024
**Contents:**
2125

@@ -33,6 +37,9 @@ requires C99 mode to be enabled by default.
3337
<!-- TOC depthFrom:2 updateOnSave:true -->
3438

3539
- [Installing](#installing)
40+
- [Getting Help](#getting-help)
41+
- [If it's not working](#if-its-not-working)
42+
- [If you've found a bug](#if-youve-found-a-bug)
3643
- [Features](#features)
3744
- [Additional Documentation](#additional-documentation)
3845
- [PDF/Word Documentation](#pdfword-documentation)
@@ -120,6 +127,16 @@ To install this library:
120127

121128
For more info, see [https://www.arduino.cc/en/Guide/Libraries](https://www.arduino.cc/en/Guide/Libraries).
122129

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+
123140
## Features
124141

125142
The LMIC library provides a fairly complete LoRaWAN Class A and Class B
@@ -1220,6 +1237,12 @@ function uflt12f(rawUflt12)
12201237

12211238
## Release History
12221239

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+
12231246
- v3.2.0 has the following changes:
12241247

12251248
- [#550](https://github.com/mcci-catena/arduino-lmic/issue/550) fixes debug prints in `ttn-otaa.ino`.

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=MCCI LoRaWAN LMIC library
2-
version=3.2.0
2+
version=3.3.0
33
author=IBM, Matthijs Kooijman, Terry Moore, ChaeHee Won, Frank Rose
44
maintainer=Terry Moore <[email protected]>
55
sentence=Arduino port of the LMIC (LoraWAN-MAC-in-C) framework provided by IBM.

src/lmic/lmic.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ extern "C"{
105105
#define ARDUINO_LMIC_VERSION_CALC(major, minor, patch, local) \
106106
((((major)*UINT32_C(1)) << 24) | (((minor)*UINT32_C(1)) << 16) | (((patch)*UINT32_C(1)) << 8) | (((local)*UINT32_C(1)) << 0))
107107

108-
#define ARDUINO_LMIC_VERSION ARDUINO_LMIC_VERSION_CALC(3, 2, 0, 0) /* v3.2.0 */
108+
#define ARDUINO_LMIC_VERSION ARDUINO_LMIC_VERSION_CALC(3, 3, 0, 0) /* v3.3.0 */
109109

110110
#define ARDUINO_LMIC_VERSION_GET_MAJOR(v) \
111111
((((v)*UINT32_C(1)) >> 24u) & 0xFFu)

0 commit comments

Comments
 (0)