mqtt-sn-ruby 0.0.18 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 355869b8237db560d527d053840b5cf3e6004f67
-  data.tar.gz: 7eb4e42c4d935ad629fdaf53709953d5e87c8acd
+  metadata.gz: ccc99a508bb40d3261b690b13a97094bb257210b
+  data.tar.gz: 04af70b7e0a86a63044631c9e6daa41c273509c5
 SHA512:
-  metadata.gz: 6b04c285a66b26ce92e411df4f22c292c8de65b685f8ec2e11c904745fc8c6c3dfa72fbfe3be85f53e9e07330632df723da80e42555bd5814b83f7137ca67966
-  data.tar.gz: 86bbb6373d0790ed3e78e0123d8d4cfc0190093f2db248876650863cc5cdf39a5b9afddaaf7fba666fecb4f17b716a09291bf9debf7f63d31e8f3cabfd835111
+  metadata.gz: 6d1cc0c33d1becf9986eeffe185352436a4e8ebbb4b81c9ddaa0cab5a9433f92f661e890d570962bbbbf44a3f8f145bb81992078bbc38c96d06d53d2dd60e354
+  data.tar.gz: 5d385953fa575f7537634a5c15b3d1267abac839514191be53a00089b5f113a397ee62959e13f2f55bd30d1fba07bdf5e3859ca01ec57c0c59740e7725010566

data/bin/mqtt-sn-forwarder.rb

@@ -28,6 +28,10 @@ OptionParser.new do |opts|
   opts.on("-s", "--server uri", "URI of the MQTT-SN Server to connect to (udp://localhost:1883)") do |v|
     options[:server_uri] = v
   end
+  options[:broadcast_uri] = "udp://225.4.5.6:5000"
+  opts.on("-b", "--broadcast uri", "Multicast URI for ADVERTISE, SEARCHGW and GWINFO (udp://225.4.5.6:5000)") do |v|
+    options[:broadcast_uri] = v
+  end
   opts.on("-l", "--localport port", "MQTT-SN local port to listen (1882)") do |v|
     options[:local_port] = v.to_i
   end 

data/bin/mqtt-sn-pub.rb

@@ -41,31 +41,14 @@ OptionParser.new do |opts|
 end.parse!
 
 puts "MQTT-SN-PUB: #{options.to_json}"
+sn=MqttSN.new options
 begin
-  sn=MqttSN.new options
-  sent=false
-  if options[:qos]==-1
-    sn.publish options[:topic]||"XX", options[:msg]||"test_value", qos: options[:qos]
-    puts "Sent."
-  else
-    while not sent
-      sn.connect options[:id] do |s,m|
-        if s==:ok
-          sn.publish options[:topic]||"test/message/123", options[:msg]||"test_value", qos: options[:qos]
-          puts "Sent ok."
-          sent=true
-        else
-          sn.disconnect
-        end
-      end
-    end
-  end
-  sn.log_flush
+  sn.pub options
 rescue SystemExit, Interrupt
   puts "\nExiting after Disconnect\n"
 rescue => e
   puts "\nError: '#{e}' -- Quit after Disconnect\n"
-  pp e.backtrace
+  e.backtrace
 end
 sn.disconnect if sn
 

data/bin/mqtt-sn-sub.rb

@@ -16,28 +16,33 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: mqtt-sn-sub.rb [options]"
 
-  opts.on("-v", "--[no-]verbose", "Run verbosely (false)") do |v|
+  opts.on("-v", "--[no-]verbose", "Run verbosely; creates protocol log on console (false)") do |v|
     options[:verbose] = v
   end
-  opts.on("-d", "--[no-]debug", "Produce Debug dump on console (false)") do |v|
+  opts.on("-d", "--[no-]debug", "Produce Debug dump on verbose log (false)") do |v|
     options[:debug] = v
   end
-  opts.on("-s", "--server uri"," URI of the MQTT-SN Server to connect to. Example udp://localhost:1883. Default: Use Autodiscovery.") do |v|
+  opts.on("-s", "--server uri","URI of the MQTT-SN Server to connect to. Example udp://localhost:1883. Default: Use Autodiscovery.") do |v|
     options[:server_uri] = v
   end
