lxi_rb 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06ae58333488267474e2ec65169d809368c88d64ada4ae52e672b25fc5168b56
-  data.tar.gz: 2a6bd3a037bd50ae1f116f3371f4b3df42c2dfbf0dbfc74b180a90f8ab330b3a
+  metadata.gz: 4b847376736132429d609f86fd63bd6193bf5ad9448d51c5df87f68c3c53b916
+  data.tar.gz: f9640603dce7a800d0ef0fdf107b5c0f2271daa1f978329b3650b5d87c238941
 SHA512:
-  metadata.gz: '016579af70c463e8a41a65d51497fdc5563473fe4620190a81eb4a37ca6d23261e15d5c0d2bc522725f277e3c1aee33575db4a0616d992613aa97173d0090ed4'
-  data.tar.gz: 28a4bc31a7e6d5c8363182c856139ed17b7978c5da390ae47dc0f944ef75219fd4aa76d8a47689994380394395c37a21a2fb715cfba601f8f267fe9c467b9fec
+  metadata.gz: 55209a7f2b3fc12db1f316f9c38ac6b1013b3d7f429f636e9bbc0707ed09e217387eb55afa9959a884b005bcd2a87c1fd23d1097fbb62246f81e8ef77c1668ee
+  data.tar.gz: 14f8e2a2e194e4a409292a252fa133d735b8788d8c38d9d05bdef82ccffeb834225fb1e3c8cc46a0fd49368e7746b8249f38f063b473ff017f6033cb7c2b6333

data/CHANGELOG.md

@@ -4,6 +4,15 @@
 All notable changes to this project will be documented in this file.
 
 - - -
+## [v0.8.0](https://github.com/robcarruthers/lxi_rb/compare/v0.7.3..v0.8.0) - 2023-05-19
+#### Features
+- **(examples)** Add scpi example - ([1d3ce45](https://github.com/robcarruthers/lxi_rb/commit/1d3ce45f199ae50fc2fded3fc2741aa132e5e4ac)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(examples)** Add discover example - ([9b51eff](https://github.com/robcarruthers/lxi_rb/commit/9b51eff22d13261525a68bd7e95064a7e7567f1b)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Refactoring
+- **(discovery)** Refine output. Fix specs. - ([4a73630](https://github.com/robcarruthers/lxi_rb/commit/4a736308a2a149ce360d351a24d58d9803ad3ad1)) - [@robcarruthers](https://github.com/robcarruthers)
+
+- - -
+
 ## [v0.7.3](https://github.com/robcarruthers/lxi_rb/compare/v0.7.2..v0.7.3) - 2023-05-15
 #### Refactoring
 - **(gemspec)** Update Gemfile with dev group - ([b5e5cdd](https://github.com/robcarruthers/lxi_rb/commit/b5e5cdd8d7c0517e980700b43c4080ea03bf8467)) - [@robcarruthers](https://github.com/robcarruthers)

data/Gemfile.lock

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

data/examples/discover.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'ffi'
+require_relative '../lib/lxi_rb'
+
+# Discovery Callbacks
+BroadcastCallback =
+  FFI::Function.new(:void, %i[pointer pointer]) do |address, interface|
+    puts("Broadcast: #{address.read_string}, #{interface.read_string}\n")
+  end
+
+DeviceCallback =
+  FFI::Function.new(:void, %i[pointer pointer]) do |address, id|
+    puts("\n    Found #{id.read_string} on address #{address.read_string}\n    lxi service on port 80")
+  end
+
+ServiceCallback =
+  FFI::Function.new(:void, %i[pointer pointer pointer int]) do |address, id, service, port|
+    puts("Service: #{address.read_string}, #{id.read_string}, #{service.read_string}, #{port}")
+  end
+
+# Discover LXI-11 devices on the LAN
+timeout_ms = 1000
+# Search types, Bonjour :mdns or VXI-11 :vxi11 (default)
+search_type = :vxi11
+
+Lxi.init_lxi_session
+info = Lxi::FFIFunctions::LxiInfo.new
+info[:broadcast] = BroadcastCallback
+info[:device] = DeviceCallback
+
+puts("Searching for LXI devices - please wait...\n\n")
+
+result = Lxi.lxi_discover_internal(info, timeout_ms, search_type)
+puts("Error during discovery: #{result}") if result.negative?

data/examples/scpi.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require_relative '../lib/lxi_rb'
+
+# Initialize LXI library
+Lxi.init_lxi_session
+
+# Lxi.search will return an Array of device identifiers and IP addresses
+devices = Lxi.search
+abort 'No devices found' if devices.nil? || devices.empty?
+
+# Create a new LXI device
+device_ip_address = devices[0][:address]
+device_type = :vxi11
+command = '*IDN?'
+
+Lxi::Device.new(device_ip_address, device_type) do |device|
+  device.send command
+  sleep 0.05
+  puts device.read 512
+end

data/lib/lxi/discovery.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Lxi
-  # Search for LXI-11 instruments on the network and return hash of instruments
-  def self.discover(timeout: 1000, type: :vxi11)
+  # Search for LXI-11 instruments on the network and return array of instruments
+  def self.search(timeout: 1000, type: :vxi11)
     raise(Error, 'LXI Library Initialisation Error') unless lxi_init == LXI_OK
 
     devices = []
@@ -13,13 +13,19 @@ module Lxi
     info = FFIFunctions::LxiInfo.new
     info[:device] = device_callback
 
-    lxi_discover_internal(info, timeout, type)
-    sleep(0.1)
+    result = lxi_discover_internal(info, timeout, type)
+    raise(Error, "Discovery error: #{result}") unless result == LXI_OK
+
+    sleep(0.5)
     devices
   end
 
+  def self.asdf
+    puts 'asdf'
+  end
+
   # Discover LXI-11 devices on the LAN
-  def self.search(timeout: 1000, type: :vxi11)
+  def self.discover(timeout: 1000, type: :vxi11)
     Lxi.init_lxi_session
 
     info = FFIFunctions::LxiInfo.new

data/lib/lxi/functions.rb

@@ -18,6 +18,19 @@ module Lxi
              callback(%i[pointer pointer pointer int], :void)
     end
 
+    class LxiBrowseInfo < FFI::Struct
+      layout :broadcast,
+             callback(%i[pointer pointer], :void),
+             :device,
+             callback(%i[pointer pointer], :void),
+             :service,
+             callback(%i[pointer pointer pointer int], :void),
+             :servicename,
+             :string,
+             :regtype,
+             :string
+    end
+
     # Define liblxi enums
     enum :lxi_protocol_type, %i[vxi11 raw hyslip]
     enum :lxi_discover_type, %i[vxi11 mdns]

data/lib/lxi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lxi_rb
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -41,6 +41,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/discover.rb
+- examples/scpi.rb
 - lib/lxi/callbacks.rb
 - lib/lxi/constants.rb
 - lib/lxi/device.rb