Merge pull request #1 from TheThingsNetwork/master

Merge in from upstream

Author: jpmeijers

.travis.yml

@@ -1,20 +1,35 @@
-language: python
-python:
-    - "2.7"
-
-# Cache PlatformIO packages using Travis CI container-based infrastructure
-sudo: false
-cache:
-    directories:
-        - "~/.platformio"
-
+language: c
 env:
-    - PLATFORMIO_CI_SRC=test/TheThingsNetwork.ino
-    - PLATFORMIO_CI_SRC=test/TheThingsMessage.ino
-
+  - ARDUINO_VERSION=1.6.13
+before_install:
+  - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16"
+  - sleep 3
+  - export DISPLAY=:1.0
+  - wget http://downloads.arduino.cc/arduino-$ARDUINO_VERSION-linux64.tar.xz
+  - tar xf arduino-$ARDUINO_VERSION-linux64.tar.xz
+  - sudo mv arduino-$ARDUINO_VERSION /usr/local/share/arduino
+  - sudo ln -s /usr/local/share/arduino/arduino /usr/local/bin/arduino
 install:
-    - pip install -U platformio
-
+  - ln -s $PWD /usr/local/share/arduino/libraries/TheThingsNetwork
+  - arduino --install-library "DHT sensor library:1.3.0,Adafruit Unified Sensor:1.0.2"
+before_script:
+  # Replace placeholders with actual frequency plan (on Mac OS folow -i by '')
+  - find $PWD/examples -type f -name "*.ino" -exec sed -i 's/REPLACE_ME/TTN_FP_EU868/g' {} +
 script:
-#    - platformio ci --lib=src --board=leonardo --board=sparkfun_promicro8
-    - "echo \"Warning: no test specified\" && exit 0"
+  - test/verify arduino:avr:leonardo examples/SendABP/SendABP.ino
+  - test/verify arduino:avr:leonardo examples/DeviceInfo/DeviceInfo.ino
+  - test/verify arduino:avr:leonardo examples/TheThingsMessage/Receive/Receive.ino
+  - test/verify arduino:avr:leonardo examples/TheThingsMessage/Send/Send.ino
+  - test/verify arduino:avr:leonardo examples/PassThrough/PassThrough.ino
+  - test/verify arduino:avr:leonardo examples/QuickStart/QuickStart.ino
+  - test/verify arduino:avr:leonardo examples/Receive/Receive.ino
+  - test/verify arduino:avr:leonardo examples/SendOTAA/SendOTAA.ino
+  - test/verify arduino:avr:leonardo examples/Sensors/DHT/DHT.ino
+  - test/verify arduino:avr:leonardo examples/Sensors/LightSensor/LightSensor.ino
+  - test/verify arduino:avr:leonardo examples/Workshop/Workshop.ino
+  - test/verify arduino:avr:leonardo test/TheThingsMessage/TheThingsMessage.ino
+  - test/verify arduino:avr:leonardo test/TheThingsNetwork/TheThingsNetwork.ino
+notifications:
+  email:
+    on_success: change
+    on_failure: change

AUTHORS

@@ -1,2 +1,3 @@
 Johan Stokking <johan@thethingsnetwork.org>
 Fokke Zandbergen <mail@fokkezb.nl>
+Alessandro Blason <mrblason@gmail.com>

CONTRIBUTING.md

@@ -1,6 +1,9 @@
 ## Contributing
 
-We'd ❤️ to welcome your contribution. Please make sure you:
+We'd ❤️ to welcome your contribution. Please make sure your changes include:
 
-1.  Keep [keywords.txt](../keywords.txt) up to date with your changes.
-2.  Keep [API.md](../API.md) up to date with your changes.
+1.  Examples: [examples](examples)
+2.  Syntax highlighting: [keywords.txt](keywords.txt)
+3.  Documentation: [docs](docs)
+4.  Tests: [test](test)
+5.  Verification of the examples and tests: [.travis.yml](.travis.yml)

README.md

