lora-rb 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c69af1bb8d861091a38f5520a8e5363283da9c7c
-  data.tar.gz: be29e3ee50a7c565592c1edbd3f3f4f33c17ee56
+  metadata.gz: 235226d726a9323c2c3ccd296f08ca7193001179
+  data.tar.gz: 3602887c6d1d351785ce3c9249e88cf56ea25e90
 SHA512:
-  metadata.gz: b8f950c4d83d6b92c2cc16077f644d6de03ef0e61fea00530bfe94a985c761c95045cf1e12aba1f0c73c9b8b54355f12a323f888cd1cfa586ab2ceee4b799750
-  data.tar.gz: d7c5730946bee3ad5eadb5ebcc412329a5a3347403e2b262fcf469e4bb0cf14e7d222070c8be2a40c411aebc38793da00413d8fd8cd9f021d20f162ba9b34b9e
+  metadata.gz: 1b52de77fbcace7cc959ed9cf7534bd7348510b6464f39e3bf2006827e144c22e7a02f38365134b615baabefcdbcaf7b2043cc0e432246faaaf53152ad424dfe
+  data.tar.gz: 191e3fbdd9abd4157cc98e6c057a19f55f56399af25c7b0177cac2b0f06a56887b68f11ad47df651c29d1620451d73540908bd67a4af151dfb7352a0739f4f89

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+v0.14.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.13.0..v0.14.0) September 28th, 2017
+------------------------------
+* Mqtt: read data and listen does not add eui and port anymore if they are nil
+
 v0.13.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.12.0..v0.13.0) September 12th, 2017
 ------------------------------
 * Mqtt: in the send_cmd, qos parameter is not set by default anymore

data/README.md

@@ -26,8 +26,8 @@ among which you can choose to connect to the lora network.
 
 This version supports:
     