-  opts.on("-q", "--qos level", "QoS level (0)") do |v|
+  options[:broadcast_uri] = "udp://225.4.5.6:5000"
+  opts.on("-b", "--[no-]broadcast uri", "Multicast URI for Autodiscovery: ADVERTISE, SEARCHGW and GWINFO (udp://225.4.5.6:5000)") do |v|
+    options[:broadcast_uri] = v
+  end
+  opts.on("-q", "--qos level", "QoS level -1,0,1 or 2. (0)") do |v|
     options[:qos] = v.to_i
   end
   opts.on("-i", "--id id", "This client's id -- free choice (hostname-pid)") do |name|
     options[:id] = name
   end
-  opts.on("-t", "--topic topic", "Topic to subscribe (test/message/123)") do |topic|
+  options[:topic] = "#"
+  opts.on("-t", "--topic topic", "Topic to Subscribe (#)") do |topic|
     options[:topic] = topic
   end
   opts.on("-h", "--http port", "Http port for debug/status JSON server (false)") do |v|
     options[:http_port] = v.to_i
   end
-  opts.on("-k", "--keepalive dur", "Keepalive timer, in seconds. Will ping with this interval. (25)") do |topic|
+  opts.on("-k", "--keepalive dur", "Keepalive timer, in seconds. Will ping Server with this interval. (25)") do |topic|
     options[:keepalive] = topic
   end
 end.parse!
@@ -77,24 +82,8 @@ end
 
 puts "MQTT-SN-SUB: #{options.to_json}"
 begin
-  loop do
-    puts "Connecting.."
-    $sn.connect options[:id] do |cs,cm|
-      puts "connect result: #{cs} #{cm}"
-      if cs==:ok 
-        puts "Subscribing.."
-        $sn.subscribe options[:topic]||"test/message/123", qos: options[:qos] do |s,m|
-          if s==:sub_ack
-            puts "Subscribed Ok! Waiting for Messages!"
-          elsif s==:disconnect
-            puts "Disconnected -- switch to new gateway"
-          else
-            puts "Got Message: #{s}: #{m}"
-          end
-        end
-      end
-    end
-    puts "Disconnected..."
+  $sn.sub options do |status,msg|
+    $sn.note "Got Message '#{msg[:msg]}' with Topic '#{msg[:topic]}'"
   end
 rescue SystemExit, Interrupt
   puts "\nExiting after Disconnect\n"

data/examples/recv.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'mqtt-sn-ruby'
+
+begin
+  sn=MqttSN.new server_uri: "udp://mqtt.fi:1882"
+  sn.sub  do |status,msg|
+    sn.note "Got Message '#{msg[:msg]}' with Topic '#{msg[:topic]}'"
+  end
+rescue SystemExit, Interrupt
+  puts "\nExiting after Disconnect\n"
+end
+sn.disconnect 
+puts "Exiting."

data/examples/send.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'mqtt-sn-ruby'
+
+sn=MqttSN.new server_uri: "udp://mqtt.fi:1882"
+sn.pub msg: "testing"
+sn.disconnect 

data/lib/mqtt-sn-ruby.rb

@@ -65,7 +65,8 @@ class MqttSN
   end
 
   def note str,*args
-    @log_q << sprintf(str,*args)
+    s=sprintf(str,*args)
+    @log_q << sprintf("%s: %s",Time.now.iso8601,s)
   end
 
   def log_empty?
@@ -139,7 +140,7 @@ class MqttSN
       @verbose=hash[:verbose]
       @state=:inited
       @bcast_port=5000
-      @keepalive=hash[:keepalive]||25
+      @keepalive=(hash[:keepalive]||25).to_i
       @forwarder=hash[:forwarder] #flag to indicate forward mode 
       @will_topic=nil
       @will_msg=nil
@@ -152,16 +153,18 @@ class MqttSN
       @clients={}
       @gateways={}
       @autodiscovery=false
-      @broadcast_uri="udp://225.4.5.6:5000"
+      @broadcast_uri=hash[:broadcast_uri]
 
       if @server_uri
-        puts "adding default gateway #{@server_uri}"
+        puts "Using Default Gateway: #{@server_uri}"
         @gateways[0]={stamp: Time.now.to_i,uri: @server_uri, duration: 0, source: 'default', status: :ok}
         pick_new_gateway 
-        pp @gateways
-      else
-        puts "Autodiscovery Active"
+      elsif @broadcast_uri
+        puts "Autodiscovery Active, using #{@broadcast_uri}"
         @autodiscovery=true
