Differences

This shows you the differences between two versions of the page.

--- esib_iot_challenge [2017/05/17 09:11] – created samer
+++ esib_iot_challenge [2017/05/23 16:39] – [6.5. Mononoke Challenge] samer
@@ Line 1: / Line 1: @@
 ====== ESIB IoT Challenge ======
-Starting from September 2016, Saint-Joseph University of Beirut (USJ) will be deploying the first academic [[http://www.semtech.com/wireless-rf/internet-of-things/what_is_lora.html | LoRa]] network in Lebanon. The network will support monitoring of micro-climate conditions in vineyards. Here below you can find a detailed description of the experimental platform implementing an end-to-end LoRaWAN solution. The platform consists of the following elements:
+Welcome to the ESIB IoT Challenge. In this challenge, you will be designing and prototyping the first IoT services based on a LoRaWAN network.
+===== -. Platform =====
+During this challenge, you will benefit from the first experimental platform implementing an end-to-end LoRaWAN solution in Lebanon. The platform consists of the following elements:
   * Devices that communicate to one or more gateways via a wireless interface using single hop LoRa and implementing the LoRaWAN protocol. These devices are physically connected to sensors that generate data.
@@ Line 9: / Line 13: @@
 [{{ :lora-pilot-architecture.png?direct&650 | Figure 1. Architecture of the LoRaWAN Platform}}]
-===== -. Devices =====
-==== -. Autonomo with LoRaBee ====
-Starting with the devices in the LoRaWAN platform, we will use an [[http://support.sodaq.com/sodaq-one/autonomо/|Autonomo]] board with a LoRaBee Microchip RN2483 module. According to [[http://shop.sodaq.com]], Autonomo is a matchbox-sized powerhouse which uses the new Atmel Cortex M0+ 32bit micro controller. One advantage of such device is that it can be powered by a smartphone-sized solar panel.
+<WRAP center round help 100%>
+  * Where is the LoRa modulation implemented on the platform?
+  * What are the advantages of the LoRa modulation?
+  * How LoRa is compatible with LPWAN requirements and constraints?
+  * What is LoRaWAN? What is the difference between LoRaWAN and LoRa?
+  * Illustrate the protocol stacks on the LoRaWAN platform.
+  * What elements are IP enabled in the platform? What do you think about IP support in IoT?
+</WRAP>
+===== -. Backend =====
+In a LoRaWAN network, the devices communicate with a Network Server through the gateway. The backend installed in the platform is based on an open-source LoRaWAN network-server https://www.loraserver.io. A web interface is available for configuring the applications and devices on the platform (https://212.98.XX.XX:8080).
-In order to configure the Autonomo with LoRaBee device, you should follow these steps:
+[{{ :app-loraserver.png?direct&600 | Figure 2. Loraserver web interface}}]
-    - Verify that you have the latest Arduino IDE from [[https://www.arduino.cc/en/Main/Software]] on your computer.
+Start by choosing the application named ''NTRE-1617'' to create a new node. You should provide the following information:
-    - Install the board files as noted in [[http://support.sodaq.com/sodaq-one/autonomо/getting-started-autonomo/]].
+  * A unique node name: ''NTRE-GX'' (where ''X'' is your group number)
-    - Add the following library {{ :sodaq_rn2483_2.zip |}} to your Arduino IDE as explained in [[https://www.arduino.cc/en/guide/libraries]].
+  * The node description
+  * A unique device EUI on 64 bits: Random identifiers can be generated on [[https://www.random.org/bytes/]]
+  * The application EUI on 64 bits: ''0badde1cafe2deca''.
+  * A unique application key on 128 bits also obtained by random generation.
+Make sure that the ''ABP activation'' button is unchecked, in order to enable OTAA join method. Finally, in advanced network settings, choose the receive window RX2.
-Now you are ready to write a sketch for the device. Here is one example sketch {{ :test-lorawan-combined-loraserver-example.zip |}} where the autonomo is connected to three sensors: light, moisture, and temperature. Let us analyse some extracts of the code.
+<WRAP left round help 100%>
+  * What does the application EUI mean? How is it used in LoRaWAN?
+  * What does the application key mean? How is it used in LoRaWAN security?
+  * Compare the two device activation methods used in LoRaWAN by giving the advantages and inconvenients.
+  * What is the difference between the two receive windows in LoRaWAN? What are they used for?
+</WRAP>
+===== -. Devices =====
-In this part, you should put the keys for Over-The-Air Activation (OTAA) as explained in the {{ :lorawan102-20161012_1398_1.pdf |LoRaWAN specification}}:
+Devices in the LoRaWAN platform are implemented on Arduino boards with Dragino shields. The combined module as well as the basic configuration steps are presented in [[simple_lora_prototype|Simple Prototype of LoRa Communications]].
-<code c++>
-// USE YOUR OWN KEYS!
-const uint8_t devEUI[8] =
-{ };
-// USE YOUR OWN KEYS!
+Start by verifying the installation on your PC of the latest Arduino IDE. Drop the Arduino LMIC library in the corresponding folder. These tools are provided at the beginning of the challenge. Open the example sketch ''example-code-ntre-iot-challenge.ino'' with Arduino IDE.
-const uint8_t appEUI[8] =
-{ };
-const uint8_t appKey[16] =
+<WRAP left round help 100%>
-{ };
+  * Give the characteristics of the Arduino you are using: model, number of pins, type of pins, memory sizes, etc.
-</code>
+  * Give the main characteristics of the LoRa shield from Dragino (www.dragino.com).
+  * What type of Antenna are you using? Explain the corresponding characteristics.
-The pins for connecting the sensors are specified in these declarations (A0 for light sensor, A2 for moisture sensor, and D0 temperature sensor):
+</WRAP>
-<code c++>
-int light_pin = A0;
-int moisture_pin = A2;
-int temperature_pin = 0;
-int temperature_vcc_pin = 1;
-int moisture_vcc_pin = 8;
-int moisture_gnd_pin = 7;
-</code>
-The OTAA method is used for joining the network and Adaptive Data Rate (ADR) is activated:
+Now you should configure your device with the same identifiers ''APPEUI'', ''DEVEUI'', and ''APPKEY'' as in the backend:
-<code c++>
-LoRaBee.initOTA(loraSerial, devEUI, appEUI, appKey, true)
-</code>
-Eight different sub channels are activated with data rate ranges from 0 to 5:
 <code c++>
-LoRaBee.configChFreq(0, 868100000L,0,5,1);
+static const u1_t PROGMEM APPEUI[8]= { };
-LoRaBee.configChFreq(1, 868300000L,0,5,1);
+void os_getArtEui (u1_t* buf) { memcpy_P(buf, APPEUI, 8);}
-LoRaBee.configChFreq(2, 868500000L,0,5,1);
-LoRaBee.configChFreq(3, 867100000L,0,5,1);
-LoRaBee.configChFreq(4, 867300000L,0,5,1);
-LoRaBee.configChFreq(5, 867500000L,0,5,1);
-LoRaBee.configChFreq(6, 867700000L,0,5,1);
-LoRaBee.configChFreq(7, 867900000L,0,5,1);
-</code>
-Finally, the message containing the sensor values is sent in an unconfirmed uplink message:
+// This should also be in little endian format, see above.
-<code c++>
+static const u1_t PROGMEM DEVEUI[8]= { };
-LoRaBee.send(1, (uint8_t*)message.c_str(), message.length())
+void os_getDevEui (u1_t* buf) { memcpy_P(buf, DEVEUI, 8);}
+static const u1_t PROGMEM APPKEY[16] = { };
+void os_getDevKey (u1_t* buf) {  memcpy_P(buf, APPKEY, 16);}
 </code>
-==== -. Arduino with Dragino Shield ====
-=== -. Periodic Message Sending ===
-Devices in the LoRaWAN platform can also be implemented on Arduino boards with Dragino shields. The combined module as well as the basic configuration steps are presented in [[simple_lora_prototype|Simple Prototype of LoRa Communications]]. Similarly to the Autonomo device, you can download the following sketch {{ :test-loraserver-comb-loraserver-dragino.zip |}} and modify it according to your preferences. Below you can find somme commented extracts of the sketch.
+<WRAP left round tip 100%>
+Note that the device and application identifiers should be in little endian format, while the application key is in big endian format. For example, ''0badde1cafe2deca'' is written as ''0xCA, 0xDE, 0xE2, 0xAF, 0x1C, 0xDE, 0xAD, 0x0B'' in the Arduino sketch.
+</WRAP>
-The pin mapping corresponds to the Dragino electronic schematic:
+Let us analyze to radio parameters in the sketch by answering the following questions.
-<code c++>
-const lmic_pinmap lmic_pins = {
-    .nss = 10,
-    .rxtx = LMIC_UNUSED_PIN,
-    .rst = 9,
-    .dio = {2, 6, 7},
-};
-</code>
-The send function is rescheduled TX_INTERVAL seconds after each transmission complete event:
+<WRAP left round help 100%>
-<code c++>
+  * In the setup function, which channels are activated on the device?
-        case EV_TXCOMPLETE:
+  * What are the different spreading factors on each channel?
-            Serial.println(F("EV_TXCOMPLETE (includes waiting for RX windows)"));
+  * What is the regulation on the radio channels in LoRa?
-            if(LMIC.dataLen) {
+</WRAP>
-                // data received in rx slot after tx
-                Serial.print(F("Data Received: "));
-                Serial.write(LMIC.frame+LMIC.dataBeg, LMIC.dataLen);
-                Serial.println();
-            }
-            // Schedule next transmission
-            os_setTimedCallback(&sendjob, os_getTime()+sec2osticks(TX_INTERVAL), do_send);
-            break;
-</code>
-The send function is initially scheduled here:
+The LMIC library defines a set of events corresponding to the protocol machine state. These events appear in the ''onEvent()'' function.
-<code c++>
-do_send(&sendjob);
-</code>
-The message containing the sensor values is transmitted on one of the radio channels (as in the Autonomo case):
+<WRAP left round help 100%>
-<code c++>
+  * What is the difference between the JOINING and the JOINED events?
-LMIC_setTxData2(1, (uint8_t*) buffer, message.length() , 0);
+  * When is the EV_TXCOMPLETE event called?
-</code>
+</WRAP>
-The adaptive data rate is not supported, and the spreading factor is configured as follows:
+Finally let us look at the message sending on the device.
-<code c++>
-LMIC_setDrTxpow(DR_SF7,14);
-</code>
-=== -. Triggered Message Sending ===
+<WRAP left round help 100%>
+  * What is the function for sending messages on the device? How it is called?
+  * What is the period of message sending? Explain the implementation choice.
+  * Is this period guaranteed according to the LoRaWAN specification?
+</WRAP>
-You can also find another example of sketch to download: {{ :test-loraserver-moisture-on-move.ino.zip |}}. Here the message sending is not periodic but related to an event. For example, an infrared sensor detects a movement and triggers a signal for the device to send a LoRaWAN message. Note also that the join method used in this second sketch is Activation by Personalisation (ABP): the device address, the network session key, and the application session key are directly configured on the device.
+Now you are ready to compile the sketch and upload it to the LoRaWAN device. Connect the device a USB port on your PC, choose the board type as ''Arduino/Genuino Mega 2560'' and select the corresponding port. Compile and upload!
-===== -. Gateways =====
-==== -. Single Channel Gateway ====
-The single channel gateway includes a LoRa transmission module (Dragino Shield) connected to a Raspberry Pi (2 or 3) as shown in Figure 2. Communication between the two modules is done over an SPI interface.
+<WRAP left round tip 100%>
+For Arduino Mega 2560, additional drivers can be installed on Windows from http://wch.cn/download/CH341SER_ZIP.html.
+</WRAP>
-[{{ :2017-01-04_11.34.54.jpg?direct&300 |Figure 2. LoRa single channel gateway}}]
+Open the serial monitor in the Arduino IDE at 115200 baud and analyse the debug messages.
-In order to assemble the gateway, start by making the wire connections: the connection pins are identified in Figures 3 and 4.
+<WRAP left round help 100%>
-[{{ :schema-single-channel-pi3.png?direct&300 |Figure 3. Dragino pin mapping}}]
+  * What is the radio transmit parameters of the captured debug messages?
-[{{ :schema-pins-pi3.png?direct&300 |Figure 4. Raspberry pi 3 pins}}]
+  * What is the radio receive parameters of the captured debug messages for the two receive windows?
+</WRAP>
-Connect the Raspberry Pi to the Internet and install the packet forwarding software. The source code of the single channel packet forwarder is available on: [[https://github.com/samerlahoud/single_chan_pkt_fwd]]. In order to install it, you need to:
+Getting back to the backend, you can monitor some important information related to your device. Click on the corresponding node session.
-  * Enable SPI on the Raspberry Pi using raspi-config
-  * Download and unzip the source code:
-<code bash>
+<WRAP left round help 100%>
-wget https://github.com/hallard/single_chan_pkt_fwd/archive/master.zip
+  * What are the different fields that appear in the node session corresponding to you device?
-unzip master.zip
+  * Explain how each field is created according to the LoRaWAN specification.
-</code>
+  * What are the different counters visible at the backend? Explain how they get incremented and how they are used.
+</WRAP>
+===== -. Applications =====
+mqtt-spy is an open source utility intended to help you with monitoring activity on MQTT topics. It has been designed to deal with high volumes of messages, as well as occasional publications. mqtt-spy is a JavaFX application, so it should work on any operating system with an appropriate version of Java 8 installed. A very useful tutorial is available on [[https://github.com/eclipse/paho.mqtt-spy/wiki]].
+You can use mqtt-spy to debug the messages received from the LoRaWAN devices. The tool is provided at the beginning of the challenge. After starting the application, configure a new connection to the MQTT broker by simply adding the IP address of the broker in the ''Server URI'' field. Now you can subscribe to any MQTT topic. If you want to receive all messages arriving at the backend, you can use the generic topic ''#''. You can also limit to the topic including the messages of any specific device: ''application/APPLICATION_ID/node/DEVICE_EUI/rx''.
-  * Install the wiring library:
+<WRAP left round help 100%>
+  * Summarize the concepts and functionalities of the MQTT protocol.
+  * What are the possible strengths and weaknesses in terms of security of MQTT?
+  * What are the different types of topics used by the backend? Explain.
+  * Explain the different fields in a captured MQTT message received from you device.
+</WRAP>
-<code bash>
+<WRAP left round tip 100%>
-apt-get update
+The payload received by the MQTT client is decrypted but encoded in Base64. You should decode it to get the original message.
-apt-get install wiring
+</WRAP>
-</code>
-Compile the packet forwarder:
+If you need to send data to your device, you should publish the encoded message in the corresponding topic ''application/APPLICATION_ID/node/DEVICE_EUI/tx'' as follows:
-<code bash>
-make all
-</code>
-For gcc version 4.6.3, a compilation error results in the following warning ''unrecognized command line option '-std=c++11'''. Replace ''-std=c++11'' by ''-std=c++0x'' in the Makefile and recompile:
 <code>
-CFLAGS = -std=c++0x -c -Wall -I include/
+{
+    "reference": "abcd1234",                  // reference which will be used on ack or error (this can be a random string)
+    "confirmed": false,                        // whether the payload must be sent as confirmed data down or not
+    "fPort": 10,                              // FPort to use (must be > 0)
+    "data": "...."                            // base64 encoded data (plaintext, will be encrypted by LoRa Server)
+}
 </code>
+===== -. Day One Challenges =====
-Now, you need to configure the single channel packet forwarder. This is done in the {{ :global_config.json.zip |}} configuration file. Particularly, you need to choose the channel, the spreading factor, the pins for SPI communication, and the address of the backend server. Note that you can specify multiple backends for testing purposes.
+==== -. The End-to-End Challenge ====
+I can send data from the device to the application.
-Finally, you can run the packet forwarder as root!
+==== -. The Downlink Challenge ====
+I can send data from the application to the device.
-<code bash>
+==== -. The Radio Challenge ====
-nohup ./single_chan_pkt_fwd &
+I can tune the LoRa radio parameters and assess the results.
-</code>
-==== -. Kerlink IoT Station ====
-<code>
+These two commands can be helpful when used after the join event:
-# activates eth0 at startup
-ETHERNET=yes
-# claims dhcp request on eth0
-ETHDHCP=yes
-# Selector operator APN
+<code c++>
-GPRSAPN=gprs.touch.com.lb
+LMIC_disableChannel(N);
-# Enter pin code if activated
+LMIC_setDrTxpow(DR_SF12,14);
-GPRSPIN=0000
-# Update /etc/resolv.conf to get dns facilities
-GPRSDNS=yes
-# PAP authentication
-GPRSUSER=
-GPRSPASSWORD=
-# Bearers priority order
-#BEARERS_PRIORITY="eth0,ppp0,eth1"
-BEARERS_PRIORITY="ppp0,eth0,eth1"
 </code>
+==== -. The Sensor Challenge ====
+I can use different sensors to send data from the device: PIR, moisture, temperature, light, etc.
-<code>
+===== -. Day Two Challenges =====
-./gps-pkt-fwd.sh > /dev/null &
-</code>
-<code>
+==== -. The Wind Rises ====
-root      2548 S    /bin/sh ./gps-pkt-fwd.sh
-root     34908 S    ./gps_pkt_fwd
-</code>
-<code>
+This is a mandatory challenge. It consists of using [[https://nodered.org|Node-RED]] to receive data from the sensors (via MQTT) and send it to [[https://emoncms.org|emoncms]] for visualization.
-/etc/init.d/gprs start
-[root@Wirgrid_0b03008c demo_gps_loramote]# /etc/init.d/gprs  status
+^ Provided material ^
-pppd (pid 5273) is running...
+| VM with Node-RED installed |
-Session: Rx=58, Tx=163
+| Node-RED example flow |
-Globals: Rx=1130457, Tx=1195592
+| [[https://emoncms.org/dashboard/view&id=37655|Dashboard example]] |
-Sum:     Rx=1130515, Tx=1195755
-[root@Wirgrid_0b03008c demo_gps_loramote]#
-</code>
-===== -. Backend =====
+^ Required skills ^
-==== -. Loraserver ====
+| Basic javascript |
+| GUI configuration |
+| Two drops of IoT graphic design |
+==== -. Nausicaa Challenge ====
-The Loraserver has a web interface for configuring the applications and devices on the platform. Full details for installing the software are provided on [[https://www.loraserver.io]].
+You have to take control on the devices. Use some scripting to send commands and do some actions or tune some parameters on the devices.
-[{{ :app-loraserver.png?direct&400 | Figure 5. Loraserver web interface}}]
+^ Required skills ^
+| Basic scripting (for example python) |
+| Basic electronics |
+| Two drops of IoT autocracy |
-Start by creating and application as in Figure 5. Then create a node in this application and provide the following information:
+==== -. Totoro Challenge ====
-  * A unique node name
-  * The node description
-  * A unique device EUI on 64 bits: Random identifiers can be generated on [[https://www.random.org/bytes/]]
-  * The application EUI on 64 bits: this can be a common identifier for all nodes using the same application.
-  * A unique application key on 128 bits
-In order to enable OTAA join method, you have to make sure that the ''ABP activation'' button is unchecked.
+You have to store the sensor data in a database. Use Node-RED to inject data in a (influx) database.
+^ Required skills ^
+| Basic database |
+| Two drops of IoT resilience |
-==== -. The Things Network ====
+==== -. Kiki Challenge ====
-===== -. Applications =====
+==== -. Mononoke Challenge ====
-==== -. mqtt-spy ====
+You have to implement a chat bot designed for working with Google Hangouts. The bot answers requests and reveals sensors data.
-mqtt-spy is an open source utility intended to help you with monitoring activity on MQTT topics. It has been designed to deal with high volumes of messages, as well as occasional publications. mqtt-spy is a JavaFX application, so it should work on any operating system with an appropriate version of Java 8 installed. A very useful tutorial is available on [[https://github.com/eclipse/paho.mqtt-spy/wiki]].
-You can use mqtt-spy to debug the messages received from the LoRaWAN devices. For this, you should download the software tool from [[https://github.com/eclipse/paho.mqtt-spy/wiki]]. After starting the application, configure a new connection to the MQTT broker by simply adding the IP address of the broker in the ''Server URI'' field. Now you can subscribe to any MQTT topic. If you want to receive all messages arriving at the backend, you can use the generic topic ''#''. You can also limit to the topic including the messages of any specific device: ''application/APPLICATION_ID/node/DEVICE_EUI/rx''.
-==== -. Emoncms ====