lora-rb 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79c6d0b8da60562e095fecb4d8c78b436a1a4e92
-  data.tar.gz: 7629b1d3970c241e5d9a0e275aec3c966d859510
+  metadata.gz: 93e06d7a345ef9d3fbd6d15f3b83def826bb7b1d
+  data.tar.gz: 342d7271ad93a511afb6d961b24a98c7622ca82e
 SHA512:
-  metadata.gz: 3fb99d9ed59893102df187a271e0bc8dc0fe9c0c81e09f329e3759a6e0a4ab2b81f37b255fbc12c59ad5ceb0a90ba0923a188be79ffab2a52b3b1022e876bc9d
-  data.tar.gz: 46256d4883731154991c811ac96ab6f224d08f0934dcf7826d3e2a71e4744b00c2230c06e9e6947f9888b0b6aa6b2214b721f3d0b143a4723f7c7a9a9f346e2e
+  metadata.gz: 57bdf6e6a7a1f395ac9000a0c579999e6932c542e77f42b9abadd2e14753f20a499f7c26a5e0751d00819a3e8062bf1cc203fb0e4efc759b2daa74a9d0d1ae7d
+  data.tar.gz: b73ce87d688ea98f6760ef2e92275ac384496e3d2443b8681db4f1544b0d633609a7bf0455e3e8a61554f4277c41065c691674fea28ec1ebd39227d3f4e48e40

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.10.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.9.0..v0.10.0) August 8th, 2017
+------------------------------
+* Mqtt: 
+    * added multi threading support
+    * send_cmd now set wait_response: true by default. With this param, the response is waited using a separate thread
+
 v0.9.3 August 8th, 2017
 ------------------------------
 * Fixed a bug with mqtt protocol: now when LoraClient is instantiated uses the new client id just generated

data/README.md