+      else
+        puts "No autodiscovery and no Default Gateway -- cannot proceed"
+        exit -1
       end
 
 
@@ -173,15 +176,17 @@ class MqttSN
       @iq = Queue.new
       @dataq = Queue.new
       
-      @bcast_s=open_multicast_send_port
-      @bcast=open_multicast_recv_port 
+      if @broadcast_uri
+        @bcast_s=open_multicast_send_port
+        @bcast=open_multicast_recv_port 
 
-      @roam_t=Thread.new do
-        roam_thread @bcast
+        @roam_t=Thread.new do
+          roam_thread @bcast
+        end
       end
       if @forwarder
         @s,@server,@port = MqttSN::open_port @server_uri
-        puts "Open port to Gateway: #{@server_uri}: #{@server},#{@port} -- local port: #{@local_port}"
+        puts "Open port to Gateway: #{@server_uri}: #{@server},#{@port} -- Listening local port: #{@local_port}"
         @local_port=hash[:local_port]||1883
         @s.bind("0.0.0.0",@local_port)
         @bcast_period=60
@@ -382,7 +387,6 @@ class MqttSN
       @msg_id+=1
 
     when :publish
-      puts "topic id: #{hash[:topic_id]}"
       raise "Need :topic_id to Publish!" if not hash[:topic_id]
       qos=hash[:qos]||0
       flags=0 
@@ -517,12 +521,12 @@ class MqttSN
     debug[:debug]=MqttSN::hexdump(msg) if @debug
 
     if not @active_gw_id or not @gateways[@active_gw_id] or not @gateways[@active_gw_id][:socket] 
-      print "No active gw, wait ."
+      note "No active gw, wait ."
       while not @active_gw_id or not @gateways[@active_gw_id] or not @gateways[@active_gw_id][:socket] 
         ret="-"
         if  not ret=pick_new_gateway
           sleep 0.5
-          print "."
+          #print "."
         end
         waits+=1
         if waits>30
@@ -530,7 +534,7 @@ class MqttSN
           return
         end
       end
-      puts " Ok!"  
+      note "Gw Ok!"  
     end  
 
     if @active_gw_id and @gateways[@active_gw_id] and @gateways[@active_gw_id][:socket] 
@@ -600,20 +604,16 @@ class MqttSN
     send :connect,id: id, clean: false, duration: @keepalive, expect: [:connect_ack,:will_topic_req] do |s,m| #add will here!
       if s==:ok
         if m[:type]==:will_topic_req
-          puts "will topic!"
           send :will_topic, topic: @will_topic, expect: [:will_msg_req] do |s,m| #add will here!
             if s==:ok
-              puts "will msg!"
               send :will_msg, msg: @will_msg, expect: [:connect_ack] do |s,m| 
               end
             end
           end
         elsif m[:type]==:connect_ack
-          puts "connected!---------------"
           block.call :ok,m if block
         end
       else
-        puts "failed to connect"
         block.call :fail,m if block
       end
     end
@@ -683,10 +683,7 @@ class MqttSN
   end
 
   def publish topic,msg,hash={}
-    puts "op='#{topic}','#{topic[0]}'"
-   
     if topic[0]=="="
-      puts "yeah"
       topic[0]=""
       topic_id=topic.to_i
       topic_type=:predefined
@@ -844,7 +841,6 @@ class MqttSN
       end
     when :publish
       if m[:topic_type]==:long
-        puts "on pitkä #{m[:topic_id]} ->#{@topics.key(m[:topic_id])}"
         m[:topic]=@topics.key(m[:topic_id])
       end
       if not @transfer
@@ -955,7 +951,7 @@ class MqttSN
     @gsem.synchronize do #one command at a time -- 
     
       if @active_gw_id # if using one, mark it used, so it will be last reused
-        note "closing gw #{@active_gw_id} cause: #{cause}"
+        note "Closing gw #{@active_gw_id} cause: #{cause}"
         @gateways[@active_gw_id][:last_use]=Time.now.to_i
         if @gateways[@active_gw_id][:socket]
           @gateways[@active_gw_id][:socket].close
@@ -982,7 +978,7 @@ class MqttSN
         end
         if pick
           @active_gw_id=pick
