Merge branch 'master' into asian-frequency-plans

Author: jpmeijers

docs/TheThingsNetwork.md

@@ -1,19 +1,19 @@
 # API Reference
 
-The `TheThingsNetwork` class enables Arduino devices with supported LoRa modules to communicate via The Things Network.
+The `TheThingsNetwork` class enables Arduino devices with supported LoRaWAN modules to communicate via The Things Network. Currently supported LoRaWAN modules are the Microchip RN2483 and the RN2903.
 
 ## Class: `TheThingsNetwork`
 
-Include and instantiate the TheThingsNetwork class. The constructor initialize the library with the Streams it should communicate with. It also sets the value of the spreading factor, the front-side Bus and the frequency plan.
+Include and instantiate the TheThingsNetwork class. The constructor initialize the library with the Streams it should communicate with. It also sets the value of the spreading factor, the frequency plan and the frequency sub-band.
 
 ```c
 #include <TheThingsNetwork.h>
 
 TheThingsNetwork ttn(Stream& modemStream, Stream& debugStream, fp_ttn_t fp, uint8_t sf = 7, uint8_t fsb = 2);
 ```
 
-- `Stream& modemStream`: Stream for the LoRa modem (for The Things Node/Uno use `Serial1` and data rate `57600`).
-- `Stream& debugStream`: Stream to write debug logs to (for The Things Node/Uno use `Serial` and data rate `9600`).
+- `Stream& modemStream`: Stream for the LoRa modem ([see notes](https://www.thethingsnetwork.org/docs/devices/arduino/usage.html)).
+- `Stream& debugStream`: Stream to write debug logs to ([see notes](https://www.thethingsnetwork.org/docs/devices/arduino/usage.html)).
 - `fp_ttn_fp fp`: The frequency plan: `TTN_FP_EU868`, `TTN_FP_US915`, `TTN_FP_AS920_923`, `TTN_FP_AS923_925` or `TTN_FP_KR920_923` depending on the region you deploy in. See [the wiki](https://www.thethingsnetwork.org/wiki/LoRaWAN/Frequencies/Frequency-Plans).
 - `uint8_t sf = 7`: Optional custom spreading factor. Can be `7` to `10` for `TTN_FP_US915` and `7` to `12` for other frequency plans. Defaults to `7`.
 - `uint8_t fsb = 2`: Optional custom frequency subband. Can be `1` to `8`. Defaults to `2` (for US915).
@@ -61,7 +61,6 @@ Band: 868
 Data Rate: 5
 RX Delay 1: 1000
 RX Delay 2: 2000
-Total airtime: 0.00 s
 ```
 
 See the [DeviceInfo](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/DeviceInfo/DeviceInfo.ino) example.
@@ -140,8 +139,6 @@ Returns a success or error code and logs the related error message:
 
 See the [Send](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/Send/Send.ino) example.
 
-Also in sendBytes, due to TTN's 30 second fair access policy, we update the airtime each time we uplink a message. This airtime is based on a lot of variables but the most important ones are the spreading factor and the size of the message, the higher it is the less messages you can send in 30 seconds (SF7 around 500 messages of 8 bytes, SF12 around 20 messages of 8 bytes).
-
 ## Method: `poll`
 
 Calls `sendBytes()` with `{ 0x00 }` as payload to poll for incoming messages.

examples/TheThingsMessage/Receive/Receive.ino

@@ -17,7 +17,7 @@ devicedata_t data = api_DeviceData_init_default;
 
 void setup()
 {
-  pinMode(TTN_PIN_LED, INPUT);
+  pinMode(LED_BUILTIN, INPUT);
 
   loraSerial.begin(57600);
   debugSerial.begin(9600);
@@ -41,7 +41,7 @@ void setup()
 void loop()
 {
   // Read sensors
-  data.motion = digitalRead(TTN_PIN_LED) == HIGH;
+  data.motion = digitalRead(LED_BUILTIN) == HIGH;
   data.water = 682;
 
   // Encode data
@@ -63,4 +63,4 @@ void message(const uint8_t *payload, size_t length, port_t port)
     appdata_t appData = api_AppData_init_default;
     TheThingsMessage::decodeAppData(&appData, payload, length);
   }
-}
+}

library.properties

@@ -1,5 +1,5 @@
 name=TheThingsNetwork
-version=2.5.1
+version=2.5.2
 author=The Things Network
 maintainer=Johan Stokking <[email protected]>
 sentence=The Things Network Arduino Library.

src/TheThingsMessage.cpp

@@ -10,7 +10,9 @@ bool TheThingsMessage::decodeAppData(appdata_t *receiveData, const byte *payload
   {
     return false;
   }
-  receiveData->light ? digitalWrite(TTN_PIN_LED, HIGH) : digitalWrite(TTN_PIN_LED, LOW);
+#ifdef LED_BUILTIN
+  receiveData->light ? digitalWrite(LED_BUILTIN, HIGH) : digitalWrite(LED_BUILTIN, LOW);
+#endif
   return true;
 }
 

src/TheThingsMessage.h

@@ -11,8 +11,6 @@
 #include "deviceData.pb.h"
 #include "appData.pb.h"
 
-#define TTN_PIN_LED LED_BUILTIN
-
 typedef api_DeviceData devicedata_t;
 typedef api_AppData appdata_t;