├── riot ├── lorawan │ ├── .vscode │ │ └── settings.json │ ├── Makefile.ci │ ├── Makefile │ ├── README.md │ └── main.c └── mqttsn │ ├── Makefile.ci │ ├── Makefile │ ├── README.md │ └── main.c ├── .gitignore ├── assignment4 ├── utils.js ├── gsensors.js └── index.html ├── src ├── sample_credentials.rs ├── utils.rs └── main.rs ├── Cargo.toml ├── README.md └── LICENSE /riot/lorawan/.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.associations": { 3 | "system_error": "c" 4 | } 5 | } -------------------------------------------------------------------------------- /riot/lorawan/Makefile.ci: -------------------------------------------------------------------------------- 1 | BOARD_INSUFFICIENT_MEMORY := \ 2 | nucleo-f031k6 \ 3 | nucleo-f042k6 \ 4 | nucleo-l031k6 \ 5 | stm32f030f4-demo \ 6 | # 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | 5 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries 6 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html 7 | Cargo.lock 8 | 9 | # These are backup files generated by rustfmt 10 | **/*.rs.bk 11 | 12 | bin 13 | riot/lorawan/credentials.include 14 | src/credentials.rs 15 | -------------------------------------------------------------------------------- /assignment4/utils.js: -------------------------------------------------------------------------------- 1 | // An HTTP POST using Fetch APIs 2 | export const makePost = function (url, body) { 3 | fetch(url, { 4 | method: "POST", 5 | // Handling CORS 6 | mode: "no-cors", 7 | headers: { 8 | "Content-type": "application/json", 9 | }, 10 | body: body, 11 | }).catch(function (error) { 12 | console.log("Request failed", error); 13 | }); 14 | }; 15 | 16 | // A naive HAR model 17 | export const setActivity = function (x, y, z) { 18 | let norm = Math.sqrt(x * x + y * y + z * z); 19 | if (norm > 0.5) return "Moving"; 20 | else return "Still"; 21 | }; 22 | -------------------------------------------------------------------------------- /src/sample_credentials.rs: -------------------------------------------------------------------------------- 1 | pub struct Credentials<'a> { 2 | pub appid: &'a str, 3 | pub appaccesskey: &'a str, 4 | } 5 | 6 | impl Credentials<'static> { 7 | pub const fn new(appid: &'static str, appaccesskey: &'static str) -> Self { 8 | Self { 9 | appid, 10 | appaccesskey, 11 | } 12 | } 13 | } 14 | 15 | pub const fn get() -> Credentials<'static> { 16 | // Application ID from the TTN Console 17 | let appid = "app_name"; 18 | // App Access API key from the TTN Console 19 | let appaccesskey = "app_access_key"; 20 | Credentials::new(appid, appaccesskey) 21 | } 22 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "rusty-mqtt" 3 | version = "0.4.0" 4 | authors = ["Leonardo Razovic "] 5 | edition = "2018" 6 | include = ["src/**/*", "LICENSE", "README.md"] 7 | 8 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 9 | 10 | [dependencies] 11 | serde = { version = "1.0.129", features = ["derive"] } 12 | serde_json = "1.0.66" 13 | log = "0.4.14" 14 | env_logger = "0.9.0" 15 | uuid = { version = "0.8.2", features = ["v4"] } 16 | clap = "2.33.3" 17 | mqtt-protocol = { version = "0.10.0", features = ["async"] } 18 | tokio = { version = "1.10.1", features = ["full"] } 19 | futures = "0.3.16" 20 | -------------------------------------------------------------------------------- /riot/mqttsn/Makefile.ci: -------------------------------------------------------------------------------- 1 | BOARD_INSUFFICIENT_MEMORY := \ 2 | arduino-duemilanove \ 3 | arduino-leonardo \ 4 | arduino-mega2560 \ 5 | arduino-nano \ 6 | arduino-uno \ 7 | atmega1284p \ 8 | atmega328p \ 9 | chronos \ 10 | derfmega128 \ 11 | hifive1 \ 12 | hifive1b \ 13 | i-nucleo-lrwan1 \ 14 | im880b \ 15 | mega-xplained \ 16 | microduino-corerf \ 17 | msb-430 \ 18 | msb-430h \ 19 | nucleo-f030r8 \ 20 | nucleo-f031k6 \ 21 | nucleo-f042k6 \ 22 | nucleo-f070rb \ 23 | nucleo-f072rb \ 24 | nucleo-f302r8 \ 25 | nucleo-f303k8 \ 26 | nucleo-f334r8 \ 27 | nucleo-l031k6 \ 28 | nucleo-l053r8 \ 29 | stm32f030f4-demo \ 30 | stm32f0discovery \ 31 | stm32l0538-disco \ 32 | telosb \ 33 | waspmote-pro \ 34 | wsn430-v1_3b \ 35 | wsn430-v1_4 \ 36 | z1 \ 37 | # 38 | -------------------------------------------------------------------------------- /riot/lorawan/Makefile: -------------------------------------------------------------------------------- 1 | # name of your application 2 | APPLICATION = lorawan 3 | 4 | # Use the ST B-L072Z-LRWAN1 board by default: 5 | BOARD ?= b-l072z-lrwan1 6 | 7 | # This has to be the absolute path to the RIOT base directory: 8 | RIOTBASE ?= $(CURDIR)/../../../RIOT 9 | 10 | # Default radio driver is Semtech SX1276 (used by the B-L072Z-LRWAN1 board) 11 | DRIVER ?= sx1276 12 | 13 | # Default region is Europe and default band is 868MHz 14 | LORA_REGION ?= EU868 15 | 16 | # Include the Semtech-loramac package 17 | USEPKG += semtech-loramac 18 | 19 | USEMODULE += $(DRIVER) 20 | USEMODULE += fmt 21 | USEMODULE += random 22 | FEATURES_REQUIRED += periph_rtc 23 | 24 | CFLAGS += -DDEVEUI=\"$(DEVEUI)\" -DAPPEUI=\"$(APPEUI)\" -DAPPKEY=\"$(APPKEY)\" 25 | 26 | # Comment this out to disable code in RIOT that does safety checking 27 | # which is not needed in a production environment but helps in the 28 | # development process: 29 | DEVELHELP ?= 1 30 | 31 | # Change this to 0 show compiler invocation lines by default: 32 | QUIET ?= 1 33 | 34 | include $(RIOTBASE)/Makefile.include 35 | include ./credentials.include 36 | -------------------------------------------------------------------------------- /riot/lorawan/README.md: -------------------------------------------------------------------------------- 1 | LoRaWAN 2 | ======= 3 | 4 | Description 5 | ----------- 6 | 7 | This application shows a simple use case of LoRaWAN with RIOT. 8 | 9 | By using the real time clock and low-power capabilities of a board, this 10 | application shows how to program a LoRaWAN Class A device using RIOT. 11 | 12 | This application is using the Over-The-Air Activation procedure. 13 | 14 | Usage 15 | ----- 16 | 17 | Simply build and flash the application for a ST B-L072Z-LRWAN1 board: 18 | 19 | make flash term 20 | 21 | Use the `BOARD`, `DRIVER` and `LORA_REGION` make variables to adapt the application 22 | to your hardware setup and region of use: 23 | 24 | - `BOARD` can be one of the nucleo-64 boards 25 | - `DRIVER` can be either `sx1276` or `sx1272` 26 | - `LORA_REGION` can be `EU868`, `US915`, etc (see LoRaWAN regional parameters for 27 | details). 28 | 29 | ST Nucleo-64 can be used with mbed LoRa shields: there's one based on 30 | [the sx1276 radio](https://os.mbed.com/components/SX1276MB1xAS/) and one based 31 | on the [the sx1272 radio](https://os.mbed.com/components/SX1272MB2xAS/). 32 | 33 | Finally, to join a LoRaWAN network using OTAA activation, add an auxiliry file called 34 | `credentials.include` and set your device information that you can find on TheThingsNetwork device console: 35 | 36 | ``` 37 | DEVEUI ?= 0000000000000000 38 | APPEUI ?= 0000000000000000 39 | APPKEY ?= 00000000000000000000000000000000 40 | ``` 41 | -------------------------------------------------------------------------------- /riot/mqttsn/Makefile: -------------------------------------------------------------------------------- 1 | # name of your application 2 | APPLICATION = emcute_mqttsn 3 | 4 | # If no BOARD is found in the environment, use this default: 5 | BOARD ?= native 6 | 7 | DRIVER ?= lps331ap 8 | 9 | # This has to be the absolute path to the RIOT base directory: 10 | RIOTBASE ?= $(CURDIR)/../../RIOT 11 | 12 | # Include packages that pull up and auto-init the link layer. 13 | # NOTE: 6LoWPAN will be included if IEEE802.15.4 devices are present 14 | USEMODULE += gnrc_netdev_default 15 | USEMODULE += xtimer 16 | USEMODULE += random 17 | # USEMODULE += $(DRIVER) 18 | USEMODULE += auto_init_gnrc_netif 19 | # Specify the mandatory networking modules for IPv6 and UDP 20 | USEMODULE += gnrc_sock_udp 21 | USEMODULE += gnrc_ipv6_default 22 | # Include MQTT-SN 23 | USEMODULE += emcute 24 | # Add also the shell, some shell commands 25 | USEMODULE += shell 26 | USEMODULE += shell_commands 27 | USEMODULE += ps 28 | # For testing we also include the ping6 command and some stats 29 | USEMODULE += gnrc_icmpv6_echo 30 | 31 | # Allow for env-var-based override of the nodes name (EMCUTE_ID) 32 | ifneq (,$(EMCUTE_ID)) 33 | CFLAGS += -DEMCUTE_ID=\"$(EMCUTE_ID)\" 34 | endif 35 | 36 | # Comment this out to disable code in RIOT that does safety checking 37 | # which is not needed in a production environment but helps in the 38 | # development process: 39 | DEVELHELP ?= 1 40 | 41 | # Comment this out to join RPL DODAGs even if DIOs do not contain 42 | # DODAG Configuration Options (see the doc for more info) 43 | # CFLAGS += -DGNRC_RPL_DODAG_CONF_OPTIONAL_ON_JOIN 44 | 45 | # Change this to 0 show compiler invocation lines by default: 46 | QUIET ?= 1 47 | 48 | include $(RIOTBASE)/Makefile.include 49 | -------------------------------------------------------------------------------- /assignment4/gsensors.js: -------------------------------------------------------------------------------- 1 | import { makePost, setActivity } from "./utils.js"; 2 | 3 | // Create the Sensor object 4 | var accelerometer = new LinearAccelerationSensor({ frequency: 1 }); 5 | 6 | function start() { 7 | // The ThingsBoard telemetry URL 8 | let at = document.getElementById("at").value; 9 | let url = "https://demo.thingsboard.io/api/v1/" + at + "/telemetry"; 10 | // Start the sensor 11 | accelerometer.start(); 12 | 13 | accelerometer.onreading = () => { 14 | let x = Number(accelerometer.x.toFixed(5)); 15 | let y = Number(accelerometer.y.toFixed(5)); 16 | let z = Number(accelerometer.z.toFixed(5)); 17 | document.getElementById("x").innerHTML = x; 18 | document.getElementById("y").innerHTML = y; 19 | document.getElementById("z").innerHTML = z; 20 | 21 | // The JSON objects sent to ThingsBoard 22 | let telemetry = { x: x, y: y, z: z }; 23 | let activity = setActivity(x, y, z); 24 | let status = { edgeStatus: activity }; 25 | 26 | // Cloud based Model 27 | makePost(url, JSON.stringify(telemetry)); 28 | 29 | // Edge based Model 30 | makePost(url, JSON.stringify(status)); 31 | document.getElementById("status").innerHTML = activity; 32 | }; 33 | 34 | accelerometer.onerror = (event) => { 35 | // Handle errors 36 | console.log(event.error.name, event.error.message); 37 | document.getElementById("error_name").innerHTML = 38 | "Error Name: " + event.error.name; 39 | document.getElementById("error_message").innerHTML = 40 | "Error Message: " + event.error.message; 41 | }; 42 | } 43 | function stop() { 44 | // Stop the sensor 45 | accelerometer.stop(); 46 | } 47 | 48 | // Link the buttons and the functions 49 | document.getElementById("start").addEventListener("click", start, false); 50 | document.getElementById("stop").addEventListener("click", stop, false); 51 | -------------------------------------------------------------------------------- /assignment4/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Generic Sensors Test 7 | 8 | 9 | 10 |