-1. TLS protocol with [Loriot](http://loriot.io)
-2. Http push with [Resiot](http://resiot.io)
+1. TLS protocol with [Loriot](http://loriot.io) (No longer supported)
+2. Http push with [Resiot](http://resiot.io) (No longer supported)
 3. MQTT with [A2aSmartCity](http://www.a2asmartcity.io/)
 
 ## Configuration
@@ -151,6 +151,7 @@ you should receive the instance with variables depending on protocol:
 lora.send_cmd(eui: 'Insert here your device eui', confirmed: true, data: '0101')
 ```
 
+Add **debug: true** to get a trace of the operations. Use the value __:full__ to get more information.
 The response depend on the provider.
 This is an example using tls protocol and the provider Loriot.io:
 
@@ -196,6 +197,8 @@ This is an example provided using mqtt protocol and the provider A2a:
  {"reply"=>{"confirmed"=>false, "id"=>150, "payload"=>"0100", "port"=>40, "priority"=>0}, "status"=>200, "eui"=>nil, "port"=>nil}
 ```
 
+#### Implemented only on Mqtt
+
 Using MQTT, by default the param wait_response is true. This means after publishing a message it waits the response 
 on dedicated topic.
 
@@ -219,6 +222,33 @@ lora.send_cmd(eui: 'Insert here your device eui',
               wait_response: false)
 ```
 
+The param delete_previous_enqueued_commands is true by default as well. It means previous enqueued messages to the node
+are deleted (the queue is emptied) before sending a new one.
+
+If you need to keep the queue:
+
+```ruby
+lora.send_cmd(eui: 'Insert here your device eui', confirmed: true, data: '0100', delete_previous_enqueued_commands: false)
+```
+
+To get enqueued messages:
+
+```ruby
+lora.get_enqueued_messages(eui: 'Insert here your device eui')
+```
+
+To explicitly delete enqueued messages:
+
+```ruby
+lora.delete_enqueued_messages(eui: 'Insert here your device eui')
+```
+
+or passing the id to delete ony that message:
+  
+  ```ruby
+lora.delete_enqueued_messages(eui: 'Insert here your device eui', id: 1234)
+  ```
+
 ### Uplink: receive data from devices
 
 To listen your devices:

data/lib/config/config.rb

@@ -12,7 +12,9 @@ LoraRb.configure do |config|
   config.port = 8883
   config.uplink_url = '/sub/v1/users/{username}/apps/{appid}/devices/+/uplink/+'
   config.downlink_url = '/api/v1/users/{username}/apps/{appid}/devices/{deveui}/downlink/post/reply/{clientid}/id/{requestid}'
-  config.timeout = 10.0
+  config.delete_enqueued_downlink_url = '/api/v1/users/{username}/apps/{appid}/devices/{deveui}/downlink/{id}/delete/reply/{clientid}/id/{requestid}'
+  config.enqueued_downlinks_url = '/api/v1/users/{username}/apps/{appid}/devices/{deveui}/downlink/get/reply/{clientid}/id/{requestid}'
+  config.timeout = 60.0
   # If you expect more than one response in a topic, add an item with url=nil to not subscribe it newly
   config.downlink_response_urls = [
       { name: :queued, url: 'reply/{clientid}/id/{requestid}'},

data/lib/config/private.yml

@@ -8,12 +8,12 @@ defaults: &defaults
   #connector_id: "69643d32"
   # A2a
   #appid: "a1b2c3d4e5f60001"
-  appid: "9955"
+  appid: "9956" # SSG dev
   token: "2B7E151628AED2A6ABF7158809CF4F3C"
   username: "fractalgarden"
   password: "fr4ctalg4rden"
 
-  test_eui: "be7a00000000123c"
+  test_eui: "be7a0000000010cf"
   #foo: add every variable you need and use it with => LoraRb::Settings.foo
   #  bar: sub variable are accessible with hash => LoraRb::Settings.foo[:bar]
 

data/lib/core/configuration.rb

@@ -3,7 +3,7 @@ module LoraRb
     # attr_writer :allow_sign_up
 
     attr_accessor :protocol, :host, :port, :uplink_url, :downlink_url, :downlink_response_urls, :ssl, :ssl_file, :env,
-                  :timeout
+                  :timeout, :enqueued_downlinks_url, :delete_enqueued_downlink_url
 
     def initialize
       @protocol = nil
@@ -11,7 +11,9 @@ module LoraRb
       @port = nil
       @uplink_url = nil
       @downlink_url = nil
+      @enqueued_downlinks_url = nil
       @downlink_response_urls = nil
+      @delete_enqueued_downlink_url = nil
       @ssl = nil # True if uses tls
       @ssl_file = nil # The certificate's path
       @env = 'development'

data/lib/lora-rb/base.rb

@@ -16,7 +16,9 @@ class LoraClient
                port: LoraRb.configuration.port,
                uplink_url: LoraRb.configuration.uplink_url,
                downlink_url: LoraRb.configuration.downlink_url,
+               enqueued_downlinks_url: LoraRb.configuration.enqueued_downlinks_url,
                downlink_response_urls: LoraRb.configuration.downlink_response_urls,
+               delete_enqueued_downlink_url: LoraRb.configuration.delete_enqueued_downlink_url,
                username: LoraRb::Settings.username,
                password: LoraRb::Settings.password,
                ssl: LoraRb.configuration.ssl,
@@ -26,6 +28,8 @@ class LoraClient
     @token = options[:token]
     @appid = options[:appid]
 
+    require 'philter'
+    require 'securerandom'
     welcome_response = sub_initialize(options)
 
     raise("Lora-rb: Cannot connect to host #{options[:host]}:#{options[:port]}") unless welcome_response.key?('hello')
@@ -67,6 +71,25 @@ class LoraClient
     sub_listen(options, &block)
   end
 
+  # It returns enqueued message ready to delivery to node
+  # ['topic', {'reply' => [ { ... } ], 'status' => 200}]
+  def get_enqueued_messages(eui:, request_id: nil, debug: false)
+    res = sub_get_enqueued_messages(eui: eui,
+                                    request_id: request_id,
+                                    debug: debug)
+    puts "get_enqueued_message #{res}" if @debug
+    res
+  end
+
+  # It returns enqueued message ready to delivery to node
+  # ['topic', [ {'reply' => { ... }, 'status' => 200 ] ]
+  def delete_enqueued_messages(eui:, id: nil, debug: false)
+    res = sub_delete_enqueued_messages(eui: eui,
+                                       id: id,
+                                       debug: debug)
+    puts "delete_enqueued_message #{res}" if @debug
+    res
+  end
   # Close the secure connection with the cloud
   def quit
     sub_quit

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

@@ -48,6 +48,16 @@ module LoraRb
       raise('In http protocol, it expects data with an http server. Lora Network server must exec an http push ')
     end
 
+    # Pending ...
+    def sub_get_enqueued_messages(eui:, request_id: nil, debug: false)
+      raise "Pending..."
+    end
+
+    # Pending ...
+    def sub_delete_enqueued_messages(eui:, request_id: nil, debug: false)
+      raise "Pending..."
+    end
+
     # Blank method. No need to close a connection with the http protocol
     def sub_quit
     end

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

@@ -21,7 +21,6 @@ module LoraRb
 
       @username = options[:username]
       @client_id = "#{@username}::ssg#{generate_request_id}"
-      @downlink_response_urls = options[:downlink_response_urls]
 
       @client = MQTT::Client.connect(
           host: options[:host],
@@ -38,7 +37,10 @@ module LoraRb
                                    appid: @appid },
                                  { debug: options[:debug] })
 
-      @downlink_url = merge_tags_to_url(options[:downlink_url])
+      @downlink_url = options[:downlink_url]
+      @downlink_response_urls = options[:downlink_response_urls]
+      @enqueued_downlinks_url = options[:enqueued_downlinks_url]
+      @delete_enqueued_downlink_url = options[:delete_enqueued_downlink_url]
       @timeout = options[:timeout]
       @wait_response = options.has_key?(:wait_response) ? options[:wait_response] : true
       {'hello' => 'Lora-Rb: Ready to start!'}
@@ -46,21 +48,16 @@ module LoraRb
 
     # Send the request to device
     def sub_send_cmd(options={})
-      options = { wait_response: @wait_response }.merge(options)
+      options = { wait_response: @wait_response, delete_previous_enqueued_commands: true }.merge(options)
+
+      sub_delete_enqueued_messages(eui: options[:eui], debug: options[:debug]) if options[:delete_previous_enqueued_commands]
+
       h_request = {
         "port": options[:port],               # Port where the message should be sent
         "payload": options[:data],            # Message payload
         "confirmed": options[:confirmed],     # (Optional) Tells whether a confirmed downlink is requested. Default: false
         "window": options[:window] || "BOTH", # (Optional) Specifies which rx window should be used: RX1, RX2 or any(BOTH). Default: BOTH
         "priority": options[:priority] || 0,  # (Optional) Message priority, used to sort messages in the queue. Default: 0
-       #"qos": options[:qos] || 1             # (Optional) Quality Of Service:
-                                              #     0 - Best effort. The message will be transmitted to the devices
-                                              #         of the group that satisfy the multicast profile requirements
-                                              #         (they should have been activated and have sent at least one
-                                              #         uplink, they should be class C devices, etc..).
-                                              #     1 - Transmission guaranteed. No message will be transmitted if
-                                              #         some devices do not satisfy the multicast profile requirements.
-                                              #         Default: 1 */
       }
       request_id = generate_request_id
       publish_url = merge_tags_to_url(@downlink_url,
@@ -70,9 +67,9 @@ module LoraRb
                                        clientid: @client_id,
                                        requestid: request_id)
 
-      puts "#{Time.now} publish #{h_request.to_json} to #{publish_url}" if options[:debug]
-
+      puts "  publish #{h_request.to_json} to #{publish_url}" if options[:debug]
       responses = []
+      response_topics = []
       # thr_response = nil
       if options[:wait_response]
         @downlink_response_urls.each do |dru_hash|
@@ -86,9 +83,12 @@ module LoraRb
                                              deveui: options[:eui],
                                              clientid: @client_id,
                                              requestid: request_id)
-          puts " [x] Subscribing response #{response_topic}" if options[:debug] == :full
-          @client.subscribe(response_topic)
+          puts "  Subscribing response #{response_topic}" if options[:debug] == :full
+          response_topics << response_topic
         end
+
+        raise "cannot subscribe without topic, response_topics is empty!" if response_topics.empty?
+        @client.subscribe(*response_topics)
       end
 
       @client.publish(publish_url, h_request.to_json, false)
@@ -98,11 +98,13 @@ module LoraRb
         # thr_responses.each { |thr_response| thr_response.join }
         # thr_response.join
         @downlink_response_urls.each do |dru_hash|
-          response_topic, response_message = sub_read_data(topic: nil)
+          response_topic, response_message = sub_read_data(topic: nil, debug: options[:debug])
           response = { topic: response_topic, json: response_message }
-          puts " [x] Found response #{response} " if options[:debug] == :full
+          puts "  Found response #{response} " if options[:debug] == :full
           responses << response
         end
+
+        @client.unsubscribe(*response_topics)
       end
       responses
     end
@@ -110,11 +112,12 @@ module LoraRb
     # Receive the payload from the network
     # There is a timeout. Use this method only to retrieve data from the queue. If you have to waiting data
     # please use listen.
+    # If topic is nil it uses subscribed topics
     def sub_read_data(options={})
       topic = options.has_key?(:topic) ? options[:topic] : @topic
       if topic
         topic = topic.dup
-        puts " [x] Reading topic #{topic}..." if options[:debug]
+        puts "  Reading topic #{topic}..." if options[:debug]
       end
 
       message = nil
@@ -128,8 +131,10 @@ module LoraRb
 
       message = JSON.parse(message)
       if message.respond_to? '[]'
-        message['eui'] ||= get_eui_from_topic(topic)
-        message['port'] ||= get_port_from_topic(topic)
+        eui = get_eui_from_topic(topic)
+        message['eui'] ||= eui if eui
+        port = get_port_from_topic(topic)
+        message['port'] ||= port if port
       end
       return topic, message
     end
@@ -139,18 +144,20 @@ module LoraRb
       topic = options.has_key?(:topic) ? options[:topic] : @topic
       if topic
         topic = topic.dup
-        puts " [*] Waiting for messages in #{topic}. To exit press CTRL+C" if options[:debug]
+        puts "  Waiting for messages in #{topic}. To exit press CTRL+C" if options[:debug]
       end
 
       @client.get(topic) do |topic, message|
         # Block is executed for every message received
-        puts " [x] #{topic}: #{message}" if options[:debug]
+        puts "  original json: #{topic}: #{message}" if options[:debug] == :full
         message = JSON.parse(message)
         if message.respond_to? '[]'
-          message['eui'] ||= get_eui_from_topic(topic)
-          message['port'] ||= get_port_from_topic(topic)
+          eui = get_eui_from_topic(topic)
+          message['eui'] ||= eui if eui
+          port = get_port_from_topic(topic)
+          message['port'] ||= port if port
         end
-        puts " [x] after rework: #{message}" if options[:debug]
+        puts "  #{message}" if options[:debug] #After reworking
         block.call(topic, message) if block_given?
         break if options[:test]
       end
@@ -161,7 +168,80 @@ module LoraRb
       @client.disconnect
     end
 
-    private
+    # Get enqueued messages from the network queue
+    def sub_get_enqueued_messages(eui:, request_id:  nil, debug: false)
+      request_id ||= generate_request_id
+      raise "eui cannot be empty!" unless eui
+
+      queued_response_url = @downlink_response_urls.philter({name: :queued}, get: :url).first
+      raise "queued_topic not found in the config yml!" unless queued_response_url
+      queued_response_url = merge_tags_to_url(queued_response_url,
+                                         username: @username,
+                                         appid: @appid,
+                                         deveui: eui,
+                                         clientid: @client_id,
+                                         requestid: request_id)
+      puts " queued_response_url #{queued_response_url}" if debug
+      @client.subscribe(queued_response_url)
+
+      # Check if there are previous messages to clear
+      enqueued_downlinks_url = merge_tags_to_url(@enqueued_downlinks_url,
+                                                 username: @username,
+                                                 appid: @appid,
+                                                 deveui: eui,
+                                                 clientid: @client_id,
+                                                 requestid: request_id)
+      puts " enqueued_downlinks_url #{enqueued_downlinks_url}" if debug
+      # Request enqueued items
+      @client.publish(enqueued_downlinks_url, ''.to_json, false)
+
+      response_topic, response_message = sub_read_data(topic: nil, debug: debug)
+      puts "  Topic #{response_topic} response #{response_message} " if debug == :full
+
+      @client.unsubscribe(queued_response_url)
+
+      return response_topic, response_message
+    end
+
+    # Delete one or all enqueued messages from the network queue
+    def sub_delete_enqueued_messages(eui:, id: nil, debug: false)
+      request_id = generate_request_id
+      ids_to_delete = id ? [id] : all_enqueued_downlink_id(eui: eui, request_id: request_id, debug: debug)
+      queued_response_url = @downlink_response_urls.philter({name: :queued}, get: :url).first
+      raise "queued_topic not found in the config yml!" unless queued_response_url
+      queued_response_url = merge_tags_to_url(queued_response_url,
+                                       username: @username,
+                                       appid: @appid,
+                                       deveui: eui,
+                                       clientid: @client_id,
+                                       requestid: request_id)
+
+      puts " response_topic #{queued_response_url}" if debug
+      @client.subscribe(queued_response_url)
+
+      responses = []
+      ids_to_delete.each do |id_to_delete|
+        # Check if there are previous messages to clear
+        delete_enqueued_downlink_url = merge_tags_to_url(@delete_enqueued_downlink_url,
+                                                         username: @username,
+                                                         appid: @appid,
+                                                         deveui: eui,
+                                                         id: id_to_delete,
+                                                         clientid: @client_id,
+                                                         requestid: request_id)
+        puts " delete_enqueued_downlink_url #{delete_enqueued_downlink_url}" if debug
+        # Request enqueued items
+        @client.publish(delete_enqueued_downlink_url, ''.to_json, false)
+
+        queued_response_url, response_message = sub_read_data(topic: nil, debug: debug)
+        puts "  Found response #{response_message} " if debug == :full
+        responses << response_message
+      end
+
+      @client.unsubscribe(queued_response_url)
+
+      return queued_response_url, responses
+    end
 
     def get_eui_from_topic(topic)
       res = topic&.match(/devices\/(\w{16})/)
@@ -174,7 +254,29 @@ module LoraRb
     end
 
     def generate_request_id
-      Time.now.strftime('%y%m%d%H%M%S')
+      "#{Time.now.strftime('%y%m%d%H%M%S')}#{SecureRandom.hex(1)}"
+    end
+
+    # It returns and array of ids from enqueued downlink response
+    # Response example:
+    # {"reply"=>[
+    #   {"confirmed"=>true, "id"=>5034, "payload"=>"0200", "port"=>40, "priority"=>0},
+    #   {"confirmed"=>true, "id"=>5035, "payload"=>"0200", "port"=>40, "priority"=>0},
+    #   {"confirmed"=>true, "id"=>5036, "payload"=>"0200", "port"=>40, "priority"=>0},
+    #   {"confirmed"=>true, "id"=>5037, "payload"=>"0200", "port"=>40, "priority"=>0}],
+    #  "status"=>200}]
+    # Returns:
+    # [5034, 5035, 5036, 5037]
+    def all_enqueued_downlink_id(enqueued_messages:nil, eui:nil, request_id:nil, debug:false)
+      enqueued_messages ||= sub_get_enqueued_messages(eui: eui, request_id: request_id, debug: debug).last
+      raise "Cannot process enqueued messages since status=#{enqueued_messages['status']}" unless enqueued_messages['status'] == 200
+      return [] if enqueued_messages['reply'].nil?
+      raise "An array was expected not: #{enqueued_messages['reply']}" unless enqueued_messages['reply'].is_a?(Array)
+      res = enqueued_messages['reply'].map do |message|
+        message['id']
+      end
+      puts "#{res}" if debug == :full
+      res
     end
 
   end

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

@@ -43,6 +43,16 @@ module LoraRb
       end
     end
 
+    # Pending ...
+    def sub_get_enqueued_messages(eui:, request_id: nil, debug: false)
+      raise "Pending..."
+    end
+
+    # Pending ...
+    def sub_delete_enqueued_messages(eui:, request_id: nil, debug: false)
+      raise "Pending..."
+    end
+
     # Close the connection
     def sub_quit
       @connection.close

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

@@ -75,6 +75,16 @@ module LoraRb
       end while response && !options[:test]
     end
 
+    # Pending ...
+    def sub_get_enqueued_messages(eui:, request_id: nil, debug: false)
+      raise "Pending..."
+    end
+
+    # Pending ...
+    def sub_delete_enqueued_messages(eui:, request_id: nil, debug: false)
+      raise "Pending..."
+    end
+
     # Close the connection
     def sub_quit
       @ssl_socket.close

data/lib/lora-rb/utility.rb

@@ -16,4 +16,8 @@ module LoraRb
       url
     end
   end
+
+  def puts(message)
+    Kernel.puts "[#{self.class.name}##{__method__}] #{Time.now} #{message}"
+  end
 end

data/lib/version.rb

@@ -1,8 +1,8 @@
 module LoraRb
   def self.version
-    "0.13.0"
+    "0.14.0"
   end
   def self.updated_at
-    "2017-09-12"
+    "2017-09-29"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lora-rb
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Marco Mastrodonato
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -26,6 +26,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: philter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement