fldigi 0.1.4 → 0.1.6

data/lib/fldigi.rb

@@ -20,11 +20,36 @@
 #
 # XMLRPC::Config::ENABLE_NIL_PARSER=true
 
+require 'time'
 require 'xmlrpc/client'
 require 'thread'
 
+# Turn 1/0 into false/true (some XMLRPC libraries seem to return 1/0,
+# others true/false).  This cleans up the code a bit.
+def torf(n)
+  if n==0 or n==false
+    return false
+  else
+    return true
+  end
+end
+
+# Hold the error message generated (along with a timestamp).
+class Error
+  attr_accessor :timestamp, :text
+
+  def initialize(text)
+    @timestamp=Time.now()
+    @text=text
+  end
+
+  def to_s
+    "#{@timestamp.to_s}:  #{@text}"
+  end
+end
+
 class Fldigi
-  attr_accessor :rigctl, :dial_freq, :carrier, :call, :modem, :afc, :rsid, :sideband, :squelch, :slevel, :spot, :delay, :grid, :phg, :band, :offset, :start_wait, :char_wait, :debug
+  attr_accessor :rigctl, :dial_freq, :carrier, :call, :modem, :afc, :rsid, :sideband, :squelch, :slevel, :spot, :delay, :grid, :phg, :band, :offset, :start_wait, :char_wait, :debug, :errors
 
   # Do the initial setup.  All arguments are optional, default is
   # rigctl, localhost, standard port.  If you have no rig control,
@@ -39,6 +64,7 @@ class Fldigi
     @port=port
     @message=""
     @rigctl=rigctl
+    @errors=Array.new
 
     # Set up the defaults.
     @dial_freq=14070000.0
@@ -79,6 +105,11 @@ class Fldigi
     @m=Mutex.new
   end
 
+  # Add an error message to the queue.
+  def error(text)
+    @errors.push(Error.new(text))
+  end
+
   # Send an XML-RPC command to FLDigi.
   def sendcmd(cmd, param=-1)
     if param==-1
@@ -139,7 +170,8 @@ class Fldigi
         if @modem==self.sendcmd("modem.get_name")
           @modem_old=@modem
         else
-          puts "modem.set_name failed <-----------------------" if @debug
+          self.error("modem.set_name failed with value #{@modem}")
+          puts "modem.set_name failed" if @debug
           status=false
         end
       end
@@ -147,38 +179,42 @@ class Fldigi
     
     # Turn spot on/off (true/false).
     if @spot!=@spot_old
-      ret=self.sendcmd("spot.get_auto")
-      if (ret==1 and @spot==true) or (ret==0 and @spot==false) or (ret==@spot)
+      if torf(self.sendcmd("spot.get_auto"))==@spot
         @spot_old=@spot
       else
         self.sendcmd("spot.set_auto", @spot)
-        ret=self.sendcmd("spot.get_auto")
-      if (ret==1 and @spot==true) or (ret==0 and @spot==false) or (ret==@spot)
+      if torf(self.sendcmd("spot.get_auto"))==@spot
           @spot_old=@spot
         else
-          puts "spot.set_auto failed <-----------------------" if @debug
+          self.error("spot.set_auto failed with value #{@spot}")
+          puts "spot.set_auto failed" if @debug
           status=false
         end
       end
     end
 
-    # Turn AFC on/off (true/false).
-    if @afc!=@afc_old
-      ret=self.sendcmd("main.get_afc")
-      if (ret==1 and @afc==true) or (ret==0 and @afc==false) or (ret==@afc)
+    # Turn AFC on/off (true/false). Some modes don't work with
+    # AFC. There seems to be a great deal of inconsistency (a bug,
+    # maybe?) in reading the AFC value back from FLDigi. Every test I
+    # can come up with points to a bug in their code, not mine. Until
+    # we can get this sorted out, don't consider failure to set AFC as
+    # fatal. Just unset it, and continue on. ToDo: Verify bug in
+    # FLDigi, then fix.
+    if (@afc!=@afc_old)
+      if torf(self.sendcmd("main.get_afc"))==@afc
         @afc_old=@afc
       else
         self.sendcmd("main.set_afc", @afc)
-        ret=self.sendcmd("main.get_afc")
-      if (ret==1 and @afc==true) or (ret==0 and @afc==false) or (ret==@afc)
+        sleep 0.25
+        if torf(self.sendcmd("main.get_afc"))==@afc
           @afc_old=@afc
         else
-          puts "main.set_afc failed <-----------------------" if @debug
-          status=false
+          @afc=false
+          puts "main.set_afc failed, so leaving turned off" if @debug
         end
       end
     end
-    
+
     # Set the sideband ("USB"/"LSB").  ToDo: make sure this is
     # correct.
     if @sideband!=@sideband_old
@@ -189,7 +225,8 @@ class Fldigi
         if @sideband==self.sendcmd("main.get_sideband")
           @sideband_old=@sideband
         else
-          puts "main.set_sideband failed <-----------------------" if @debug
+          self.error("main.set_sideband failed with value #{@sideband}")
+          puts "main.set_sideband failed" if @debug
           status=false
         end
       end
@@ -197,16 +234,15 @@ class Fldigi
 
     # Turn RSID receive on/off (true/false).
     if @rsid!=@rsid_old