-          note "using gateway #{@active_gw_id} #{@gateways[@active_gw_id][:uri]}"
+          note "Opening Gateway #{@active_gw_id}: #{@gateways[@active_gw_id][:uri]}"
           @s,@server,@port = MqttSN::open_port @gateways[@active_gw_id][:uri]
           @gateways[@active_gw_id][:socket]=@s
           @gateways[@active_gw_id][:last_use]=Time.now.to_i
@@ -1050,5 +1046,54 @@ class MqttSN
   end
 
 
+#toplevel funcs:
+  def pub options={}
+    pp options
+    sent=false
+    if options[:qos]==-1
+      publish options[:topic]||"XX", options[:msg]||"test_value", qos: options[:qos]
+      puts "Sent."
+    else
+      while not sent
+        connect options[:id] do |s,m|
+          if s==:ok
+            publish options[:topic]||"test/message/123", options[:msg]||"test_value", qos: options[:qos]
+            puts "Sent ok."
+            sent=true
+          else
+            disconnect
+          end
+        end
+      end
+    end
+    log_flush 
+  end
+
+  def sub options={},&block
+    loop do
+      note "Connecting.."
+      connect options[:id] do |cs,cm|
+        note "connect result: #{cs} #{cm}"
+        if cs==:ok 
+          note "Subscribing.."
+          subscribe options[:topic]||"test/message/123", qos: options[:qos] do |s,m|
+            if s==:sub_ack
+              note "Subscribed Ok! Waiting for Messages!"
+            elsif s==:disconnect
+              note "Disconnected -- switch to new gateway"
+            else
+             if block
+                block.call s,m
+              else
+                note "Got Message: #{s}: #{m}"
+              end
+            end
+          end
+        end
+      end
+      puts "Disconnected..."
+    end
+end
+
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqtt-sn-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.1.0
 platform: ruby
 authors:
 - Ari Siitonen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-22 00:00:00.000000000 Z
 dependencies: []
 description: Ruby toolkit for MQTT-SN, compatible with RSMB, command line tools and
   API
@@ -23,8 +23,9 @@ files:
 - bin/mqtt-sn-forwarder.rb
 - bin/mqtt-sn-pub.rb
 - bin/mqtt-sn-sub.rb
+- examples/recv.rb
+- examples/send.rb
 - lib/mqtt-sn-ruby.rb
-- test.rb
 homepage: https://github.com/arisi/mqtt-sn-ruby
 licenses:
 - MIT

data/test.rb

@@ -1,68 +0,0 @@
-#!/usr/bin/env ruby
-# encode: UTF-8
-
-require "pp"
-require 'socket'
-require 'json'
-
-if File.file? './lib/mqtt-sn-ruby.rb'
-  require './lib/mqtt-sn-ruby.rb'
-  puts "using local lib"
-else
-  require 'mqtt-sn-ruby'
-  puts "using gem lib"
-end
-
-puts "Testing mqtt-sn.."
-
-sn=MqttSN.new debug: true
-sn2=MqttSN.new debug: false
-sn3=MqttSN.new debug: true
-
-
-sn.will_and_testament "top","testamentti"
-sn.connect "eka"
-
-sn2.connect "toka"
-
-sn3.connect "kolmas"
-
-Thread.new do
-  sn3.subscribe "eka/2",qos:2 do |s,m|
-    puts ">>>>>>>>>>>> subscribe got: #{s},#{m}"
-  end
-end
-sn3.unsubscribe "eka/2"
-
-topic_id=0
-sn.will_and_testament "top2","testamentti2"
-
-sn2.ping
-sn3.subscribe "eka/3",qos:2 
-#sn.register_topic "jeesus/perkele/toimii"
-sn.publish "eka/1","perkkule0",qos: 0
-sn.publish "eka/2","perkkule1",qos: 1
-sn.publish "eka/3","perkkule2",qos: 2
-
-
-sn2.publish "eka/4","2perkkule0",qos: 0
-sn2.publish "eka/5","2perkkule1rrrr",qos: 1, retain: true
-sn2.publish "eka/6","2perkkule2",qos: 2
-sn2.disconnect
-sn2=nil
-
-#puts "----------------- sleep"
-#sn2.goto_sleep 4
-
-5.times do
-  sn.ping
-  sleep 0.5
-end
-
-
-sn.disconnect
-sn3.disconnect
-
-
-puts "Done testing mqtt-sn!"
-