prologix_gpib 0.4.4 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ce983416d3fa34a8a34428381d564403c2f48664e153172066bebe1fe619f24
-  data.tar.gz: 57abf8c3a078fb360684782852b9dfda21815519552ea3cba0ae90babc50bb6c
+  metadata.gz: 7ac431f2d4186660651615941aa70b69de9d49de98d8101861e66daf9cc90cd9
+  data.tar.gz: c77f6db86bf82377345283cfc41e62b4cfe9f4d37f5ba5375021a4711f696369
 SHA512:
-  metadata.gz: dce9ffeab0971eade1b9e2b7d889b082e91580ccabaecd7ad39ae83bc502d2c3973e3ce3e7509832e7a207eb8d1a5f10aaf2a44a5a31e805a21198b07b045925
-  data.tar.gz: a3b93b86db7d811de048a3cb38d56cf4a7c6a2e07ff51ef2975a9ceb978511275f3568a51d8b63e104ff4ace5bd8e64b26428fa95a2e52ea0587a269b7edd01d
+  metadata.gz: be989bbe8e07016b4f42b0b865474338fce70eaed5e828dae502d91db0d637903274bb9c734ac81e2249b87ad4a2c06025fcfab0c1a82f835763cbed993ae2fb
+  data.tar.gz: 66ed6d4a45a9ee22feb6470b73771f4e02c1ee38e0de666ff9c8b6e8cb01b242c9be1b20501761100332ba2a50a2a7e4e7144792c671831a4f87446506af50c0

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.0
+ruby 3.1.2

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.5.3
+
+- Moved repo to Gitlab
+
+# 0.5.2 (June 23, 2022)
+
+## Bug Fixes:
+
+- Fix CLI info command, uses list index and now works with Lan controllers
+- Refactored commands

data/Gemfile.lock

@@ -1,27 +1,29 @@
 PATH
   remote: .
   specs:
-    prologix_gpib (0.4.3)
-      activesupport
-      rubyserial
+    prologix_gpib (0.5.0)
+      activesupport (~> 7.0.1)
+      bindata (~> 2.4.10)
+      rubyserial (~> 0.6.0)
       terminal-table (~> 3.0.2)