-      ret=self.sendcmd("main.get_rsid")
-      if (ret==1 and @rsid==true) or (ret==0 and @rsid==false) or (ret==@rsid)
+      if torf(self.sendcmd("main.get_rsid"))==@rsid
         @rsid_old=@rsid
       else
         self.sendcmd("main.set_rsid", @rsid)
-        ret=self.sendcmd("main.get_rsid")
-      if (ret==1 and @rsid==true) or (ret==0 and @rsid==false) or (ret==@rsid)
+        if torf(self.sendcmd("main.get_rsid"))==@rsid
           @rsid_old=@rsid
         else
-          puts "main.set_rsid failed <-----------------------" if @debug
+          self.error("main.set_rsid failed with value #{@rsid}")
+          puts "main.set_rsid failed" if @debug
           status=false
         end
       end
@@ -214,16 +250,15 @@ class Fldigi
     
     # Turn squelch on/off (true/false).
     if @squelch!=@squelch_old
-      ret=self.sendcmd("main.get_squelch")
-      if (ret==1 and @squelch==true) or (ret==0 and @squelch==false) or (ret==@squelch)
+      if torf(self.sendcmd("main.get_squelch"))==@squelch
         @squelch_old=@squelch
       else
         self.sendcmd("main.set_squelch", @squelch)
-        ret=self.sendcmd("main.get_squelch")
-      if (ret==1 and @squelch==true) or (ret==0 and @squelch==false) or (ret==@squelch)
+        if torf(self.sendcmd("main.get_squelch"))==@squelch
           @squelch_old=@squelch
         else
-          puts "main.set_squelch failed <-----------------------" if @debug
+          self.error("main.set_squelch failed with value #{@squelch}")
+          puts "main.set_squelch failed" if @debug
           status=false
         end
       end
@@ -239,7 +274,8 @@ class Fldigi
         if @slevel==self.sendcmd("main.get_squelch_level")
           @slevel=@slevel.to_f
         else
-          puts "main.set_squelch_level failed <-----------------------" if @debug
+          self.error("main.set_squelch_level failed with value #{@slevel}")
+          puts "main.set_squelch_level failed" if @debug
           status=false
         end
       end
@@ -271,7 +307,9 @@ class Fldigi
     # "1000" on the other radio, as well.  There's no good, clean,
     # all-purpose solution to this one, but at least it allows for
     # consistent and automated use of the library without having to do
-    # the conversions in your own code.
+    # the conversions in your own code. We give ourselves two tries to
+    # get the freq right, since some rigs seem to act a bit odd when
+    # changing bands.
     @dial_freq=@dial_freq.to_i
     if (@dial_freq!=@dial_freq_old or @offset!=@offset_old) and @rigctl
       @dial_freq_old=@dial_freq
@@ -280,8 +318,13 @@ class Fldigi
         self.sendcmd("main.set_frequency", @dial_freq+@offset.to_f)
         sleep 0.5
         if @dial_freq+@offset.to_i!=self.sendcmd("main.get_frequency").to_f
-          puts "main.set_frequency failed <-----------------------" if @debug
-          status=false
+          self.sendcmd("main.set_frequency", @dial_freq+@offset.to_f)
+          sleep 0.5
+          if @dial_freq+@offset.to_i!=self.sendcmd("main.get_frequency").to_f
+            self.error("main.set_frequency failed with value #{@dial_freq}")
+            puts "main.set_frequency failed" if @debug
+            status=false
+          end
         end
       end
     end
@@ -316,6 +359,7 @@ class Fldigi
     if self.sendcmd("main.get_trx_status")=="tx"
       return true
     else
+      self.error("main.tx failed")
       return false
     end
   end
@@ -355,7 +399,7 @@ class Fldigi
 
   # Send the currently buffered data using the carrier, mode,
   # frequency, etc. currently configured.  The current code will wait
-  # up to @start_wait (10) seconds for the first character to be
+  # up to @start_wait seconds for the first character to be
   # transmitted (this gives time for really slow modems to get
   # rolling).  Once the first sent character is detected, it makes
   # sure it sees as least one character every @char_wait (2) seconds
@@ -372,6 +416,8 @@ class Fldigi
   def send_buffer(verbose=false)
     if @message.length > 0
       self.transmit()
+      send_length=@message.length
+      send_start=Time.now()
       show=""
       while @message.length > 0
         @m.synchronize do
@@ -380,7 +426,7 @@ class Fldigi
         end
         waited=0
         max=@start_wait
-        
+
         result=""
         while waited<max
           waited=waited+1
@@ -398,6 +444,8 @@ class Fldigi
       end
     end
     self.receive()
+    send_end=Time.now()
+    puts "#{send_length} characters sent in #{(send_end-send_start).to_i} seconds, #{((((send_length/(send_end.to_f-send_start.to_f))*10)+0.5).to_i)/10.to_f} chars/sec." if @debug
     return show
   end
 
@@ -527,6 +575,7 @@ class Fldigi
         @dial_freq=50291000
         @fsym="vb"
       else
+        self.error("Invalid propnet band: #{band}")
         return false
       end
 
@@ -558,6 +607,7 @@ class Fldigi
       self.add_tx_string("CQ CQ CQ de #{@call} #{@call} #{@call} pse k")
       return true
     else
+      self.error("Unable to queue CQ string.")
       return false
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fldigi
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies: []
 description: A library for talking to FLDigi.
 email: jeff@gritch.org