lora-rb 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e64d803226daebe33886346c591fe64547de3222
-  data.tar.gz: f8bbfa9765e0b8e59e1a5d31cd393bd162ca599f
+  metadata.gz: 13e675828b129c8d27b670935487ff710a8109ff
+  data.tar.gz: 7d559b6b2240436b69f4343648f471caee250cea
 SHA512:
-  metadata.gz: '02503788daa2ca41e53219162fbba9062060d491058cc9f72f5ba639ffd23341b4ce7573c4b0769c0a7bcdd97fbe261601280b7de7c0248ea0c8f55daabee7b1'
-  data.tar.gz: 38a51544561b73924783012f69118e0916950dacb3fc3ad8a7500a10e3b47d8f1cc47fb7937a01d8c68fc483168202e8b0fdc233e09158ec821e3a8999a0aefd
+  metadata.gz: 8757592a55411332611df7ebd2b1d69bb8ddd08c59429485b98940322dadad5cb9e7daa7ec4ca08ccdd6fd0c1a1226fa24be7a484dd18cc676ce70b64610591f
+  data.tar.gz: c47ea7135d3ebea9216467fbde51789f2da7ceed90e66bc43a141c67c4154bcb7c84821e59d65d88b23f9c6505d6a23bec903c4c2120a649d8b4c9998242336c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+v0.16.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.15.0..v0.16.0) November 21th, 2017
+------------------------------
+* Encoding / Decoding with Base64:
+  * Now on a new instance is possible to set encoding: true to encode the payload sent and to decode json
+    attribute "payload" or "data"
+* lora instance object now return provider and protocol
+* Tests are now devided by provider
+
 v0.15.0 [☰](https://bitbucket.org/fractalgarden/loriot-rb/branches/compare/v0.14.0..v0.15.0) November 1th, 2017
 ------------------------------
 * Added new parameter "provider" to connection's configuration 

data/README.md

@@ -29,6 +29,7 @@ This version supports:
 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/)
+4. MQTT with Fractalgarden (Those who are developing this gem)
 
 ## Configuration
 
@@ -115,6 +116,7 @@ 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 = 30.0
   config.downlink_response_urls = {
       queued: 'reply/{clientid}/id/{requestid}',
       transmitted: '/sub/v1/users/{username}/apps/{appid}/devices/{deveui}/events/downlink'
@@ -124,6 +126,26 @@ LoraRb.configure do |config|
 end
 ```
 
+### MQTT (with Fractalgarden free lora server)
+
+Currently, the free network server is under development.
+
+```ruby
+LoraRb.configure do |config|
+  config.provider = :fractalgarden
+  config.protocol = :mqtt
+  config.host = 'lora.fractalgarden.com'
+  config.port = 1883
+  config.uplink_url = 'application/{appid}/node/+/rx'
+  config.downlink_url = 'application/{appid}/node/{deveui}/tx'
+  config.timeout = 30.0
+  config.downlink_response_urls = [
+      { name: :queued, url: 'reply/{clientid}/id/{requestid}'},
+  ]
+  config.ssl = false
+end
+```
+
 ## Usage
 
 From irb require the library:
@@ -222,6 +244,10 @@ lora.send_cmd(eui: 'Insert here your device eui',
               wait_response: false)
 ```
 
+#### Only on Mqtt (A2a)
+
+The a2a network server let you to manage the enqueued messages. 
+
 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.
 

data/lib/config/config.rb

@@ -8,35 +8,35 @@ LoraRb.configure do |config|
   # config.protocol = :http
   # config.host = 'eu72.resiot.io'
   # A2a
-  config.provider = :a2a
+  # config.provider = :a2a
+  # config.protocol = :mqtt
+  # config.host = 'ptnetsuite.a2asmartcity.io'
+  # 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.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}'},
+  #     # { name: :transmitted, url: '/sub/v1/users/{username}/apps/{appid}/devices/{deveui}/events/downlink' }
+  #     # { name: :confirmed, url: nil },
+  # ]
+  # config.ssl = true
+  # config.ssl_file = 'ssl_certificates/mqtt_ca.crt'
+  # Fractalgarden Free Network Server
+  config.provider = :fractalgarden
   config.protocol = :mqtt
-  config.host = 'ptnetsuite.a2asmartcity.io'
-  config.port = 8883
+  config.host = '192.168.1.106'
+  config.port = 1883
   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.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.timeout = 30.0
+  # If you expect more than one response in a topic, ad a item with url=nil to not subscribe it newly
   config.downlink_response_urls = [
       { name: :queued, url: 'reply/{clientid}/id/{requestid}'},
-      # { name: :transmitted, url: '/sub/v1/users/{username}/apps/{appid}/devices/{deveui}/events/downlink' }
-      # { name: :confirmed, url: nil },
   ]
-  config.ssl = true
-  config.ssl_file = 'ssl_certificates/mqtt_ca.crt'
-  # Fractalgarden Free Network Server
-  # config.provider = :fractalgarden
-  # config.protocol = :mqtt
-  # config.host = '192.168.1.106'
-  # config.port = 1883
-  # config.uplink_url = 'application/{appid}/node/+/rx'
-  # config.downlink_url = 'application/{appid}/node/{deveui}/tx'
-  # config.timeout = 30.0
-  # # If you expect more than one response in a topic, ad a item with url=nil to not subscribe it newly
-  # config.downlink_response_urls = [
-  #     { name: :queued, url: 'reply/{clientid}/id/{requestid}'},
-  # ]
-  # config.ssl = false
-  # # config.ssl_file = "#{Rails.root}/vendor/ssl_certificates/a2a_mqtt_ca.crt"
+  config.ssl = false
+  # config.ssl_file = "#{Rails.root}/vendor/ssl_certificates/a2a_mqtt_ca.crt"
 end

data/lib/config/private.yml

@@ -9,15 +9,16 @@ defaults: &defaults
   # A2a
   #appid: "a1b2c3d4e5f60001"
   token: "2B7E151628AED2A6ABF7158809CF4F3C"
-  appid: "9957"
-  username: "fractalgarden"
-  password: "fr4ctalg4rden"
+#  appid: "9957"
+#  username: "fractalgarden"
+#  password: "fr4ctalg4rden"
   # Fractalgarden
-#  appid: "1"
-#  username: "loraserver_gw"
-#  password: "loraserver_gw"
+  appid: "1"
+  username: "loraserver"
+  password: "loraserver"
 
-  test_eui: "be7a00000000123c"
+#  test_eui: "be7a00000000123c"
+  test_eui: "be7a000000001a5f"
   #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/lora-rb/a2a/mqtt/call.rb

@@ -55,9 +55,9 @@ module LoraRb
       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
+          "port": options[:port], # Port where the message should be sent
+          "payload": (@encoding ? lora_encode(options[:data]) : options[:data]), # Message payload
+          "confirmed": options[:confirmed], # (Optional) Tells whether a confirmed downlink is requested. Default: false
       }
       # (Optional) Specifies which rx window should be used: RX1, RX2 or any(BOTH). Default: BOTH
       h_request['window'] = options[:window] if options[:window]
