lxi_rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bb0d516f205bcdeeb9dd3e12d685fde5237c481b66ec02d80b54e22bd393ce
-  data.tar.gz: f713c4887fae97699c9c26a9a42e7b7b8308b7d615529889c53e41a843bc2a6a
+  metadata.gz: 46b92e004dc07e1fe7bd3badd3ad1163c4555abe9ec2992b619ff9f49ffc657c
+  data.tar.gz: b0c02b7b8ef14803b3179b5360c9b5c515049dfe69e6137736d3d989cac0027a
 SHA512:
-  metadata.gz: def303af335abcb996b9f88709a8901da0b298e7687f46e72dbee56d451ea033972672c6f4a17e19ae9ce30a14cf34d92e5891472769e735d22c22718c019b07
-  data.tar.gz: c92a6342c28c3ba4d60d0480cd394d2ba6fa804c9abe0bf18b1327909fe43fa6ddc2edfb0ff3fd22abc66ac91b6ffeeaa72beea247ca08606c9bbc944e11753a
+  metadata.gz: 6ba992bf1a91502ba42c5ff7e5f408d38d627a56eb20019491ee3fd596a059881cb516ade0132d0be9551767c30e52ce471cffbd6a7b581ac985770456be1012
+  data.tar.gz: d85a26e8551eeee60d5aa87594d81027b6bd42a997b2234aa49d530f9431939346bd802ff3175e63a40ddff3b9e802e4e1d94f998f42aee8c0d57c0d2cf30980

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lxi_rb (0.1.0)
+    lxi_rb (0.2.0)
       ffi (~> 1.15)
 
 GEM

data/lib/lxi/device.rb

@@ -17,10 +17,10 @@ module Lxi
     end
 
     def connect
-      raise Error, 'LXI Library Initialisation Error' unless Lxi.lxi_init == Lxi::OK
+      raise Error, 'LXI Library Initialisation Error' unless Lxi.lxi_init == LXI_OK
 
       @id = Lxi.lxi_connect(@address, @port, @name, @timeout, @protocol)
-      raise Error, 'LXI Connection Error' if @id == Lxi::ERROR
+      raise Error, 'LXI Connection Error' if @id == LXI_ERROR
 
       true
     end
@@ -42,7 +42,9 @@ module Lxi
 
     def read(length)
       message = FFI::MemoryPointer.new(:char, length)
-      raise Error, 'LXI communications error' unless Lxi.lxi_receive(@id, message, length, @timeout).positive?
+      bytes_received = Lxi.lxi_receive(@id, message, length, @timeout)
+      raise Error, 'LXI communications error' unless bytes_received.positive?
+
       message.read_string
     end
     alias gets read

data/lib/lxi/ffi.rb

@@ -7,11 +7,24 @@ module Lxi
   ffi_lib '/opt/homebrew/lib/liblxi.dylib'
   ffi_lib_flags :now, :global
 
-  # Define the enums
+  # Expose liblxi functions
+  attach_function :lxi_init, [], :int
+  attach_function :lxi_discover_internal, :lxi_discover, [LxiInfo.ptr, :int, :lxi_discover_type], :int
+  attach_function :lxi_discover_if, [LxiInfo.ptr, :string, :int, :lxi_discover_type], :int
+  attach_function :lxi_connect, %i[string int string int lxi_protocol_type], :int
+  attach_function :lxi_send, %i[int string int int], :int
+  attach_function :lxi_receive, %i[int pointer int int], :int
+  attach_function :lxi_disconnect, [:int], :int
+
+  # LXI Constants
+  LXI_OK = 0
+  LXI_ERROR = -1
+
+  # Define liblxi enums
   enum :lxi_protocol_type, %i[vxi11 raw hyslip]
   enum :lxi_discover_type, %i[vxi11 mdns]
 
-  # Callbacks
+  # VXI11 Discovery Callbacks
   BroadcastCallback =
     FFI::Function.new(:void, %i[pointer pointer]) do |address, interface|
       puts "Broadcast: #{address.read_string}, #{interface.read_string}"
@@ -27,7 +40,7 @@ module Lxi
       puts "Service: #{address.read_string}, #{id.read_string}, #{service.read_string}, #{port}"
     end
 
-  # Define the structs
+  # Define liblxi structs
   class LxiInfo < FFI::Struct
     layout :broadcast,
            callback(%i[pointer pointer], :void),
@@ -37,43 +50,7 @@ module Lxi
            callback(%i[pointer pointer pointer int], :void)
   end
 
-  # Define the functions
-  attach_function :lxi_init, [], :int
-  attach_function :lxi_discover_internal, :lxi_discover, [LxiInfo.ptr, :int, :lxi_discover_type], :int
-  attach_function :lxi_discover_if, [LxiInfo.ptr, :string, :int, :lxi_discover_type], :int
-  attach_function :lxi_connect, %i[string int string int lxi_protocol_type], :int
-  attach_function :lxi_send, %i[int string int int], :int
-  attach_function :lxi_receive, %i[int pointer int int], :int
-  attach_function :lxi_disconnect, [:int], :int
-
-  # Define the constants
-  OK = 0
-  ERROR = -1
-
-  # Send and recieve scpi commands
-  def self.scpi(address, port = 0, name = nil, protocol, command)
-    response = FFI::MemoryPointer.new(:char, 65_536)
-    timeout = 1000
-
-    # Initialize LXI library
-    lxi_init
-
-    # Connect LXI device
-    device = lxi_connect(address, port, name, timeout, protocol)
-
-    # Send SCPI command
-    lxi_send(device, command, command.length, timeout)
-
-    # Wait for response
-    lxi_receive(device, response, response.size, timeout)
-
-    puts response.read_string
-
-    # Disconnect
-    lxi_disconnect(device)
-  end
-
-  # Discover LXI devices on the LAN
+  # Discover LXI-11 devices on the LAN
   def self.search(timeout: 1000, type: :vxi11)
     lxi_init
 

data/lib/lxi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lxi
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lxi_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -44,7 +44,6 @@ files:
 - lib/lxi/ffi.rb
 - lib/lxi/version.rb
 - lib/lxi_rb.rb
-- lxi_rb.gemspec
 - sig/lxi_rb.rbs
 homepage: https://github.com/robcarruthers/lxi_rb
 licenses:

data/lxi_rb.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/lxi/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'lxi_rb'
-  spec.version = Lxi::VERSION
-  spec.authors = ['Rob Carruthers']
-  spec.email = ['robcarruthers@mac.com']
-
-  spec.summary = 'Ruby wrapper for the liblxi library.'
-  spec.description = 'The gem includes methods required for discovering and communicating with LXI compliant devices'
-  spec.homepage = 'https://github.com/robcarruthers/lxi_rb'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.1.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/robcarruthers/lxi_rb'
-  spec.metadata['changelog_uri'] = 'https://github.com/robcarruthers/lxi_rb/-/blob/master/CHANGELOG.md'
-
-  # 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.
-  spec.files =
-    Dir.chdir(__dir__) do
-      `git ls-files -z`.split("\x0")
-        .reject do |f|
-          (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-        end
-    end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency 'ffi', '~> 1.15'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end