@@ -1,7 +1,7 @@
 # The Things Network Arduino Library
 [![Build Status](https://travis-ci.org/TheThingsNetwork/arduino-device-lib.svg?branch=master)](https://travis-ci.org/TheThingsNetwork/arduino-device-lib)
 
-This is an [Arduino Library](https://www.arduino.cc/en/Guide/Libraries) for Arduino-compatible devices like [The Things Uno](https://shop.thethingsnetwork.com/index.php/product/the-things-uno/) and [Node](https://shop.thethingsnetwork.com/index.php/product/the-things-node/) to communicate via [The Things Network](https://www.thethingsnetwork.org).
+This is an [Arduino Library](https://www.arduino.cc/en/Guide/Libraries) for Arduino devices like [The Things Uno](https://www.thethingsnetwork.org/docs/devices/uno/) and [Node](https://www.thethingsnetwork.org/docs/devices/node/) to communicate via [The Things Network](https://www.thethingsnetwork.org).
 
 > At the moment this library requires devices to feature a [Microchip RN2xx3 module](http://www.microchip.com/design-centers/wireless-connectivity/embedded-wireless/lora-technology).
 
@@ -12,7 +12,7 @@ This is an [Arduino Library](https://www.arduino.cc/en/Guide/Libraries) for Ardu
 
 ## Documentation
 
-* [The Things Network Documentation / Arduino](https://www.thethingsnetwork.org/docs/arduino/)
+* [The Things Network Documentation](https://www.thethingsnetwork.org/docs/devices/arduino/)
 * API References:
     * [TheThingsNetwork](docs/TheThingsNetwork.md)
     * [TheThingsMessage](docs/TheThingsMessage.md)

docs/CayenneLPP.md

@@ -0,0 +1,84 @@
+# API Reference
+
+The `CayenneLPP` class enables Arduino devices to encode data with the Cayenne Low Power Payload (LPP). [Read more about Cayenne LPP](https://mydevices.com/cayenne/docs/lora/#lora-cayenne-low-power-payload)
+
+## Class: `CayenneLPP`
+
+Include and instantiate the CayenneLPP class. The constructor takes the size of the allocated buffer. Depending on the LoRa frequency plan and data rate used, the maximum payload varies. It's safe to send up to 51 bytes of payload.
+
+```c
+#include <CayenneLPP.h>
+
+CayenneLPP lpp(uint8_t size);
+```
+
+- `uint8_t size`: The maximum payload size to send, e.g. `51`.
+
+## Example
+
+```c
+TheThingsNetwork ttn(loraSerial, debugSerial, freqPlan);
+CayenneLPP lpp(51);
+
+lpp.reset();
+lpp.addTemperature(1, 22.5);
+lpp.addBarometricPressure(2, 1073.21);
+lpp.addGPS(3, 52.37365, 4.88650, 2);
+
+ttn.sendBytes(lpp.getBuffer(), lpp.getSize());
+```
+
+See the [CayenneLPP](https://github.com/TheThingsNetwork/arduino-device-lib/blob/master/examples/CayenneLPP/CayenneLPP.ino) example. 
+
+## Method: `reset`
+
+Resets the buffer.
+
+```c
+void reset(void);
+```
+
+## Method: `getSize`
+
+Returns the size of the buffer.
+
+```c
+uint8_t getSize(void);
+```
+
+## Method: `getBuffer`
+
+Returns a pointer to the buffer.
+
+```c
+uint8_t *getBuffer(void);
+```
+
+## Method: `copy`
+
+Copies the internal buffer to a specified buffer and returns the copied size.
+
+```c
+uint8_t copy(uint8_t *buffer);
+```
+
+## Methods: `add...`
+
+Add data to the buffer. The `channel` parameter acts as a key for the data field. The data fields you send are dynamic; you can selectively send data as long as the channel matches.
+
+```c
+uint8_t addDigitalInput(uint8_t channel, uint8_t value);
+uint8_t addDigitalOutput(uint8_t channel, uint8_t value);
+
+uint8_t addAnalogInput(uint8_t channel, float value);
+uint8_t addAnalogOutput(uint8_t channel, float value);
+
+uint8_t addLuminosity(uint8_t channel, uint16_t lux);
+uint8_t addPresence(uint8_t channel, uint8_t value);
+uint8_t addTemperature(uint8_t channel, float celsius);
+uint8_t addRelativeHumidity(uint8_t channel, float rh);
+uint8_t addAccelerometer(uint8_t channel, float x, float y, float z);
+uint8_t addBarometricPressure(uint8_t channel, float hpa);
+uint8_t addGyrometer(uint8_t channel, float x, float y, float z);
+uint8_t addGPS(uint8_t channel, float latitude, float longitude, float meters);
+```

docs/RN2903A-1.0.3-AU915.zip

@@ -1,18 +1,18 @@
 # API Reference
-The `TheThingsMessage` class provides structs for sensor and application data you can encode and decode as bytes.
 
-## Class: TheThingsMessage
+## Class: `TheThingsMessage`
+The `TheThingsMessage` class provides structs for sensor and application data you can encode and decode as bytes.
 
 ```c
 #include <TheThingsMessage.h>
 ```
 
-## Type: sensordata_t
+## Type: `devicedata_t`
 
-Create a struct of this type using `api_SensorData_init_default` as defaults.
+Create a struct of this type using `api_DeviceData_init_default` as defaults.
 
 ```c
-sensordata_t data = api_SensorData_init_default;
+devicedata_t data = api_DeviceData_init_default;
 ```
 
 Then in your `setup()` function select what fields of the struct should be included when encoding it as bytes:
@@ -41,21 +41,42 @@ You can also add other analog readings.
 
 > **TODO:** Document how this works and include in example.
 
-## Method: encodeSensorData
+## Method: `encodeDeviceData`
+
 Encode the message you want to send.
 
 ```c
-static void encodeSensorData(sensordata_t *data, byte **buffer, size_t *size);
+static void encodeDeviceData(devicedata_t *data, byte **buffer, size_t *size);
 ```
 
-- `sensordata_t *data`: Structure containing all the message we can send.
-- `const byte **buffer`: Bytes received.
-- `size_t *size`: The number of bytes.
+- `devicedata_t *data`: Structure containing typical fields that devices send.
+- `byte **buffer`: Bytes to send.
+- `size_t *size`: The number of bytes to send.
 
 Usage:
 
 ```c
 byte *buffer;
 size_t size;
-TheThingsMessage::encodeSensorData(&data, &buffer, &size);
+TheThingsMessage::encodeDeviceData(&data, &buffer, &size);
+```
+
+## Method: `decodeAppData`
+
+Decode the message you received.
+
+```c
+static bool decodeAppData(appdata_t *receiveData, const byte *payload, size_t length);
+```
+
+- `appdata_t *receiveData`: Structure containing all the message we can interpret.
+- `const byte *payload`: Bytes received.
+- `size_t *length`: The number of bytes.
+
+Usage:
+
+```c
+const byte *payload;
+size_t length;
+TheThingsMessage::decodeAppData(&receiveData, payload, length);
 ```