prologix_gpib 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0291d4b1a403dbcfb0d04712ac0a56540557713e474c042e7f0e31230667063c'
-  data.tar.gz: bf2a09c534d2ed527ff86f40f536e4b50c17c528b327004c5fb74afae60b7e79
+  metadata.gz: d9ad45cfaf230b41f26ec6102bb89f34b36f8a6f38439b96a578ae4f9b338a87
+  data.tar.gz: 336106999abd44891bc67b872fe45c8bf222356725675b90321409aee3a0e751
 SHA512:
-  metadata.gz: 8af96e69eb2c5e558b93986568053cb3c7a423d51cd80c7ab9482e95a4d253f79b1afaa807eaa726ccd088b92e278c1e5c6a58cc908ec3f33009f7b398b4621d
-  data.tar.gz: 3dc286605d8bd9bab02a61a3a653097b8037084689efb4731cf4856c76c28372834d929596d4fbf32532c0e32d21b6e0341a7f294f7348702b7f1e72fa409a37
+  metadata.gz: ee481f80d7bb2e9d3e62cdeb2c86e69b5a73422f93387e133c4837329ec08b3df429c92cc6cc2035ea2d3227b82d6d5a2b4858bb5af83f12358e988f8efe4173
+  data.tar.gz: e21355fd8937ebfbbf368838b84fe6143bf0e08c82c05a98b035e897277bdb3ceabe7a78d075b780d70fe48dcb3c9ab16806dade3bcd14e9b597d336f3b65767

data/.tool-versions

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prologix_gpib (0.4.4)
+    prologix_gpib (0.5.0)
       activesupport (~> 7.0.1)
       bindata (~> 2.4.10)
       rubyserial (~> 0.6.0)
@@ -11,19 +11,19 @@ PATH
 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)
@@ -47,4 +47,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 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

@@ -28,14 +28,16 @@ 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,6 +52,18 @@ $ 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
 ```
 
 ### Finding Controllers
@@ -67,7 +81,7 @@ irb(main):002:0> controllers = f.avaliable_controllers
 
 ### Working with Controllers
 
-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 the implementation.
+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.
 
 ```ruby
 irb(main):003:0> device = PrologixGpib::UsbController.new(controllers[:usb][0])

data/lib/prologix_gpib/cli.rb

@@ -2,28 +2,34 @@ 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
-      puts controller_table(PrologixGpib::Finder.new.avaliable_controllers)
+      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
@@ -59,11 +65,15 @@ module PrologixGpib
     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

@@ -60,7 +60,6 @@ module PrologixGpib::Discovery
     string :app_ver, read_length: 4
     string :boot_ver, read_length: 4
     string :hw_ver, read_length: 4
-    stringz :name
   end
 
   NF_MAGIC = 0x5a
@@ -69,7 +68,7 @@ module PrologixGpib::Discovery
   NF_IDENTIFY_REPLY = 1
   BROADCAST_PORT = 3040
   BROADCAST_ADDRESS = '255.255.255.255'
-  TIMEOUT = 1
+  TIMEOUT = 0.5
 
   private
 
@@ -90,16 +89,25 @@ module PrologixGpib::Discovery
 
     sock.send(data.to_binary_s, 0, BROADCAST_ADDRESS, BROADCAST_PORT)
     array = []
+    replies = []
     begin
       Timeout.timeout(TIMEOUT) do
         while true
-          data, addr = sock.recvfrom(256)
-          reply = NFIdentifyReply.read(data)
-          next if array.include?(reply.addr)
-          array << reply.addr if reply.header.seq == seq && reply.header.identify == NF_IDENTIFY_REPLY
+          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

data/lib/prologix_gpib/lan.rb

@@ -1,12 +1,14 @@
+require 'timeout'
+
 module PrologixGpib::Lan
   class Error < StandardError
   end
 
   DEVICE_PORT = 1234
-  EOL = "\r\n"
+  EOL = "\r\n".freeze
 
   def initialize(ip, mode: :controller, address: 9)
-    @socket = TCPSocket.new ip, DEVICE_PORT
+    open_socket(ip)
 
     # open_serial_port(paths)
     # flush
@@ -18,8 +20,51 @@ module PrologixGpib::Lan
     yield self if block_given?
   end
 
-  def version
-    @socket.send "++ver#{EOL}", 0
+  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

@@ -9,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
@@ -28,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)
@@ -43,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)
@@ -57,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
 
@@ -72,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
@@ -79,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.5.0'
+  VERSION = '0.5.2'
 end

data/lib/prologix_gpib.rb

@@ -3,21 +3,24 @@
 require 'rubyserial'
 require 'prologix_gpib/version'
 require 'prologix_gpib/lan'
-require 'prologix_gpib/lan/commands'
 require 'prologix_gpib/usb'
-require 'prologix_gpib/usb/commands'
+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::Lan::Commands
+    include PrologixGpib::Commands
   end
 
   class Finder

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prologix_gpib
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,6 +121,7 @@ files:
 - ".tool-versions"
 - Gemfile
 - Gemfile.lock
+- NetFinder_info.md
 - PrologixGpibEthernetManual.pdf
 - PrologixGpibUsbManual-6.0.pdf
 - README.md
@@ -131,18 +132,16 @@ files:
 - 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/lan/commands.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
-- udp_info.md
 - yarn.lock
 homepage: https://github.com/robcarruthers/prologix_gpib
 licenses:
@@ -166,7 +165,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.

data/lib/prologix_gpib/lan/commands.rb

@@ -1,2 +0,0 @@
-module PrologixGpib::Lan::Commands
-end

data/udp_info.md

@@ -1,30 +0,0 @@
-Hello Rob,
-
-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.