Generic Sensors API

11 |
12 |

13 | Accelerator along X-axis: 14 | 0 15 |

16 |

17 | Accelerator along Y-axis: 18 | 0 19 |

20 |

21 | Accelerator along Z-axis: 22 | 0 23 |

24 |

25 | 26 | 27 |

28 |
29 |
30 |
31 | 32 | 33 |
34 |

35 | Cloud based real time dashboard 41 |

42 |

43 | Edge based real time dashboard 49 |

50 |

Status:

51 | 52 |
53 | 54 | 55 | -------------------------------------------------------------------------------- /riot/mqttsn/README.md: -------------------------------------------------------------------------------- 1 | ## About 2 | This application demonstrates the usage of the emCute (MQTT-SN) module in RIOT. 3 | 4 | ## Setup 5 | For using this example, two prerequisites have to be fulfilled: 6 | 7 | 1. You need a running MQTT broker that supports MQTT-SN or a running MQTT-SN 8 | gateway that is connected to a running MQTT broker 9 | 2. Your RIOT node needs to be able to speak to that broker/gateway 10 | 11 | 12 | ### Setting up a broker 13 | In general, any MQTT-SN capable broker or broker/gateway setup will do. 14 | Following a quick instruction on how-to setup the Mosquitto Real Simple Message 15 | Broker: 16 | 17 | 1. Get the RSMB here: https://github.com/eclipse/mosquitto.rsmb 18 | ``` 19 | git clone https://github.com/eclipse/mosquitto.rsmb.git 20 | ``` 21 | 22 | 2. Go into the source folder and build the RSMB 23 | ``` 24 | cd mosquitto.rsmb/rsmb/src 25 | make 26 | ``` 27 | 28 | 3. Create a config file. In this case we run the RSMB as MQTT and MQTT-SN 29 | capable broker, using port 1885 for MQTT-SN and 1886 for MQTT and enabling 30 | IPv6, so save the following to `config.conf`: 31 | ``` 32 | # add some debug output 33 | trace_output protocol 34 | 35 | # listen for MQTT-SN traffic on UDP port 1885 36 | listener 1885 INADDR_ANY mqtts 37 | ipv6 true 38 | 39 | # listen to MQTT connections on tcp port 1886 40 | listener 1886 INADDR_ANY 41 | ipv6 true 42 | ``` 43 | 44 | 4. Start the broker: 45 | ``` 46 | ./broker_mqtts config.conf 47 | ``` 48 | 49 | ### Setting up RIOT `native` 50 | When running this example under native, we must configure some global addresses, 51 | as the RSMB doesn't seems to be able to handle link-local addresses. So for a 52 | single RIOT native instance, we can do the following: 53 | 54 | 1. Setup `tap1`, `tap2` and `tapbr` devices using RIOT's `tapsetup` script: 55 | ``` 56 | sudo ./RIOTDIR/dist/tools/tapsetup/tapsetup -c 2 57 | ``` 58 | 59 | 2. Assign a site-global prefix to the `tapbr0` interface (the name could be 60 | different on OSX etc): 61 | ``` 62 | sudo ip a a fec0:affe::1/64 dev tapbr0 63 | ``` 64 | 65 | 3. Compile and run the code using `make all term PORT=tap0 BOARD=native` or `make all term PORT=tap0 BOARD=native BUILD_IN_DOCKER=1` if you are using Docker to compile. 66 | 67 | 4. Inside RIOT shell, assign a site-global address with the same prefix within the RIOT `native` 68 | instance: 69 | ``` 70 | ifconfig 5 add fec0:affe::99 71 | ``` 72 | 73 | 74 | ## Usage 75 | This example maps all available MQTT-SN functions to shell commands. Simply type 76 | `help` to see the available commands. The most important steps are explained 77 | below: 78 | 79 | - To connect to a broker, use the `con` command: 80 | ``` 81 | con fec0:affe::1 1885 82 | ``` 83 | 84 | - For publishing, use the `pub` command: 85 | ``` 86 | pub hello/world "One more beer, please." 87 | ``` 88 | - For publishing random data, use the `fpub` command: 89 | ``` 90 | fpub sensors/values 1 91 | ``` 92 | 93 | That's it, happy publishing! 94 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # rusty-mqtt 2 | 3 | A bridge between the MQTT broker of TTN and ThingsBoard in Rust built for the Internet of Things 19/20 course during the Engineering in Computer Science Master's Degree. 4 | 5 | ## LinkedIn Profile 6 | 7 | [Leonardo Razovic](https://www.linkedin.com/in/leonardo-razovic-4b20b1121/) 8 | 9 | ## Assignment 1/2/3 10 | 11 | ### Prerequisites 12 | 13 | 1. Rust, you can install it using [rustup](https://rustup.rs/) 14 | 2. A working instance of [ThingsBoard](https://thingsboard.io/docs/user-guide/install/installation-options/) 15 | 3. A [B-L072Z-LRWAN1 LoRa kit](https://www.st.com/en/evaluation-tools/b-l072z-lrwan1.html) or an [IoT-LAB](https://www.iot-lab.info/) Account 16 | 4. An account on [The Things Network](https://www.thethingsnetwork.org/) 17 | 18 | ### Usage 19 | 20 | ``` 21 | USAGE: 22 | rusty-mqtt [OPTIONS] --TTN-port --server --topic --username 23 | 24 | FLAGS: 25 | -h, --help Prints help information 26 | -V, --version Prints version information 27 | 28 | OPTIONS: 29 | -k, --TTN-port TTN MQTT server port [default: 1883] 30 | -s, --server ThingsBoard MQTT server address [default: 0.0.0.0] 31 | -t, --topic TTN topic to subscribe 32 | -p, --port ThingsBoard MQTT Server port [default: 1883] 33 | -r, --TTN-address TTN MQTT server address [default: eu1.thethings.network] 34 | -u, --username ThingsBoard gateway device ACCESS_TOKEN 35 | ``` 36 | 37 | In the `src` folder you need a file `credentials.rs` containing the _App ID_ and the _App Access Key_ from the **TTN Application Console**. You can modify and rename the `sample_credentials.rs` file as reference. 38 | In the **TTN Application Console** we must specify a custom decoder function like: 39 | ```js 40 | function Decoder(bytes, port) { 41 | var result = ""; 42 | for (var byte in bytes){ 43 | result += String.fromCharCode(bytes[byte]); 44 | } 45 | return {"result": result }; 46 | } 47 | ``` 48 | 49 | #### Example 50 | 51 | ```bash 52 | cargo run --release -- -t "#" -u "A1_TEST_TOKEN" -r "eu1.cloud.thethings.network" 53 | ``` 54 | #### Usefull Links 55 | 56 | * The Things Network [MQTT Documentation](https://www.thethingsnetwork.org/docs/applications/mqtt/api/) 57 | 58 | ## Assignment 4 59 | 60 | I developed an HTML5 application using the Generic Sensor API that collects data from the accelerator sensor of the mobile phone. 61 | A User Activity Recognition model is executed both on the device (Edge-based approach) and ThingsBoard (Cloud-based approach). 62 | 63 | The application is hosted using [GitHub Pages](https://pages.github.com/) and it's available [here](https://lrazovic.github.io/rusty-mqtt/). 64 | You simply need to enter a ThingsBoard Device [Access Token](https://thingsboard.io/docs/user-guide/ui/devices/) and after pressing the start button data from the accelerometer is sent to ThingsBoard using the Telemetry Upload HTTP API. 65 | 66 | ## Blog Posts 67 | 68 | Assignment 1: [The MQTT protocol using ThingsBoard, Rust and React](https://medium.com/@LRazovic/mqtt-protocol-using-thingsboard-rust-and-react-9f0434bd206e) 69 | 70 | Assignment 2: [How to setup an Async MQTT transparent bridge in Rust](https://medium.com/@LRazovic/how-to-setup-an-async-mqtt-transparent-bridge-in-rust-4614ad705138) 71 | 72 | Assignment 3: [The LoRaWAN communication protocol using RIOT, ThingsBoard and Rust](https://medium.com/@LRazovic/the-lorawan-communication-protocol-using-riot-thingsboard-and-rust-bebe76b20177) 73 | 74 | Assignment 4: [Generic Sensor API, Sensors For The Web!](https://medium.com/@LRazovic/generic-sensor-api-sensors-for-the-web-6eacabe279be) 75 | 76 | ## YouTube Videos 77 | 78 | Assignment 1: [https://www.youtube.com/watch?v=6th-NgDjC1w&feature=youtu.be](https://www.youtube.com/watch?v=6th-NgDjC1w&feature=youtu.be) 79 | 80 | Assignment 2: [https://youtu.be/JiG8LkaZDtQ](https://youtu.be/JiG8LkaZDtQ) 81 | 82 | Assignment 3: [https://www.youtube.com/watch?v=bsJNijxUCw0](https://www.youtube.com/watch?v=bsJNijxUCw0) 83 | 84 | Assignment 4: [https://www.youtube.com/watch?v=d5ZlM878lms](https://www.youtube.com/watch?v=d5ZlM878lms) 85 | -------------------------------------------------------------------------------- /riot/lorawan/main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2018 Inria 3 | * 4 | * This file is subject to the terms and conditions of the GNU Lesser 5 | * General Public License v2.1. See the file LICENSE in the top level 6 | * directory for more details. 7 | */ 8 | 9 | /** 10 | * @ingroup examples 11 | * @{ 12 | * 13 | * @file 14 | * @brief Example demonstrating the use of LoRaWAN with RIOT 15 | * 16 | * @author Alexandre Abadie 17 | * 18 | * @} 19 | */ 20 | 21 | #include 22 | #include 23 | #include 24 | #include 25 | 26 | #include "fmt.h" 27 | #include "msg.h" 28 | #include "net/loramac.h" 29 | #include "periph/rtc.h" 30 | #include "random.h" 31 | #include "semtech_loramac.h" 32 | #include "thread.h" 33 | 34 | /* Messages are sent every 20s to respect the duty cycle on each channel */ 35 | #define PERIOD (20U) 36 | 37 | #define SENDER_PRIO (THREAD_PRIORITY_MAIN - 1) 38 | static kernel_pid_t sender_pid; 39 | static char sender_stack[THREAD_STACKSIZE_MAIN / 2]; 40 | 41 | semtech_loramac_t loramac; 42 | 43 | static uint8_t deveui[LORAMAC_DEVEUI_LEN]; 44 | static uint8_t appeui[LORAMAC_APPEUI_LEN]; 45 | static uint8_t appkey[LORAMAC_APPKEY_LEN]; 46 | 47 | static void rtc_cb(void *arg) { 48 | (void)arg; 49 | msg_t msg; 50 | msg_send(&msg, sender_pid); 51 | } 52 | 53 | static void _prepare_next_alarm(void) { 54 | struct tm time; 55 | rtc_get_time(&time); 56 | /* set initial alarm */ 57 | time.tm_sec += PERIOD; 58 | mktime(&time); 59 | rtc_set_alarm(&time, rtc_cb, NULL); 60 | } 61 | 62 | static void _send_message(void) { 63 | int temperature = random_uint32_range(0, 100); 64 | int h = random_uint32_range(0, 100); 65 | int wd = random_uint32_range(0, 360); 66 | int wi = random_uint32_range(0, 100); 67 | int rh = random_uint32_range(0, 50); 68 | char payload[16]; 69 | sprintf(payload, "%d %d %d %d %d", temperature, h, wd, wi, rh); 70 | printf( 71 | "Sending [TEMEPERATURE, HUMIDITY, WIND_DIRECTION, WIND_INTENSITY, " 72 | "RAIN_HEIGHT]: %s\n", 73 | payload); 74 | /* Try to send the message */ 75 | uint8_t ret = 76 | semtech_loramac_send(&loramac, (uint8_t *)payload, strlen(payload)); 77 | if (ret != SEMTECH_LORAMAC_TX_DONE) { 78 | printf("Cannot send message '%s', ret code: %d\n", payload, ret); 79 | return; 80 | } 81 | } 82 | 83 | static void *sender(void *arg) { 84 | (void)arg; 85 | 86 | msg_t msg; 87 | msg_t msg_queue[8]; 88 | msg_init_queue(msg_queue, 8); 89 | 90 | while (1) { 91 | msg_receive(&msg); 92 | 93 | /* Trigger the message send */ 94 | _send_message(); 95 | 96 | /* Schedule the next wake-up alarm */ 97 | _prepare_next_alarm(); 98 | } 99 | 100 | /* this should never be reached */ 101 | return NULL; 102 | } 103 | 104 | int main(void) { 105 | puts("LoRaWAN Class A low-power application"); 106 | puts("====================================="); 107 | 108 | /* Convert identifiers and application key */ 109 | fmt_hex_bytes(deveui, DEVEUI); 110 | fmt_hex_bytes(appeui, APPEUI); 111 | fmt_hex_bytes(appkey, APPKEY); 112 | 113 | /* Initialize the loramac stack */ 114 | semtech_loramac_init(&loramac); 115 | semtech_loramac_set_deveui(&loramac, deveui); 116 | semtech_loramac_set_appeui(&loramac, appeui); 117 | semtech_loramac_set_appkey(&loramac, appkey); 118 | 119 | /* Use a fast datarate, e.g. BW125/SF7 in EU868 */ 120 | semtech_loramac_set_dr(&loramac, LORAMAC_DR_5); 121 | 122 | /* Start the Over-The-Air Activation (OTAA) procedure to retrieve the 123 | * generated device address and to get the network and application session 124 | * keys. 125 | */ 126 | puts("Starting join procedure"); 127 | if (semtech_loramac_join(&loramac, LORAMAC_JOIN_OTAA) != 128 | SEMTECH_LORAMAC_JOIN_SUCCEEDED) { 129 | puts("Join procedure failed"); 130 | return 1; 131 | } 132 | puts("Join procedure succeeded"); 133 | 134 | /* start the sender thread */ 135 | sender_pid = thread_create(sender_stack, sizeof(sender_stack), SENDER_PRIO, 0, 136 | sender, NULL, "sender"); 137 | 138 | /* trigger the first send */ 139 | msg_t msg; 140 | msg_send(&msg, sender_pid); 141 | return 0; 142 | } 143 | -------------------------------------------------------------------------------- /src/utils.rs: -------------------------------------------------------------------------------- 1 | use clap::{App, Arg}; 2 | use log::info; 3 | use mqtt::packet::{PublishPacket, QoSWithPacketIdentifier}; 4 | use mqtt::Encodable; 5 | use mqtt::TopicName; 6 | use serde::Serialize; 7 | use std::io::Write; 8 | use std::net::TcpStream; 9 | use std::time::{SystemTime, UNIX_EPOCH}; 10 | use uuid::Uuid; 11 | 12 | #[derive(Serialize)] 13 | pub struct Device<'a> { 14 | device: &'a str, 15 | } 16 | 17 | impl<'a> Device<'a> { 18 | pub const fn new(device: &'a str) -> Self { 19 | Self { device } 20 | } 21 | } 22 | 23 | #[derive(Serialize)] 24 | pub struct Values { 25 | temperature: i16, 26 | humidity: i16, 27 | rain_height: i16, 28 | wind_direction: i16, 29 | wind_intensity: i16, 30 | } 31 | 32 | impl Values { 33 | pub const fn new( 34 | temperature: i16, 35 | humidity: i16, 36 | wind_direction: i16, 37 | wind_intensity: i16, 38 | rain_height: i16, 39 | ) -> Self { 40 | Self { 41 | temperature, 42 | humidity, 43 | rain_height, 44 | wind_direction, 45 | wind_intensity, 46 | } 47 | } 48 | } 49 | 50 | #[derive(Serialize)] 51 | pub struct Sensor { 52 | ts: u128, 53 | values: Values, 54 | } 55 | 56 | impl Sensor { 57 | pub const fn new(ts: u128, values: Values) -> Self { 58 | Self { ts, values } 59 | } 60 | } 61 | 62 | // Client ID generation using UUID version 4 63 | pub fn generate_client_id() -> String { 64 | format!("{}", Uuid::new_v4()) 65 | } 66 | // Random values generation 67 | 68 | pub fn generate_telemtry_packet(values: Values) -> Sensor { 69 | let start = SystemTime::now(); 70 | let since_the_epoch = start 71 | .duration_since(UNIX_EPOCH) 72 | .expect("Time went backwards"); 73 | let in_ms = since_the_epoch.as_millis(); 74 | Sensor::new(in_ms, values) 75 | } 76 | 77 | pub fn publish(stream: &mut TcpStream, msg: &str, topic: &TopicName) { 78 | // MQTT PUBLISH packet creation 79 | let packet = PublishPacket::new( 80 | topic.clone(), 81 | QoSWithPacketIdentifier::Level1(10), 82 | msg.to_string(), 83 | ); 84 | // Encode and Write the packet on the TcpStream 85 | let mut buf = Vec::new(); 86 | packet.encode(&mut buf).unwrap(); 87 | stream.write_all(&buf[..]).unwrap(); 88 | info!("Message: {} sent on Topic: {:?}", msg, topic); 89 | } 90 | 91 | pub fn parse_argument() -> clap::ArgMatches<'static> { 92 | App::new("rusty-mqtt") 93 | .author("Leonardo Razovic ") 94 | .version("0.4") 95 | .arg( 96 | Arg::with_name("SERVER") 97 | .short("s") 98 | .long("server") 99 | .default_value("0.0.0.0") 100 | .takes_value(true) 101 | .required(true) 102 | .help("ThingsBoard MQTT server address"), 103 | ) 104 | .arg( 105 | Arg::with_name("USER_NAME") 106 | .short("u") 107 | .long("username") 108 | .required(true) 109 | .takes_value(true) 110 | .help("ThingsBoard gateway device ACCESS_TOKEN"), 111 | ) 112 | .arg( 113 | Arg::with_name("TPORT") 114 | .short("p") 115 | .long("port") 116 | .default_value("1883") 117 | .takes_value(true) 118 | .help("ThingsBoard MQTT Server port"), 119 | ) 120 | .arg( 121 | Arg::with_name("TOPIC") 122 | .short("t") 123 | .long("topic") 124 | .required(true) 125 | .takes_value(true) 126 | .help("TTN topic to subscribe"), 127 | ) 128 | .arg( 129 | Arg::with_name("RPORT") 130 | .short("k") 131 | .long("TTN-port") 132 | .default_value("1883") 133 | .required(true) 134 | .takes_value(true) 135 | .help("TTN MQTT server port"), 136 | ) 137 | .arg( 138 | Arg::with_name("TTN") 139 | .short("r") 140 | .long("TTN-address") 141 | .takes_value(true) 142 | .default_value("eu.thethings.network") 143 | .help("TTN MQTT server address"), 144 | ) 145 | .get_matches() 146 | } 147 | -------------------------------------------------------------------------------- /riot/mqttsn/main.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2015 Freie Universität Berlin 3 | * 4 | * This file is subject to the terms and conditions of the GNU Lesser 5 | * General Public License v2.1. See the file LICENSE in the top level 6 | * directory for more details. 7 | */ 8 | 9 | /** 10 | * @ingroup examples 11 | * @{ 12 | * 13 | * @file 14 | * @brief Example application for demonstrating RIOT's MQTT-SN library 15 | * emCute 16 | * 17 | * @author Hauke Petersen 18 | * 19 | * @} 20 | */ 21 | 22 | #include 23 | #include 24 | #include 25 | 26 | #include "msg.h" 27 | #include "net/emcute.h" 28 | #include "net/ipv6/addr.h" 29 | #include "random.h" 30 | #include "shell.h" 31 | #include "xtimer.h" 32 | // #include "lpsxxx.h" 33 | // #include "lpsxxx_params.h" 34 | // #include "lpsxxx_internal.h" 35 | 36 | #ifndef EMCUTE_ID 37 | #define EMCUTE_ID ("gertrud") 38 | #endif 39 | #define EMCUTE_PORT (1883U) 40 | #define EMCUTE_PRIO (THREAD_PRIORITY_MAIN - 1) 41 | 42 | #define NUMOFSUBS (16U) 43 | #define TOPIC_MAXLEN (64U) 44 | 45 | static char stack[THREAD_STACKSIZE_DEFAULT]; 46 | static msg_t queue[8]; 47 | 48 | static emcute_sub_t subscriptions[NUMOFSUBS]; 49 | 50 | static void *emcute_thread(void *arg) { 51 | (void)arg; 52 | emcute_run(EMCUTE_PORT, EMCUTE_ID); 53 | return NULL; /* should never be reached */ 54 | } 55 | 56 | static unsigned get_qos(const char *str) { 57 | int qos = atoi(str); 58 | switch (qos) { 59 | case 1: 60 | return EMCUTE_QOS_1; 61 | case 2: 62 | return EMCUTE_QOS_2; 63 | default: 64 | return EMCUTE_QOS_0; 65 | } 66 | } 67 | 68 | static int cmd_con(int argc, char **argv) { 69 | sock_udp_ep_t gw = {.family = AF_INET6, .port = EMCUTE_PORT}; 70 | char *topic = NULL; 71 | char *message = NULL; 72 | size_t len = 0; 73 | 74 | if (argc < 2) { 75 | printf("usage: %s [port] [ ]\n", 76 | argv[0]); 77 | return 1; 78 | } 79 | 80 | /* parse address */ 81 | if (ipv6_addr_from_str((ipv6_addr_t *)&gw.addr.ipv6, argv[1]) == NULL) { 82 | printf("error parsing IPv6 address\n"); 83 | return 1; 84 | } 85 | 86 | if (argc >= 3) { 87 | gw.port = atoi(argv[2]); 88 | } 89 | if (argc >= 5) { 90 | topic = argv[3]; 91 | message = argv[4]; 92 | len = strlen(message); 93 | } 94 | 95 | if (emcute_con(&gw, true, topic, message, len, 0) != EMCUTE_OK) { 96 | printf("error: unable to connect to [%s]:%i\n", argv[1], (int)gw.port); 97 | return 1; 98 | } 99 | printf("Successfully connected to gateway at [%s]:%i\n", argv[1], 100 | (int)gw.port); 101 | 102 | return 0; 103 | } 104 | 105 | static int cmd_discon(int argc, char **argv) { 106 | (void)argc; 107 | (void)argv; 108 | 109 | int res = emcute_discon(); 110 | if (res == EMCUTE_NOGW) { 111 | puts("error: not connected to any broker"); 112 | return 1; 113 | } else if (res != EMCUTE_OK) { 114 | puts("error: unable to disconnect"); 115 | return 1; 116 | } 117 | puts("Disconnect successful"); 118 | return 0; 119 | } 120 | 121 | static int cmd_pub(int argc, char **argv) { 122 | emcute_topic_t t; 123 | unsigned flags = EMCUTE_QOS_0; 124 | 125 | if (argc < 3) { 126 | printf("usage: %s [QoS level]\n", argv[0]); 127 | return 1; 128 | } 129 | 130 | /* parse QoS level */ 131 | if (argc >= 4) { 132 | flags |= get_qos(argv[3]); 133 | } 134 | 135 | printf("pub with topic: %s and name %s and flags 0x%02x\n", argv[1], argv[2], 136 | (int)flags); 137 | 138 | /* step 1: get topic id */ 139 | t.name = argv[1]; 140 | if (emcute_reg(&t) != EMCUTE_OK) { 141 | puts("error: unable to obtain topic ID"); 142 | return 1; 143 | } 144 | 145 | /* step 2: publish data */ 146 | if (emcute_pub(&t, argv[2], strlen(argv[2]), flags) != EMCUTE_OK) { 147 | printf("error: unable to publish data to topic '%s [%i]'\n", t.name, 148 | (int)t.id); 149 | return 1; 150 | } 151 | 152 | printf("Published %i bytes to topic '%s [%i]'\n", (int)strlen(argv[2]), 153 | t.name, t.id); 154 | 155 | return 0; 156 | } 157 | 158 | static int cmd_fpub(int argc, char **argv) { 159 | emcute_topic_t t; 160 | unsigned flags = EMCUTE_QOS_0; 161 | 162 | if (argc < 3) { 163 | printf("usage: %s [QoS level]\n", argv[0]); 164 | return 1; 165 | } 166 | 167 | /* parse QoS level */ 168 | if (argc >= 4) { 169 | flags |= get_qos(argv[3]); 170 | } 171 | 172 | /* step 1: get topic id */ 173 | t.name = argv[1]; 174 | if (emcute_reg(&t) != EMCUTE_OK) { 175 | puts("error: unable to obtain topic ID"); 176 | return 1; 177 | } 178 | 179 | while (1) { 180 | int device_id = atoi(argv[2]); 181 | int temperature = random_uint32_range(0, 100); 182 | int h = random_uint32_range(0, 100); 183 | int wd = random_uint32_range(0, 360); 184 | int wi = random_uint32_range(0, 100); 185 | int rh = random_uint32_range(0, 50); 186 | char values[6] = {device_id, temperature, h, wd, wi, rh}; 187 | /* step 2: publish data */ 188 | if (emcute_pub(&t, values, sizeof(values), flags) != EMCUTE_OK) { 189 | printf("error: unable to publish data to topic '%s [%i]'\n", t.name, 190 | (int)t.id); 191 | return 1; 192 | } 193 | 194 | printf("Published %i bytes to topic '%s [%i]'\n", sizeof(values), t.name, 195 | t.id); 196 | xtimer_sleep(5); 197 | } 198 | 199 | return 0; 200 | } 201 | 202 | /* 203 | static int cmd_temp_pub(int argc, char **argv) 204 | { 205 | emcute_topic_t t; 206 | lpsxxx_t dev; 207 | unsigned flags = EMCUTE_QOS_0; 208 | 209 | if (argc < 3) 210 | { 211 | printf("usage: %s [QoS level]\n", argv[0]); 212 | return 1; 213 | } 214 | 215 | // parse QoS level 216 | if (argc >= 4) 217 | { 218 | flags |= get_qos(argv[3]); 219 | } 220 | 221 | // step 1: get topic id 222 | t.name = argv[1]; 223 | if (emcute_reg(&t) != EMCUTE_OK) 224 | { 225 | puts("error: unable to obtain topic ID"); 226 | return 1; 227 | } 228 | if (lpsxxx_init(&dev, &lpsxxx_params[0]) != LPSXXX_OK) 229 | { 230 | puts("Initialization failed"); 231 | return 1; 232 | } 233 | 234 | int16_t temp; 235 | while (1) 236 | { 237 | lpsxxx_enable(&dev); 238 | xtimer_sleep(1); // wait a bit for the measurements to complete 239 | lpsxxx_read_temp(&dev, &temp); 240 | lpsxxx_disable(&dev); 241 | int temp_abs = temp / 100; 242 | int device_id = atoi(argv[2]); 243 | int temperature = temp_abs; 244 | int h = random_uint32_range(0, 100); 245 | int wd = random_uint32_range(0, 360); 246 | int wi = random_uint32_range(0, 100); 247 | int rh = random_uint32_range(0, 50); 248 | char values[6] = {device_id, temperature, h, wd, wi, rh}; 249 | // step 2: publish data 250 | if (emcute_pub(&t, values, sizeof(values), flags) != EMCUTE_OK) 251 | { 252 | printf("error: unable to publish data to topic '%s [%i]'\n", 253 | t.name, (int)t.id); 254 | return 1; 255 | } 256 | 257 | printf("Published %i bytes to topic '%s [%i]'\n", 258 | sizeof(values), t.name, t.id); 259 | xtimer_sleep(5); 260 | } 261 | 262 | return 0; 263 | } 264 | 265 | static int cmd_read(int argc, char **argv) 266 | { 267 | lpsxxx_t dev; 268 | (void)argc; 269 | (void)argv; 270 | 271 | printf("Test application for %s pressure sensor\n\n", LPSXXX_SAUL_NAME); 272 | printf("Initializing %s sensor\n", LPSXXX_SAUL_NAME); 273 | 274 | if (lpsxxx_init(&dev, &lpsxxx_params[0]) != LPSXXX_OK) 275 | { 276 | puts("Initialization failed"); 277 | return 1; 278 | } 279 | 280 | uint16_t pres; 281 | int16_t temp; 282 | while (1) 283 | { 284 | lpsxxx_enable(&dev); 285 | xtimer_sleep(1); 286 | 287 | lpsxxx_read_temp(&dev, &temp); 288 | lpsxxx_read_pres(&dev, &pres); 289 | lpsxxx_disable(&dev); 290 | 291 | int temp_abs = temp / 100; 292 | temp -= temp_abs * 100; 293 | 294 | printf("Pressure value: %ihPa - Temperature: %2i.%02i°C\n", 295 | pres, temp_abs, temp); 296 | } 297 | 298 | return 0; 299 | } 300 | */ 301 | 302 | static const shell_command_t shell_commands[] = { 303 | {"con", "connect to MQTT broker", cmd_con}, 304 | {"discon", "disconnect from the current broker", cmd_discon}, 305 | {"pub", "publish something", cmd_pub}, 306 | {"fpub", "publish random data", cmd_fpub}, 307 | //{"read", "read device sensors", cmd_read}, 308 | //{"tpub", "publish random data + real temperature", cmd_temp_pub}, 309 | {NULL, NULL, NULL}}; 310 | 311 | int main(void) { 312 | puts("MQTT-SN example application\n"); 313 | puts( 314 | "Type 'help' to get started. Have a look at the README.md for more" 315 | "information."); 316 | 317 | /* the main thread needs a msg queue to be able to run `ping6`*/ 318 | msg_init_queue(queue, ARRAY_SIZE(queue)); 319 | 320 | /* initialize our subscription buffers */ 321 | memset(subscriptions, 0, (NUMOFSUBS * sizeof(emcute_sub_t))); 322 | 323 | /* start the emcute thread */ 324 | thread_create(stack, sizeof(stack), EMCUTE_PRIO, 0, emcute_thread, NULL, 325 | "emcute"); 326 | 327 | /* start shell */ 328 | char line_buf[SHELL_DEFAULT_BUFSIZE]; 329 | shell_run(shell_commands, line_buf, SHELL_DEFAULT_BUFSIZE); 330 | 331 | /* should be never reached */ 332 | return 0; 333 | } 334 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use futures::join; 2 | use log::{error, info, trace}; 3 | use mqtt::control::variable_header::ConnectReturnCode; 4 | use mqtt::{ 5 | packet::{ 6 | ConnackPacket, ConnectPacket, Packet, PingreqPacket, SubscribePacket, VariablePacket, 7 | }, 8 | Decodable, Encodable, QualityOfService, TopicFilter, TopicName, 9 | }; 10 | use std::{collections::HashMap, str, time::Duration}; 11 | use std::{env, io::Write}; 12 | use std::{net, process}; 13 | use tokio::{io::AsyncWriteExt, net::TcpStream}; 14 | 15 | use crate::utils::parse_argument; 16 | 17 | mod credentials; 18 | mod utils; 19 | 20 | #[tokio::main] 21 | async fn main() { 22 | // Loger Initialization 23 | env::set_var( 24 | "RUST_LOG", 25 | env::var_os("RUST_LOG").unwrap_or_else(|| "info".into()), 26 | ); 27 | env_logger::init(); 28 | 29 | // Parse arguments from CLI 30 | let matches = parse_argument(); 31 | 32 | // ThingsBoard server address, default is localhost. 33 | let server_addr = matches.value_of("SERVER").unwrap(); 34 | 35 | // ThingsBoard port address, default is 1883 36 | let server_port: u16 = matches.value_of("TPORT").unwrap().parse().unwrap(); 37 | let host = format!("{}:{}", server_addr, server_port); 38 | 39 | // ThingsBoard Gateway Device access_token 40 | let user_name = matches 41 | .value_of("USER_NAME") 42 | .map(ToString::to_string) 43 | .unwrap(); 44 | 45 | // Device ID 46 | let client_id = matches 47 | .value_of("CLIENT_ID") 48 | .map_or_else(utils::generate_client_id, ToString::to_string); 49 | 50 | let topic_name = matches 51 | .value_of("TOPIC") 52 | .map_or_else(|| String::from("hello/world"), ToString::to_string); 53 | 54 | // TTN server address, default is eu.thethings.network. 55 | let ttn_address = matches.value_of("TTN").map(ToString::to_string).unwrap(); 56 | 57 | // TTN port address 58 | let ttn_port: u16 = matches 59 | .value_of("RPORT") 60 | .unwrap() 61 | .parse() 62 | .expect("Port is not a number"); 63 | 64 | info!("Client identifier {:?}", client_id); 65 | 66 | let url = format!("{}:{}", ttn_address, ttn_port); 67 | info!("Connecting to TTN @ {} ... ", url); 68 | 69 | // Opens a TCP connection to TTN. 70 | let mut ttn_stream = net::TcpStream::connect(&url).expect("Can't connect to TTN"); 71 | 72 | // Opens a TCP connection to ThingsBoard. 73 | info!("Connecting to ThingsBoard @ {:?} ... ", host); 74 | let thingsboard_connection = match net::TcpStream::connect(&host) { 75 | Ok(stream) => { 76 | info!("Successfully connected to ThingsBoard @ {}", ttn_address); 77 | Ok(stream) 78 | } 79 | Err(e) => { 80 | error!("Can't connect to ThingsBoard. Error: {}", e); 81 | Err(e) 82 | } 83 | }; 84 | let mut thingsboard_stream = thingsboard_connection.unwrap(); 85 | 86 | // Create and Send an initial MQTT CONNECT packet to TTN. 87 | let credentials = credentials::get(); 88 | let mut conn = ConnectPacket::new(&client_id); 89 | conn.set_password(Some(credentials.appaccesskey.to_string())); 90 | conn.set_user_name(Some(credentials.appid.to_string())); 91 | let mut buf = Vec::new(); 92 | conn.encode(&mut buf).unwrap(); 93 | ttn_stream.write_all(&buf[..]).unwrap(); 94 | 95 | // Check if the connection is accepted 96 | let connack = ConnackPacket::decode(&mut ttn_stream).unwrap(); 97 | 98 | if connack.connect_return_code() != ConnectReturnCode::ConnectionAccepted { 99 | error!( 100 | "Failed to connect to TTN. Error: {:?}", 101 | connack.connect_return_code() 102 | ); 103 | process::exit(1); 104 | } 105 | 106 | info!("Successfully connected to TTN @ {}", url); 107 | 108 | // Create and send an initial MQTT CONNECT packet to Thingsboard. 109 | let mut conn = ConnectPacket::new(client_id); 110 | conn.set_clean_session(true); 111 | conn.set_user_name(Some(user_name)); 112 | let mut buf = Vec::new(); 113 | conn.encode(&mut buf).unwrap(); 114 | thingsboard_stream.write_all(&buf[..]).unwrap(); 115 | 116 | // Check if the connection is accepted 117 | let connack = ConnackPacket::decode(&mut thingsboard_stream).unwrap(); 118 | match connack.connect_return_code() { 119 | ConnectReturnCode::ConnectionAccepted => { 120 | info!("Successfully connected to Thingsboard @ {}", host); 121 | } 122 | _ => { 123 | error!( 124 | "Failed to connect to Thingsboard. Error: {:?}", 125 | connack.connect_return_code() 126 | ); 127 | process::exit(1); 128 | } 129 | } 130 | 131 | // Create a TopicFilter to Subscribe 132 | let mut channel_filters: Vec<(TopicFilter, QualityOfService)> = Vec::new(); 133 | channel_filters.push(( 134 | match TopicFilter::new(&topic_name) { 135 | Ok(a) => a, 136 | _ => unreachable!(), 137 | }, 138 | QualityOfService::Level0, 139 | )); 140 | 141 | // Create and send an MQTT SUBSCRIBE packet to TTN 142 | info!("Subscribed to {:?}", &channel_filters[0].0); 143 | let sub = SubscribePacket::new(10, channel_filters); 144 | let mut buf = Vec::new(); 145 | sub.encode(&mut buf).unwrap(); 146 | ttn_stream.write_all(&buf[..]).unwrap(); 147 | 148 | loop { 149 | let packet = match VariablePacket::decode(&mut ttn_stream) { 150 | Ok(pk) => pk, 151 | Err(err) => { 152 | error!("Error in receiving packet {:?}", err); 153 | continue; 154 | } 155 | }; 156 | trace!("PACKET {:?}", packet); 157 | 158 | if let VariablePacket::SubackPacket(ref ack) = packet { 159 | if ack.packet_identifier() != 10 { 160 | error!("SUBACK packet identifier not match"); 161 | process::exit(1); 162 | } 163 | info!("Subscribed!"); 164 | break; 165 | } 166 | } 167 | 168 | // Connection made, start the async work 169 | let mut stream = TcpStream::from_std(ttn_stream).unwrap(); 170 | let (mut mqtt_read, mut mqtt_write) = stream.split(); 171 | 172 | let ping_time = Duration::new(120, 0); 173 | let mut ping_stream = tokio::time::interval(ping_time); 174 | 175 | // PING TTN 176 | let ping_sender = async move { 177 | loop { 178 | ping_stream.tick().await; 179 | info!("Sending PINGREQ to TTN"); 180 | let pingreq_packet = PingreqPacket::new(); 181 | let mut buf = Vec::new(); 182 | pingreq_packet.encode(&mut buf).unwrap(); 183 | mqtt_write.write_all(&buf).await.unwrap(); 184 | } 185 | }; 186 | 187 | // Decode received packets 188 | let connection_topic = TopicName::new("v1/gateway/connect").unwrap(); 189 | let mut telemetry = HashMap::new(); 190 | let telemtry_topic = TopicName::new("v1/gateway/telemetry").unwrap(); 191 | let mut connected_device = vec![]; 192 | let receiver = async move { 193 | while let Ok(packet) = VariablePacket::parse(&mut mqtt_read).await { 194 | trace!("PACKET {:?}", packet); 195 | match packet { 196 | VariablePacket::PingrespPacket(..) => { 197 | info!("Receiving PINGRESP from TTN .."); 198 | } 199 | VariablePacket::PublishPacket(publ) => { 200 | // Take the payload, in bytes 201 | let payload = publ.payload(); 202 | 203 | // From bytes to JSON 204 | let jsonvalue: serde_json::Value = 205 | serde_json::from_slice(&payload).expect("JSON was not well-formatted"); 206 | 207 | let device_name = format!( 208 | "station_{}", 209 | &jsonvalue["end_device_ids"]["device_id"].as_str().unwrap() 210 | ); 211 | let payload_fields = &jsonvalue["uplink_message"]["decoded_payload"]["result"]; 212 | 213 | // Works with a payload decoder format on TTN like 214 | // function Decoder(bytes, port) { 215 | // var result = ""; 216 | // for (var byte in bytes){ 217 | // result += String.fromCharCode(bytes[byte]); 218 | // } 219 | // return {"result": result }; 220 | // } 221 | 222 | // A test payload, in bytes, can be "38 30 20 33 30 20 32 31 33 20 33 35 20 34 35" 223 | 224 | // Get the 5 values from the JSON 225 | let raw_str_values: Vec<&str> = payload_fields 226 | .as_str() 227 | .unwrap() 228 | .split_ascii_whitespace() 229 | .collect(); 230 | let raw_values: Vec = 231 | raw_str_values.iter().map(|x| x.parse().unwrap()).collect(); 232 | 233 | // Connect Gateway and Device, only if they are not already connected 234 | if !connected_device.contains(&device_name) { 235 | let device = utils::Device::new(&device_name); 236 | let message = serde_json::to_string(&device).unwrap(); 237 | utils::publish(&mut thingsboard_stream, &message, &connection_topic); 238 | connected_device.push(device_name.clone()); 239 | info!("Gateway and Device {} connected!", device_name); 240 | } 241 | // Forward the received message to ThingsBoard 242 | let temperature = raw_values[0] - 50; 243 | let values = utils::Values::new( 244 | temperature, 245 | raw_values[1], 246 | raw_values[2], 247 | raw_values[3], 248 | raw_values[4], 249 | ); 250 | let mut vector_values = Vec::new(); 251 | let sensor_telemetry = utils::generate_telemtry_packet(values); 252 | vector_values.push(sensor_telemetry); 253 | telemetry.insert(device_name, vector_values); 254 | let serialized_telemetry = serde_json::to_string(&telemetry).unwrap(); 255 | utils::publish( 256 | &mut thingsboard_stream, 257 | &serialized_telemetry, 258 | &telemtry_topic, 259 | ); 260 | } 261 | 262 | _ => {} 263 | } 264 | } 265 | }; 266 | 267 | join!(ping_sender, receiver); 268 | } 269 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------