@@ -1,5 +1,5 @@
-# IOT at you service with LoraWan and Ruby
-### Manage your devices inside a Lora Network
+# IOT at you service with Lora and Ruby
+### Manage your devices under the Lora Network
 
 [![Version     ](https://badge.fury.io/rb/lora-rb.svg)                        ](https://rubygems.org/gems/lora-rb)
 [![Travis CI   ](http://img.shields.io/travis/marcomd/lora-rb/master.svg)     ](https://travis-ci.org/marcomd/lora-rb)
@@ -21,7 +21,8 @@ To use it in a bundle, add to gem file `gem 'lora-rb'` and run `bundle install`
 
 ## Connection to lora server
 
-Establish a secure connection to your `Lora Application` on the cloud.
+To use this gem you have to choose your provider. Each of them has its own features and offers a bouquet of protocols 
+among which you can choose to connect to the lora network.
 
 This version supports:
     1. TLS protocol with [Loriot](http://loriot.io)
@@ -30,11 +31,11 @@ This version supports:
 
 ## Configuration
 
-Insert private information in the yaml:
+Insert private informations in the yaml:
 
     lib/config/private.yml
 
-and the configuration's parameter in the config file.
+and the configuration's parameters in the config file.
 
     lib/config/config.rb
 
@@ -42,7 +43,9 @@ If you are using rails you can use the generator:
 
     bundle exec rails generate lora_rb:install
 
-Every provider assign you a token and an appkey or an appid. Insert your secret data in the yaml:
+Every provider assign you a token and an app id. 
+Someone can provide some additional parameters such as username and password. 
+Insert your secret data in the yaml:
 
 ```yaml
 defaults:
@@ -54,7 +57,8 @@ defaults:
   connector_id:
 ```
 
-If you are using Rails 5.1 you can do something like this:
+If you are using Rails 5.1 you can encrypt these private data and insert into the yaml with erb. 
+Something like this:
 
 ```yaml
 defaults: &defaults
@@ -63,11 +67,15 @@ defaults: &defaults
   # etc ...
 ```
 
+## Connection's protocols
+
+While the information in the yaml file is subdivided by environment, the connection configuration file contains 
+shared parameters for all environments.
+
 ### TLS (with Loriot)
 
 ```ruby
 LoraRb.configure do |config|
-  # These informations are shared for all environments
   config.protocol = :tls
   config.host = 'eu1.loriot.io'
   config.port = 737
@@ -78,7 +86,6 @@ end
 
 ```ruby
 LoraRb.configure do |config|
-  # These informations are shared for all environments
   config.protocol = :http
   config.host = 'eu72.resiot.io'
   config.port = 80
@@ -89,7 +96,6 @@ end
 
 ```ruby
 LoraRb.configure do |config|
-  # These informations are shared for all environments
   config.protocol = :rabbitmq
   config.host = 'localhost'
 end
@@ -99,7 +105,6 @@ end
 
 ```ruby
 LoraRb.configure do |config|
-  # These informations are shared for all environments
   config.protocol = :mqtt
   config.host = 'ptnetsuite.a2asmartcity.io'
   config.port = 8883
@@ -130,34 +135,69 @@ you should receive the instance with variables depending on protocol:
 #<LoraClient:0x0056318ad8e048 ...
 ```
 
-### Send data to a device
+### Downlink: send data to the device
 
 
 ```ruby
-lora.send_cmd(EUI: 'Insert here your EUI code', confirmed: true, data: "0101")
+lora.send_cmd(eui: 'Insert here your device eui', confirmed: true, data: '0101')
 ```
 
-Request example:
+The response depend on the provider.
+This is an example using tls protocol and the provider Loriot.io:
 
 ```json
-{ "cmd":"tx", "EUI":"BE7A0000000010B7", "port":40, "confirmed":false, "data":"0101" }
+{ "cmd":"tx", "EUI":"a000000000001234", "port":40, "confirmed":false, "data":"0101" }
 ```
 
-Response example:
+or
 
 ```json
-{ "cmd":"txd", "EUI":"BE7A0000000010B7", "seqdn":114, "seqq":113, "ts":1489133179385 }
+{ "cmd":"txd", "EUI":"a000000000001234", "seqdn":114, "seqq":113, "ts":1489133179385 }
 ```
 
-`"cmd":"txd"` show the data sent to the gateway
+or
+
+```json
+{ "cmd":"tx", "EUI":"a000000000001234", "seqdn": 4, "data": "0301", "success": "Data enqueued" }
+```
+
+This is an example using http protocol and the provider Resiot.io
+
+```json
+{
+ "CommType"=>"comm_rx",
+ "Connector"=>"69643d32",
+ "AppEui"=>"a1b2c3d4e5f60001",
+ "DevEui"=>"be7a00000000123c",
+ "Port"=>"10",
+ "GatewayEUIs"=>["00000111180e2222"],
+ "Payload"=>"0063",
+ "Extra"=>{"JSONRXINFO"=>"[\"{\\\"altitude\\\":0,\\\"latitude\\\":0,\\\"loRaSNR\\\":8.8,\\\"longitude\\\":0,\\\"mac\\\":\\\"00000111180e2222\\\",\\\"name\\\":\\\"00000111180e2222\\\",\\\"rssi\\\":-67}\"]",
+           "adr"=>"true", "bandwidth"=>"125", "fCnt"=>"132", "frequency"=>"868100000", "spreadFactor"=>"7"},
+ "DT"=>"2017-07-03T15:28:01.098886848+02:00",
+ "auth_token"=>"abcd1234",
+ "lora"=>{"CommType"=>"comm_rx", "Connector"=>"abcd", "AppEui"=>"abcd", "DevEui"=>"a000000000001234", "Port"=>"10", "GatewayEUIs"=>["abcd"], "Payload"=>"0063",
+          "Extra"=>{"JSONRXINFO"=>"[\"{\\\"altitude\\\":0,\\\"latitude\\\":0,\\\"loRaSNR\\\":8.8,\\\"longitude\\\":0,\\\"mac\\\":\\\"00000111180e2222\\\",\\\"name\\\":\\\"00000111180e2222\\\",\\\"rssi\\\":-67}\"]", "adr"=>"true", "bandwidth"=>"125", "fCnt"=>"132", "frequency"=>"868100000", "spreadFactor"=>"7"}, "DT"=>"2017-07-03T15:28:01.098886848+02:00"}
+}
+```
 
-The response could also be:
+This is an example provided using mqtt protocol and the provider A2a:
 
 ```json
-{ "cmd":"tx", "EUI":"BE7A0000000010CF", "seqdn": 4, "data": "0301", "success": "Data enqueued" }
+ {"reply"=>{"confirmed"=>false, "id"=>150, "payload"=>"0100", "port"=>40, "priority"=>0}, "status"=>200, "eui"=>nil, "port"=>nil}
 ```
 
-### Receive Data
+Using MQTT, by default the param wait_response is true. This means after publishing a message it waits the response 
+on dedicated topic.
+If you dont want to wait the response you just set that param to false.
+
+```ruby
+lora.send_cmd(eui: 'Insert here your device eui',
+              data: 'f0a1b3ff',
+              wait_response: false)
+```
+
+### Uplink: receive data from devices
 
 To listen your devices:
 
@@ -165,6 +205,39 @@ To listen your devices:
 lora.listen
 ```
 
+You can also pass a block.
+
+```ruby
+lora.listen do |response|
+  # Do something ...
+end
+```
+
+or with RabbitMq:
+
+```ruby
+lora.listen do |delivery_info, properties, body|
+  # Do something ...
+end
+```
+
+or with mqtt protocol:
+
+```ruby
+lora.listen do |topic, response|
+  # Do something ...
+end
+```
+
+Using http protocol, instead, #listen is not available because uplink messages are received by api.
+
+To receive only one message:
+
+```ruby
+lora.read_data
+```
+It returns the same data of listen method.
+
 ### Close the connection
 
 ```ruby

data/lib/lora-rb/mqtt/call.rb

@@ -36,11 +36,13 @@ module LoraRb
                                  { debug: options[:debug] })
 
       @downlink_url = merge_tags_to_url(options[:downlink_url])
+      @wait_response = options.has_key?(:wait_response) ? options[:wait_response] : true
       {'hello' => 'Lora-Rb: Ready to start!'}
     end
 
     # Send the request to device
     def sub_send_cmd(options={})
+      options = { wait_response: @wait_response }.merge(options)
       h_request = {
         "port": options[:port],               # Port where the message should be sent
         "payload": options[:data],            # Message payload
@@ -66,14 +68,23 @@ module LoraRb
 
       puts "#{Time.now} publish #{h_request.to_json} to #{publish_url}" if options[:debug]
 
-      response = @client.publish(publish_url, h_request.to_json, false)
-      puts " [x] publish response: #{response}" if options[:debug]
 
+      response = nil
       if options[:wait_response]
         response_topic = "reply/#{@client_id}/id/#{request_id}"
-        puts " [x] Waiting response on #{response_topic} ..." if options[:debug]
-        response_topic, response = sub_read_data(topic: response_topic)
+        puts " [x] Starting thread to wait response on topic #{response_topic} ..." if options[:debug]
+        thr_response = Thread.new { response_topic, response = sub_read_data(topic: response_topic) }
+        #sleep 0.1
+      end
+
+      response = @client.publish(publish_url, h_request.to_json, false)
+
+      if options[:wait_response]
+        # Waiting for the response
+        thr_response.join
         puts " [x] Topic response: #{response}" if options[:debug]
+      else
+        puts " [x] Publish response: #{response}" if options[:debug]
       end
       response
     end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module LoraRb
   def self.version
-    "0.9.3"
+    "0.10.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lora-rb
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Marco Mastrodonato