@@ -140,6 +140,10 @@ module LoraRb
         message['eui'] ||= eui if eui
         port = get_port_from_topic(topic)
         message['port'] ||= port if port
+        if @encoding
+          payload_key = %w(payload data).find { |tag| message[tag] }
+          message[payload_key] = lora_decode(message[payload_key]) if payload_key
+        end
       end
       return topic, message
     end
@@ -161,6 +165,10 @@ module LoraRb
           message['eui'] ||= eui if eui
           port = get_port_from_topic(topic)
           message['port'] ||= port if port
+          if @encoding
+            payload_key = %w(payload data).find { |tag| message[tag] }
+            message[payload_key] = lora_decode(message[payload_key]) if payload_key
+          end
         end
         puts "  #{message}" if options[:debug] #After reworking
         block.call(topic, message) if block_given?

data/lib/lora-rb/base.rb

@@ -7,6 +7,8 @@ require_relative 'utility'
 class LoraClient
   include LoraRb::Base
 
+  attr_reader :provider, :protocol
+
   # Establish a secure connection to your account on the cloud
   def initialize(options = {})
     options = {debug: false,
@@ -23,11 +25,17 @@ class LoraClient
                password: LoraRb::Settings.password,
                ssl: LoraRb.configuration.ssl,
                ssl_file: LoraRb.configuration.ssl_file,
-               timeout: LoraRb.configuration.timeout }.merge(options)
+               timeout: LoraRb.configuration.timeout,
+               encoding: false}.merge(options)
     @debug = options[:debug]
     @token = options[:token]
     @appid = options[:appid]
 
+    @provider = LoraRb.configuration.provider
+    @protocol = LoraRb.configuration.protocol
+    @encoding = options[:encoding]
+    require 'base64' if @encoding
+
     require 'philter'
     require 'securerandom'
 
@@ -35,7 +43,7 @@ class LoraClient
     raise "Specify the protocol in the configuration file!" unless LoraRb.configuration.protocol
     raise "Provider #{LoraRb.configuration.provider} not defined!" unless LoraRb::Protocol.provider_is_valid?
     raise "Connection protocol #{LoraRb.configuration.protocol} not supported by the provider #{LoraRb.configuration.provider}!" unless LoraRb::Protocol.supported?
