fldigi 0.0.11 → 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01ed9311a2dcab94b12c12beec7d3aacdb07621c
+  data.tar.gz: a099959442ab9775b6631cf26f39d1bc16ef9042
+SHA512:
+  metadata.gz: e00f032b5347b1425347ff6ef02668efc4f1cd8f8300390a7ad014e7c70dbc53a26b37ba99dbc6fb7b6f478c39c2c60039d7852dfc4bbb62ef32a15cd0581dba
+  data.tar.gz: 4fcc64a79d71b3739a0d6ba26e8ccc8be56315762b15a6643c72d1d327f29a78f496ec8b0da0153a4c6a02b92edbf2fc8d77522d4a72ae74998360e6054deb09

data/lib/fldigi.rb

@@ -13,11 +13,16 @@
 #
 # http://www.w1hkj.com/FldigiHelp-3.22/xmlrpc-control.html
 #
-# More documentation is forthcoming, but for the moment, refer to the
-# clients published along with this library to see how to use it.
-
+# More documentation for this code is forthcoming, but for the moment,
+# refer to the clients published on my web page to see how to use it.
+#
 # Version History:
 #
+# 0.0.12 - 06/05/2014 - jfrancis - Allows for additional data to be
+# appended to the output queue during transmit.  Also now defaults to
+# not displaying a running output of transmitted data (though it can
+# be switched back on with a 'true' flag to send_buffer()).
+#
 # 0.0.11 - 05/29/2014 - jfrancis - Added optional offset.
 #
 # 0.0.10 - 05/26/2014 - jfrancis - Forgot the 'require'.
@@ -33,17 +38,19 @@
 # 0.0.6 - 05/25/2014 - jfrancis - First public release on
 # rubygems.org.
 
-require "xmlrpc/client"
+require 'xmlrpc/client'
+require 'thread'
 
 class Fldigi
-  attr_accessor :rigctl, :freq, :carrier, :call, :modem, :afc, :rsid, :sideband, :squelch, :slevel, :spot, :delay, :grid, :phg, :band, :offset
+  attr_accessor :rigctl, :freq, :carrier, :call, :modem, :afc, :rsid, :sideband, :squelch, :slevel, :spot, :delay, :grid, :phg, :band, :offset, :start_wait, :char_wait
 
   # Do the initial setup.  All arguments are optional, default is
   # rigctl, localhost, standard port.  If you have no rig control,
-  # call with "Fldigi.new(false)".  If you want to remote control an
-  # FLDigi instance that's not on the local machine and/or has a
-  # non-standard port number, you'll have to supply all three options,
-  # like "Fldigi.new(true,10.1.2.3,7362)".
+  # call with Fldigi.new(false) (ie, it assumes you do have rig
+  # control).  If you want to remote control an FLDigi instance that's
+  # not on the local machine and/or has a non-standard port number,
+  # you'll have to supply all three options, like
+  # Fldigi.new(true,10.1.2.3,7362).
   def initialize(rigctl=true, host="127.0.0.1", port=7362)
     # Housekeeping.
     @host=host
@@ -74,6 +81,8 @@ class Fldigi
     @spot_old=nil
     @offset=0
     @offset_old=0
+    @start_wait=10
+    @char_wait=2
 
     # Propnet stuff.
     @band=nil
@@ -85,6 +94,7 @@ class Fldigi
 
     # Connect to the FLDigi instance.
     @srvr=XMLRPC::Client.new(host,"/RPC2",port)
+    @m=Mutex.new
   end
 
   # Send a command to FLDigi.
@@ -250,7 +260,7 @@ class Fldigi
   
   # Set FLDigi to transmit (immediate).  When switched to transmit,
   # FLDigi will send whatever text exists in FLDigi's transmit buffer
-  # (which is *not* the same thing as the object's internal message
+  # (which is *not* the same thing as this object's internal message
   # queue called @message).
   def transmit
     if self.sendcmd("main.get_trx_status")=="tx"
@@ -267,48 +277,66 @@ class Fldigi
   
   # Send the currently buffered data using the carrier, mode,
   # frequency, etc. currently configured.  The current code will wait
-  # up to ten 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 two seconds (which again, is just enough for the
-  # very slowest modem).  You can set the two second value lower if
-  # you're only going to use fast modems, but if you forget and use a
-  # slow modem with this set lower, you'll chop off your own
-  # transmissions.  This value also affects how long of an idle is
-  # left after the last character.  Everything's a trade-off...
-  def send_buffer
+  # up to @start_wait (10) 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
+  # (which again, is just enough for the very slowest modem).  You can
+  # set the @char_wait value lower if you're only going to use fast
+  # modems, but if you forget and use a slow modem with this set
+  # lower, you'll chop off your own transmissions before completion.
+  # This value also affects how long of an idle is left after the last
+  # character before switching back to receive.  Everything's a
+  # trade-off...  If you keep adding data to the buffer (ie, calling
+  # add_tx_string()) while transmitting, it'll keep sending data until
+  # the buffer is empty.  If you set verbose to true, send_buffer()
+  # will display a running stream of transmitted data to STDOUT.
+  def send_buffer(verbose=false)
     if @message.length > 0
-      self.sendcmd("text.add_tx",@message)
       self.transmit()
-      waited=0
-      max=10
-      
-      result="xxx"
       show=""
-      while waited<max
-        waited=waited+1
-        result=self.get_tx_data()
-        if result.length > 0
-          max=2
-          waited=0
-          show=show+result
-          puts show
+      while @message.length > 0
+        @m.synchronize do
+          self.sendcmd("text.add_tx",@message)
+          @message=""
+        end
+        waited=0
+        max=@start_wait
+        
+        result=""
+        while waited<max
+          waited=waited+1
+          result=self.get_tx_data()
+          if result.length > 0
+            max=@char_wait
+            waited=0
+            show=show+result
+            if verbose
+              puts show
+            end
+          end
+          sleep 1
         end
-        sleep 1
       end
-
-      self.receive()
-      return show
     end
+    self.receive()
+    return show
   end
 
   # Add a string of text to the outgoing buffer.  If you want carriage
   # returns, you must supply them as part of the text (ie, "foo\n").
   def add_tx_string(text)
-    @message=@message+text
+    @m.synchronize do
+      @message=@message+text
+    end
     return @message
   end
 
+  # Return the modem signal quality in the range [0:100]
+  def quality
+    return self.sendcmd("modem.get_quality")
+  end
+
   # Return the received data accumulated since the last time you asked.
   def get_rx_data
     return self.sendcmd("rx.get_data")
@@ -335,7 +363,9 @@ class Fldigi
   # object's message queue, but does not change what may or may not be
   # queued in FLDigi for transmission (clear_tx_data() does that).
   def clear_message
-    @message=""
+    @m.synchronize do
+      @message=""
+    end
   end
 
   # Return a list of valid modems supported by FLDigi.  Note that not

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fldigi
 version: !ruby/object:Gem::Version
-  version: 0.0.11
-  prerelease: 
+  version: 0.0.12
 platform: ruby
 authors:
 - Jeff Francis, N0GQ
@@ -21,26 +20,25 @@ files:
 homepage: http://fldigi.gritch.org/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A library for talking to FLDigi.
 test_files: []