-      thor
+      thor (~> 1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    bindata (2.4.10)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     ffi (1.15.5)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -43,7 +45,6 @@ DEPENDENCIES
   prologix_gpib!
   pry
   rake (~> 10.0)
-  rubyserial (~> 0.6)
 
 BUNDLED WITH
-   2.2.32
+   2.3.16

data/NetFinder_info.md

@@ -0,0 +1,30 @@
+# Net Finder
+
+NetFinder, uses UDP broadcast to locate and configure GPIB-ETH controllers on a network.
+You can find an implementation of the protocol in the nfcli utility
+http://prologix.biz/downloads/nfcli.tar.gz
+
+### Discovery
+
+- Create NF_IDENTIFY packet.
+- Set sequence to a random value
+- Set eth_addr to all ones
+- Broadcast NF_IDENTIFY datagram to port 3040/UDP.
+- Listen for NF_IDENTIFY_REPLY datagrams.
+- Verify sequence matches NF_IDENTIFY packet
+
+### Configuration
+
+- Create NF_ASSIGNMENT packet
+- Set sequence to a random value
+- Set eth_addr to MAC address of desired device Set ip_type to NF_IP_DYNAMIC or NF_IP_STATIC If ip_type is NF_IP_DYNAMIC specify ip, mask and gateway addresses.
+- Broadcast NF\* ASSIGNMENT datagram to port 3040/UDP.
+- Listen for NF_ASSIGNMENT_REPLY datagrams.
+- Verify sequence matches that of NF_ASSIGNMENT packet Check result field for NF_SUCCESS
+
+Notes:
+
+1. You may get multiple replies. Discard duplicate replies.
+2. All multi-byte values are in network order (big-endian)
+3. On multi-homed hosts, make sure broadcasts go out over all interfaces.
+4. NetFinder protocol only works within the same subnet as routers will not forward UDP broadcast packets.

data/README.md

@@ -24,18 +24,20 @@ Or install it yourself as:
 
 ### CLI
 
-The gem comes with a simple cli for querying controllers:
+The gem comes with a simple cli for finding controllers:
 
 ```bash
 $ plx list
-+-------------------------------------------------------------------------------+
-|                             Prologix Controllers                              |
-+-------+-------------------------------+---------+-----------------------------+
-| index | Controller                    | Version | Path                        |
-+-------+-------------------------------+---------+-----------------------------+
-| 0     | Prologix GPIB-USB Controller  |  6.101  | /dev/tty.usbserial-PX9HPBMB |
-| 1     | Prologix GPIB-USB Controller  |  6.107  | /dev/tty.usbserial-PXEGWA9A |
-+-------+-------------------------------+---------+-----------------------------+
++-----------------------------------------------------------------------------------------+
+|                                   Prologix Controllers                                  |
++-------+------------------------------------+--------------+-----------------------------+
+| index | Controller                         | Version      | Location                    |
++-------+------------------------------------+--------------+-----------------------------+
+| 0     | Prologix GPIB-USB Controller       |  6.101       | /dev/tty.usbserial-PX9HPBMB |
+| 1     | Prologix GPIB-USB Controller       |  6.107       | /dev/tty.usbserial-PXEGWA9A |
+| 2     | Prologix GPIB-LAN Controller       |  01.03.00.00 | 192.168.10.161              |
+| 3     | Prologix GPIB-ETHERNET Controller  |  01.06.06.00 | 192.168.10.127              |
++-------+------------------------------------+--------------+-----------------------------+
 
 $ plx info 0
 
@@ -50,24 +52,52 @@ $ plx info 0
 	EOS: Append CR+LF
 	EOT: Enabled
 
+plx info 3
+
+  Prologix gpib-ethernet controller
+	Path: 192.168.10.127
+	Firmware: 01.06.06.00
+	Mode: Controller
+	Device Address: 5
+	Auto Read: Enabled
+	Read Timeout: 500
+	Eoi Assertion: Enabled
+	Eos: Append CR+LF
+	Eot: Disabled
 ```
 
-### Playing in Console
+### Finding Controllers
 
-I'm enamoured by this interface, I'd like a more ruby like way of finding and connecting controllers, that works with Ethernet controllers too.
+```irb
+irb(main):001:0> f = PrologixGpib::Finder.new
+=> #<PrologixGpib::Finder:0x00000001089844b0>
+irb(main):002:0> controllers = f.avaliable_controllers
+=> {
+	:usb=>["/dev/tty.usbserial-PX9HPBMB", "/dev/tty.usbserial-PXEGWA9A"],
+	:lan=>["192.168.10.161", "192.168.10.165"]
+}
 
-```ruby
-irb(main):001:0> require 'prologix_gpib'
-=> true
+```
+
+### Working with Controllers
 
-irb(main):002:0> paths = PrologixGpib.usb_paths
-=> ["/dev/tty.usbserial-PX9HPBMB", "/dev/tty.usbserial-PXEGWA9A"]
+I'm not enamoured by this interface, I'd like a more ruby like way of finding and connecting controllers thats less clunky. It works for now, but may change as we refine things.
 
-irb(main):003:0> device = PrologixGpib::UsbController.new(paths[0])
+```ruby
+irb(main):003:0> device = PrologixGpib::UsbController.new(controllers[:usb][0])
 => #<PrologixGpib::UsbController:0x00000001574c4098 @serial_port=#<Serial:0x00000001574bfef8 @config=#<RubySerial::Posix::Termios:0x00000001574bf728>, @fd=9, @open=true>>
 
 irb(main):004:0> device.config
-=>  {:device_name=>"Prologix GPIB-USB Controller", :firmware=>"6.101", :mode=>"Device", :device_address=>"9", :auto_read=>"NA", :read_timeout=>"NA", :eoi_assertion=>"Enabled", :eos=>"Append CR+LF", :eot=>"Enabled"}
+=>  {
+	:device_name=>"Prologix GPIB-USB Controller",
+	:firmware=>"6.101", :mode=>"Device",
+	:device_address=>"9",
+	:auto_read=>"NA",
+	:read_timeout=>"NA",
+	:eoi_assertion=>"Enabled",
+	:eos=>"Append CR+LF",
+	:eot=>"Enabled"
+}
 
 irb(main):005:0> device.address
 => "9"
@@ -79,7 +109,16 @@ irb(main):007:0> device.mode
 => "0"
 
 irb(main):008:0> device.config
-=> {:device_name=>"Prologix GPIB-USB Controller", :firmware=>"6.101", :mode=>"Controller", :device_address=>"9", :auto_read=>"Disabled", :read_timeout=>"200", :eoi_assertion=>"Enabled", :eos=>"Append CR+LF", :eot=>"Enabled"}
+=> {
+	:device_name=>"Prologix GPIB-USB Controller",
+	:firmware=>"6.101", :mode=>"Controller",
+	:device_address=>"9",
+	:auto_read=>"Disabled",
+	:read_timeout=>"200",
+	:eoi_assertion=>"Enabled",
+	:eos=>"Append CR+LF",
+	:eot=>"Enabled"
+}
 ```
 
 ### Firmware update

data/lan_test.rb

@@ -0,0 +1,17 @@
+require 'prologix_gpib'
+require 'socket'
+
+class Scanner
+  def search(range, timeout = 0.1)
+    array = []
+    range.each do |x|
+      s = Socket.tcp("192.168.10.#{x}", 1234, connect_timeout: timeout)
+      s.write("++ver\r\n")
+      array << s.gets
+    rescue => error
+      puts error.inspect
+      next
+    end
+    array
+  end
+end

data/lib/prologix_gpib/cli.rb

@@ -2,52 +2,78 @@ require 'thor'
 require 'pp'
 require 'prologix_gpib'
 require 'terminal-table'
+require 'resolv'
 
 module PrologixGpib
   class CLI < Thor
+    def initialize(*args)
+      super
+      @controllers = PrologixGpib::Finder.new.avaliable_controllers
+    end
+
     desc 'list', 'List all connected controllers'
 
     def list
-      if controllers_connected?
-        table =
-          Terminal::Table.new do |t|
-            t.title = 'Prologix Controllers'
-            t.headings = %w[index Controller Version Path]
-            PrologixGpib.usb_paths.each.with_index do |path, index|
-              device = PrologixGpib::UsbController.new(path)
-              str = device.version.split('version')
-              t.add_row [index.to_s, str[0], str[1], path]
-            end
-          end
-        puts table
-      else
-        puts 'No Prologix Controllers available.'
-      end
+      puts controller_table(@controllers)
     end
 
-    desc 'info', 'Display Controller information'
-    option :path, alias: :p
-    def info
+    desc 'info [INDEX]', 'Display Controller information'
+    option :path, aliases: :p
+    def info(index)
       return unless controllers_connected?
 
-      paths = options[:path].nil? ? PrologixGpib.usb_paths : [options[:path]]
+      controller_paths = @controllers.map { |k, v| v }.flatten
 
-      paths.each do |path|
-        hash = PrologixGpib::UsbController.new(path).config
-        puts "\n  #{titleise hash.delete(:device_name)}"
-        puts "\tPath: #{path}"
-        hash.each { |k, v| puts "\t#{titleise(k)}: #{v}" }
-      end
+      path = controller_paths[index.to_i]
+      hash = ip_address?(path) ? PrologixGpib::LanController.new(path).config : PrologixGpib::UsbController.new(path).config
+
+      puts "\n  #{titleise hash.delete(:device_name)}"
+      puts "\tPath: #{path}"
+      hash.each { |k, v| puts "\t#{titleise(k)}: #{v}" }
     end
 
     private
 
+    def controller_table(controllers)
+      return 'No Prologix Controllers available.' unless controllers.length > 0
+
+      table =
+        Terminal::Table.new do |t|
+          t.title = 'Prologix Controllers'
+          t.headings = %w[index Controller Version Location]
+        end
+
+      index = 0
+      if controllers.key? :usb
+        controllers[:usb].each do |path|
+          device = PrologixGpib::UsbController.new(path)
+          str = device.version.split('version')
+          table.add_row [index.to_s, str[0], str[1], path]
+          index += 1
+        end
+      end
+
+      if controllers.key? :lan
+        controllers[:lan].each do |ip|
+          device = PrologixGpib::LanController.new(ip)
+          str = device.version.split('version')
+          table.add_row [index.to_s, str[0], str[1], ip]
+          index += 1
+        end
+      end
+      table
+    end
+
     def controllers_connected?
-      PrologixGpib.usb_paths.count >= 1
+      @controllers[:usb].any? || @controllers[:lan].any?
     end
 
     def titleise(string)
       string.to_s.split('_').map(&:capitalize).join(' ')
     end
+
+    def ip_address?(string)
+      string =~ Resolv::IPv4::Regex ? true : false
+    end
   end
 end

data/lib/prologix_gpib/{usb/commands.rb → commands.rb}

@@ -1,4 +1,4 @@
-module PrologixGpib::Usb::Commands
+module PrologixGpib::Commands
   def config
     error_message = 'Error'
     device_version = version.split('version').map(&:strip)
@@ -40,7 +40,7 @@ module PrologixGpib::Usb::Commands
     conf
   end
 
-  #  This command configures the Prologix GPIB-USB controller to be a :controller or :device.
+  #   #  This command configures the Prologix GPIB-USB controller to be a :controller or :device.
   def mode=(op_mode)
     mode =
       case op_mode
@@ -60,8 +60,8 @@ module PrologixGpib::Usb::Commands
   end
   alias operation_mode mode
 
-  # Timeout value, in milliseconds, used in the read command and spoll command.
-  # Any value between 1 and 3000 milliseconds.
+  # # Timeout value, in milliseconds, used in the read command and spoll command.
+  # # Any value between 1 and 3000 milliseconds.
   def timeout=(milliseconds)
     return unless connected? || milliseconds.class != Integer
 
@@ -72,8 +72,8 @@ module PrologixGpib::Usb::Commands
     device_query('++read_tmo_ms')
   end
 
-  # PrologixGPIB-USB controller can be configured to automatically address instruments to 'talk' after sending a command in order to read the response.
-  # *** Avaliable in Controller mode. When enabled can cause the prologix controller to lockup. ***
+  # # PrologixGPIB-USB controller can be configured to automatically address instruments to 'talk' after sending a command in order to read the response.
+  # # *** Avaliable in Controller mode. When enabled can cause the prologix controller to lockup. ***
   def auto=(auto_mode)
     mode =
       case auto_mode
@@ -93,8 +93,8 @@ module PrologixGpib::Usb::Commands
   end
   alias auto_read_after_write auto
 
-  # In :controller mode, address refers to the GPIB address of the instrument being controlled.
-  # In :device mode, it is the address of the GPIB peripheral that Prologix GPIB-USB controller is emulating.
+  # # In :controller mode, address refers to the GPIB address of the instrument being controlled.
+  # # In :device mode, it is the address of the GPIB peripheral that Prologix GPIB-USB controller is emulating.
   def address=(addr)
     write("++addr #{addr}")
   end
@@ -104,8 +104,8 @@ module PrologixGpib::Usb::Commands
     device_query('++addr')
   end
 
-  # This command enables or disables the assertion of the EOI signal with the last character of any command sent over GPIB port.
-  # Some instruments require EOI signal to be asserted in order to properly detect the end of a command.
+  # # This command enables or disables the assertion of the EOI signal with the last character of any command sent over GPIB port.
+  # # Some instruments require EOI signal to be asserted in order to properly detect the end of a command.
   def eoi=(eoi_mode)
     mode =
       case eoi_mode
@@ -123,13 +123,13 @@ module PrologixGpib::Usb::Commands
     device_query('++eoi')
   end
 
-  # This command specifies GPIB termination characters. When data from host is received over USB, all non-escaped LF, CR and ESC characters are removed and GPIB terminators, as specified by this command, are appended before sending the data to instruments.
-  # This command does not affect data from instruments received over GPIB port.
-  # EXAMPLES:
-  # 0 Append CR+LF
-  # 1 Append CR to instrument commands
-  # 2 Append LF to instrument commands
-  # 3 Do not append anything to instrument commands
+  # # This command specifies GPIB termination characters. When data from host is received over USB, all non-escaped LF, CR and ESC characters are removed and GPIB terminators, as specified by this command, are appended before sending the data to instruments.
+  # # This command does not affect data from instruments received over GPIB port.
+  # # EXAMPLES:
+  # # 0 Append CR+LF
+  # # 1 Append CR to instrument commands
+  # # 2 Append LF to instrument commands
+  # # 3 Do not append anything to instrument commands
   def eos=(eos_mode)
     error_message = "Invalid arg: '#{eos_mode}'"
     raise ArgumentError, error_message unless [0, 1, 2, 3].include? eos_mode
@@ -141,7 +141,7 @@ module PrologixGpib::Usb::Commands
     device_query('++eos')
   end
 
-  # This command enables or disables the appending of a user specified character (see eot_char) to USB output whenever EOI is detected while reading a character from the GPIBport.
+  # # This command enables or disables the appending of a user specified character (see eot_char) to USB output whenever EOI is detected while reading a character from the GPIBport.
   def eot=(eot_mode)
     mode =
       case eot_mode
@@ -186,18 +186,4 @@ module PrologixGpib::Usb::Commands
   def reset
     write('++rst')
   end
-
-  def flush
-    return unless connected?
-
-    loop until serial_port.getbyte.nil?
-  end
-
-  private
-
-  def device_query(command)
-    flush
-    write(command)
-    readline
-  end
 end

data/lib/prologix_gpib/discovery.rb

@@ -0,0 +1,128 @@
+module PrologixGpib::Discovery
+  require 'socket'
+  require 'ipaddr'
+  require 'bindata'
+  require 'timeout'
+
+  class Error < StandardError
+  end
+
+  def avaliable_controllers
+    { usb: usb_device_paths, lan: lan_device_ips }
+  end
+
+  class IPAddr < BinData::Primitive
+    array :octets, type: :uint8, initial_length: 4
+
+    def set(val)
+      self.octets = val.split(/\./).map(&:to_i)
+    end
+
+    def get
+      self.octets.map(&:to_s).join('.')
+    end
+  end
+
+  class MacAddr < BinData::Primitive
+    array :octets, type: :uint8, initial_length: 6
+
+    def set(val)
+      self.octets = val.split(/:/).map(&:hex)
+    end
+
+    def get
+      self.octets.map { |octet| '%02x' % octet }.join(':')
+    end
+  end
+
+  class NFHeader < BinData::Record
+    endian :big
+    uint8 :magic
+    uint8 :identify
+    uint16 :seq
+    mac_addr :eth_addr
+    bit16 :reserved, initial_value: 0x0000
+  end
+
+  class NFIdentifyReply < BinData::Record
+    endian :big
+    nf_header :header
+    uint16 :uptime_days
+    uint8 :uptime_hrs
+    uint8 :uptime_mins
+    uint8 :uptime_secs
+    uint8 :mode
+    uint8 :alert
+    uint8 :ip_type
+    ip_addr :addr
+    ip_addr :netmask
+    string :ip_gw, read_length: 4
+    string :app_ver, read_length: 4
+    string :boot_ver, read_length: 4
+    string :hw_ver, read_length: 4
+  end
+
+  NF_MAGIC = 0x5a
+  HEADER_FMT = 'CCna8'
+  NF_IDENTIFY = 0
+  NF_IDENTIFY_REPLY = 1
+  BROADCAST_PORT = 3040
+  BROADCAST_ADDRESS = '255.255.255.255'
+  TIMEOUT = 0.5
+
+  private
+
+  def lan_device_ips
+    seq = rand(0..65_535)
+
+    # puts "Seq = #{seq}"
+    sock = UDPSocket.new
+    sock.setsockopt(:SOL_SOCKET, :SO_BROADCAST, true)
+
+    # data = [NF_MAGIC, NF_IDENTIFY, seq, "\xFF\xFF\xFF\xFF\xFF\xFF"].pack(HEADER_FMT)
+
+    data = NFHeader.new
+    data.magic = NF_MAGIC
+    data.identify = NF_IDENTIFY
+    data.seq = seq
+    data.eth_addr = 'FF:FF:FF:FF:FF:FF'
+
+    sock.send(data.to_binary_s, 0, BROADCAST_ADDRESS, BROADCAST_PORT)
+    array = []
+    replies = []
+    begin
+      Timeout.timeout(TIMEOUT) do
+        while true
+          data, addr = sock.recvfrom(1000)
+          replies << data
+        end
+      end
+    rescue Timeout::Error
+      replies.each do |data|
+        begin
+          reply = NFIdentifyReply.read(data)
+        rescue EOFError
+          # About 1% of responses are not always as expected from the controller
+          next
+        end
+        next if array.include?(reply.addr)
+        array << reply.addr if reply.header.seq == seq && reply.header.identify == NF_IDENTIFY_REPLY
+      end
+      sock.close
+      array
+    end
+  end
+
+  def usb_device_paths
+    path_str, dir =
+      if RubySerial::ON_LINUX
+        %w[ttyUSB /dev/]
+      elsif RubySerial::ON_WINDOWS
+        ['TODO: Implement find device for Windows', 'You lazy bugger']
+      else
+        %w[tty.usbserial /dev/]
+      end
+
+    Dir.glob("#{dir}#{path_str}*")
+  end
+end

data/lib/prologix_gpib/lan.rb

@@ -1,3 +1,70 @@
+require 'timeout'
+
 module PrologixGpib::Lan
-  class Error < StandardError; end
-end
+  class Error < StandardError
+  end
+
+  DEVICE_PORT = 1234
+  EOL = "\r\n".freeze
+
+  def initialize(ip, mode: :controller, address: 9)
+    open_socket(ip)
+
+    # open_serial_port(paths)
+    # flush
+    # self.mode = mode
+    # self.address = address
+    # self.auto = :disable
+    # self.eos = 0
+
+    yield self if block_given?
+  end
+
+  def write(command)
+    return unless connected?
+
+    @socket.send "#{command}#{EOL}", 0
+    sleep 0.1
+  end
+
+  def read
+    return unless connected?
+
+    @socket.gets.chomp
+  end
+
+  private
+
+  def open_socket(ip)
+    @socket = TCPSocket.new ip, DEVICE_PORT
+    write('++ver')
+    return if getline.include? 'Prologix'
+
+    raise Error, 'No Prologix LAN controllers found.'
+  end
+
+  def connected?
+    raise Error, 'ConnectionError: No open Prologix device connections.' if @socket.nil?
+
+    true
+  end
+
+  def readline
+    return unless connected?
+
+    t = Timeout.timeout(1, Timeout::Error, "No response from device at #{@socket.peeraddr[3]}") { getline }
+  end
+
+  # This method will block until the EOL terminator is received
+  # The lower level gets method is pure ruby, so can be safely used with Timeout.
+  def getline
+    return unless connected?
+
+    @socket.gets(EOL).chomp
+  end
+
+  def device_query(command)
+    write(command)
+    readline
+  end
+end

data/lib/prologix_gpib/usb.rb

@@ -1,6 +1,5 @@
 module PrologixGpib::Usb
   require 'timeout'
-  require 'prologix_gpib/usb/commands'
 
   class Error < StandardError
   end
@@ -10,8 +9,7 @@ module PrologixGpib::Usb
   attr_reader :serial_port
 
   def initialize(path, mode: :controller, address: 9)
-    paths = path.nil? ? PrologixGpib.controller_paths : [path]
-    open_serial_port(paths)
+    open_serial_port(path)
     flush
     self.mode = mode
     self.address = address
@@ -29,10 +27,10 @@ module PrologixGpib::Usb
     @serial_port.nil?
   end
 
-  def write(str)
+  def write(string)
     return unless connected?
 
-    @serial_port.write("#{str}#{EOL}")
+    @serial_port.write("#{string}#{EOL}")
   end
 
   def read(bytes)
@@ -44,7 +42,7 @@ module PrologixGpib::Usb
   def readline
     return unless connected?
 
-    t = Timeout.timeout(1, Timeout::Error, 'No response from Data Acquisistion') { getline }
+    t = Timeout.timeout(1, Timeout::Error, 'No response from device') { getline }
   end
 
   def sr(register = nil)
@@ -58,12 +56,11 @@ module PrologixGpib::Usb
 
   private
 
-  def open_serial_port(paths)
-    paths.each do |path|
-      @serial_port = Serial.new(path)
-      write('++ver')
-      return if getline.include? 'Prologix'
-    end
+  def open_serial_port(path)
+    @serial_port = Serial.new(path)
+    write('++ver')
+    return if getline.include? 'Prologix'
+
     raise Error, 'No Prologix USB controllers found.'
   end
 
@@ -73,6 +70,12 @@ module PrologixGpib::Usb
     true
   end
 
+  def flush
+    return unless connected?
+
+    loop until serial_port.getbyte.nil?
+  end
+
   # This method will block until the EOL terminator is received
   # The lower level gets method is pure ruby, so can be safely used with Timeout.
   def getline
@@ -80,4 +83,10 @@ module PrologixGpib::Usb
 
     @serial_port.gets(EOL).chomp
   end
+
+  def device_query(command)
+    flush
+    write(command)
+    readline
+  end
 end

data/lib/prologix_gpib/version.rb

@@ -1,3 +1,3 @@
 module PrologixGpib
-  VERSION = '0.4.4'
+  VERSION = '0.5.3'
 end

data/lib/prologix_gpib.rb

@@ -4,46 +4,33 @@ require 'rubyserial'
 require 'prologix_gpib/version'
 require 'prologix_gpib/lan'
 require 'prologix_gpib/usb'
+require 'prologix_gpib/commands'
+require 'prologix_gpib/discovery'
 require 'prologix_gpib/cli'
 
 module PrologixGpib
   class UsbController
+    def test
+      puts 'testing'
+    end
+
     include PrologixGpib::Usb
-    include PrologixGpib::Usb::Commands
+    include PrologixGpib::Commands
   end
 
   class LanController
     include PrologixGpib::Lan
+    include PrologixGpib::Commands
+  end
+
+  class Finder
+    include PrologixGpib::Discovery
   end
 
-  # Ideally this class needs to handle finding all avaliable Prologix GPIB controllers (USB and Ethernet),
-  # But for now it simply passes the Prologix USB device paths onto the controller class
   # No windows serial support just yet.
   class << self
     def new
       self
     end
-
-    # Find first avaliable Prologix controller and return a valid controller object
-    def open; end
-
-    def usb_paths
-      usb_controller_paths
-    end
-
-    private
-
-    def usb_controller_paths
-      path_str, dir =
-        if RubySerial::ON_LINUX
-          %w[ttyUSB /dev/]
-        elsif RubySerial::ON_WINDOWS
-          ['TODO: Implement find device for Windows', 'You lazy bugger']
-        else
-          %w[tty.usbserial /dev/]
-        end
-
-      Dir.glob("#{dir}#{path_str}*")
-    end
   end
 end

data/prologix_gpib.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Prologix GPIB controller ruby wrapper.'
   spec.description = 'Ruby wrapper for the Prologix GPIB controllers, USB & Ethernet.'
-  spec.homepage = 'https://github.com/robcarruthers/prologix_gpib'
+  spec.homepage = 'https://gitlab.com/robcarruthers/prologix_gpib.git'
   spec.license = 'MIT'
 
   # spec.metadata['allowed_push_host'] = "http://mygemserver.com'"
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/robcarruthers/prologix_gpib'
-  spec.metadata['changelog_uri'] = 'https://github.com/robcarruthers/prologix_gpib'
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/robcarruthers/prologix_gpib.git'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/robcarruthers/prologix_gpib.git'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,9 +29,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '~> 7.0.1'
+  spec.add_dependency 'bindata', '~> 2.4.10'
   spec.add_dependency 'rubyserial', '~> 0.6.0'
-  spec.add_dependency 'thor', '~> 1.2.1'
   spec.add_dependency 'terminal-table', '~> 3.0.2'
+  spec.add_dependency 'thor', '~> 1.2.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/test_broadcast.rb

@@ -0,0 +1,50 @@
+require 'socket'
+
+def broadcast
+  addr = '255.255.255.255'
+  sock = UDPSocket.new
+  sock.setsockopt(:SOL_SOCKET, :SO_BROADCAST, true)
+
+  port = 3040
+
+  data = [90, 0, 11_111, "\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00"].pack('CCna8')
+  sock.send(data, 0, addr, port)
+
+  while true
+    r_data, r_addr = sock.recvfrom(2000) # if this number is too low it will drop the larger packets and never give them to you
+    p "From addr: #{r_addr}, msg: #{r_data}"
+    # p r_data.unpack('CCna8')
+    # puts ''
+  end
+
+  sock.close
+end
+
+# ❯ python
+
+# WARNING: Python 2.7 is not recommended.
+# This version is included in macOS for compatibility with legacy software.
+# Future versions of macOS will not include Python 2.7.
+# Instead, it is recommended that you transition to using 'python3' from within Terminal.
+
+# Python 2.7.18 (default, Nov 13 2021, 06:17:34)
+# [GCC Apple LLVM 13.0.0 (clang-1300.0.29.10) [+internal-os, ptrauth-isa=deployme on darwin
+# Type "help", "copyright", "credits" or "license" for more information.
+# >>> "Z\x00ST\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00".unpack("!2cH6s2x")
+# Traceback (most recent call last):
+#   File "<stdin>", line 1, in <module>
+# AttributeError: 'str' object has no attribute 'unpack'
+# >>> struct.unpack("!2cH6s2x", "Z\x00ST\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00")
+# Traceback (most recent call last):
+#   File "<stdin>", line 1, in <module>
+# NameError: name 'struct' is not defined
+# >>> import struct
+# >>> struct.unpack("!2cH6s2x", "Z\x00ST\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00")
+# ('Z', '\x00', 21332, '\xff\xff\xff\xff\xff\xff')
+# >>> struct.unpack("!2cH6s2x", "Z\x00s|\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00")
+# ('Z', '\x00', 29564, '\xff\xff\xff\xff\xff\xff')
+# >>> struct.unpack("!2cH6s2x", 'Z\x00+g\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00')
+# ('Z', '\x00', 11111, '\xff\xff\xff\xff\xff\xff')
+# >>>
+# 5a012b670021690100d700000000020324010000c0a80aa1ffffff00c0a80a01010300000101000001010000a5bba57bf645122ba7773d197aa7963448eb8c932a85527a24b3966096caa2ef
+# "\x5a\x01\x2b\x67\x00\x21\x69\x01\x00\xd7\x00\x00\x00\x00\x02\x03\x24\x01\x00\x00\xc0\xa8\x0a\xa1\xff\xff\xff\x00\xc0\xa8\x0a\x01\x01\x03\x00\x00\x01\x01\x00\x00\x01\x01\x00\x00\xa5\xbb\xa5\x7b\xf6\x45\x12\x2b\xa7\x77\x3d\x19\x7a\xa7\x96\x34\x48\xeb\x8c\x93\x2a\x85\x52\x7a\x24\xb3\x96\x60\x96\xca\xa2\xef"

data/test_script.rb

@@ -1,6 +1,45 @@
 #!/usr/bin/env ruby
-require 'prologix_gpib'
-paths = PrologixGpib.usb_paths
+require 'bindata'
 
-device = PrologixGpib::UsbController.new(paths[0])
-puts device.config
+class NFHeader < BinData::Record
+  endian :big
+  uint8 :magic
+  uint8 :identify
+  uint16 :seq
+  string :addr, read_length: 6
+  string :res, read_length: 2
+end
+
+class IPAddr < BinData::Primitive
+  array :octets, type: :uint8, initial_length: 4
+
+  def set(val)
+    self.octets = val.split(/\./).map(&:to_i)
+  end
+
+  def get
+    self.octets.map(&:to_s).join('.')
+  end
+end
+
+class NFIdentifyReply < BinData::Record
+  endian :big
+  nf_header :header
+  uint16 :uptime_days
+  uint8 :uptime_hrs
+  uint8 :uptime_mins
+  uint8 :uptime_secs
+  uint8 :mode
+  uint8 :alert
+  uint8 :ip_type
+  ip_addr :addr
+  ip_addr :netmask
+  string :ip_gw, read_length: 4
+  string :app_ver, read_length: 4
+  string :boot_ver, read_length: 4
+  string :hw_ver, read_length: 4
+end
+
+@identify = "Z\x00+g\xFF\xFF\xFF\xFF\xFF\xFF\x00\x00"
+@indentify_reply =
+  'Z\x01+g\x00!i\x01\x00\xd7\x00\x00\x00\x00\x02\x03$\x01\x00\x00\xc0\xa8\n\xa1\xff\xff\xff\x00\xc0\xa8\n\x01\x01\x03\x00\x00\x01\x01\x00\x00\x01\x01\x00\x00\xa5\xbb\xa5{\xf6E\x12+\xa7w=\x19z\xa7\x964H\xeb\x8c\x93*\x85Rz$\xb3\x96`\x96\xca\xa2\xef'

data/test_server.rb

@@ -0,0 +1,35 @@
+require 'socket'
+require 'ipaddr'
+
+class UDPTest
+  def listen
+    s = UDPSocket.new
+
+    # membership = IPAddr.new(multicast_addr).hton + IPAddr.new(bind_addr).hton
+    # s.setsockopt(:IPPROTO_UDP, :IP_ADD_MEMBERSHIP, membership)
+
+    s.bind('', 3040)
+    while true
+      data, addr = s.recvfrom(1024)
+      puts "addr = #{addr}\r\ndata ="
+      p data
+    end
+  end
+
+  def start_server
+    multi_addr = '225.1.1.1'
+    bind_addr = '0.0.0.0'
+
+    sock = UDPSocket.new
+    membership = IPAddr.new(multi_addr).hton + IPAddr.new(bind_addr).hton
+    sock.setsockopt(:IPPROTO_IP, :IP_ADD_MEMBERSHIP, membership)
+    sock.bind(bind_addr, 3040)
+    while true
+      data, addr = sock.recvfrom(2000) # if this number is too low it will drop the larger packets and never give them to you
+      p "From addr: #{addr}, msg: #{data}"
+      p data.unpack('CCna8')
+      puts ''
+    end
+    sock.close
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prologix_gpib
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.3
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 7.0.1
 - !ruby/object:Gem::Dependency
-  name: rubyserial
+  name: bindata
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.4.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.4.10
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rubyserial
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,8 +119,10 @@ files:
 - ".DS_Store"
 - ".gitignore"
 - ".tool-versions"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- NetFinder_info.md
 - PrologixGpibEthernetManual.pdf
 - PrologixGpibUsbManual-6.0.pdf
 - README.md
@@ -114,23 +130,27 @@ files:
 - bin/console
 - bin/setup
 - exe/plx
+- lan_test.rb
 - lib/prologix_gpib.rb
 - lib/prologix_gpib/cli.rb
+- lib/prologix_gpib/commands.rb
+- lib/prologix_gpib/discovery.rb
 - lib/prologix_gpib/lan.rb
 - lib/prologix_gpib/usb.rb
-- lib/prologix_gpib/usb/commands.rb
 - lib/prologix_gpib/version.rb
 - package.json
 - prologix_gpib.gemspec
+- test_broadcast.rb
 - test_script.rb
+- test_server.rb
 - yarn.lock
-homepage: https://github.com/robcarruthers/prologix_gpib
+homepage: https://gitlab.com/robcarruthers/prologix_gpib.git
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/robcarruthers/prologix_gpib
-  source_code_uri: https://github.com/robcarruthers/prologix_gpib
-  changelog_uri: https://github.com/robcarruthers/prologix_gpib
+  homepage_uri: https://gitlab.com/robcarruthers/prologix_gpib.git
+  source_code_uri: https://gitlab.com/robcarruthers/prologix_gpib.git
+  changelog_uri: https://gitlab.com/robcarruthers/prologix_gpib.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -146,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Prologix GPIB controller ruby wrapper.