-    require_relative "#{LoraRb.configuration.provider}/#{LoraRb.configuration.protocol}/call"
+    require_relative "#{@provider}/#{@protocol}/call"
     self.extend LoraRb::Call
 
     welcome_response = sub_initialize(options)

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

@@ -54,9 +54,9 @@ module LoraRb
 
       request_id = generate_request_id
       h_request = {
-          "fport": options[:port],              # Port where the message should be sent
-          "data": options[:data],               # Message payload
-          "confirmed": options[:confirmed],     # (Optional) Tells whether a confirmed downlink is requested. Default: false
+          "fport": options[:port], # Port where the message should be sent
+          "data": (@encoding ? lora_encode(options[:data]) : options[:data]), # Message payload
+          "confirmed": options[:confirmed], # (Optional) Tells whether a confirmed downlink is requested. Default: false
           "devEUI": options[:eui],
           "reference": request_id
       }
@@ -136,6 +136,10 @@ module LoraRb
         message['eui'] ||= eui if eui
         port = get_port_from_topic(topic)
         message['port'] ||= port if port
+        if @encoding
+          payload_key = %w(payload data).find { |tag| message[tag] }
+          message[payload_key] = lora_decode(message[payload_key]) if payload_key
+        end
       end
       return topic, message
     end
@@ -157,6 +161,10 @@ module LoraRb
           message['eui'] ||= eui if eui
           port = get_port_from_topic(topic)
           message['port'] ||= port if port
+          if @encoding
+            payload_key = %w(payload data).find { |tag| message[tag] }
+            message[payload_key] = lora_decode(message[payload_key]) if payload_key
+          end
         end
         puts "  #{message}" if options[:debug] #After reworking
         block.call(topic, message) if block_given?

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

@@ -18,7 +18,7 @@ module LoraRb
 
     # Send the request to device
     def sub_send_cmd(options={})
-      str_request = "{\"cmd\":\"#{options[:cmd]}\",\"EUI\":\"#{options[:eui]}\",\"port\":#{options[:port]},\"confirmed\":#{options[:confirmed]},\"data\":\"#{options[:data]}\"} 	"
+      str_request = "{\"cmd\":\"#{options[:cmd]}\",\"EUI\":\"#{options[:eui]}\",\"port\":#{options[:port]},\"confirmed\":#{options[:confirmed]},\"data\":\"#{(@encoding ? lora_encode(options[:data]) : options[:data])}\"} 	"
       puts "#{Time.now} Cmq request: #{str_request}" if options[:debug]
       response = @channel.default_exchange.publish(str_request, routing_key: @queue.name)
       puts " [x] Sent '#{str_request}'" if options[:debug]

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

@@ -25,7 +25,7 @@ module LoraRb
       str_app_token = "{\"appid\":\"#{options[:appid]}\", \"token\":\"#{options[:token]}\"}"
       puts "#{Time.now} To: #{str_app_token}" if options[:debug]
       @ssl_socket.puts str_app_token
-      str_request = "{\"cmd\":\"#{options[:cmd]}\",\"EUI\":\"#{options[:eui]}\",\"port\":#{options[:port]},\"confirmed\":#{options[:confirmed]},\"data\":\"#{options[:data]}\"} 	"
+      str_request = "{\"cmd\":\"#{options[:cmd]}\",\"EUI\":\"#{options[:eui]}\",\"port\":#{options[:port]},\"confirmed\":#{options[:confirmed]},\"data\":\"#{(@encoding ? lora_encode(options[:data]) : options[:data])}\"} 	"
       puts "#{Time.now} Cmq request: #{str_request}" if options[:debug]
       @ssl_socket.puts(str_request)
       begin

data/lib/lora-rb/utility.rb

@@ -3,7 +3,7 @@ module LoraRb
   # It contains generic methods
   module Base
 
-    # Show tips on usage
+    # Substitute tags with data into url
     def merge_tags_to_url(url, tags={}, options={})
       url = url.dup
       puts "merge_tags_to_url: #{url}" if options[:debug] == :full
@@ -14,6 +14,14 @@ module LoraRb
       puts "merge_tags_to_url: completed #{url}" if options[:debug] == :full
       url
     end
+
+    def lora_encode(payload)
+      Base64.encode64(payload.scan(/.{2}/).map { |b| b.to_i(16).chr }.join)
+    end
+
+    def lora_decode(payload)
+      Base64.decode64(payload).unpack("H*").first
+    end
   end
 
   private

data/lib/version.rb

@@ -1,8 +1,8 @@
 module LoraRb
   def self.version
-    "0.15.0"
+    "0.16.0"
   end
   def self.updated_at
-    "2017-11-01"
+    "2017-11-21"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lora-rb
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Marco Mastrodonato
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json