lxi_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79bb0d516f205bcdeeb9dd3e12d685fde5237c481b66ec02d80b54e22bd393ce
+  data.tar.gz: f713c4887fae97699c9c26a9a42e7b7b8308b7d615529889c53e41a843bc2a6a
+SHA512:
+  metadata.gz: def303af335abcb996b9f88709a8901da0b298e7687f46e72dbee56d451ea033972672c6f4a17e19ae9ce30a14cf34d92e5891472769e735d22c22718c019b07
+  data.tar.gz: c92a6342c28c3ba4d60d0480cd394d2ba6fa804c9abe0bf18b1327909fe43fa6ddc2edfb0ff3fd22abc66ac91b6ffeeaa72beea247ca08606c9bbc944e11753a

data/.streerc

@@ -0,0 +1 @@
+/Users/rob/.streerc

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lxi_rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    lxi_rb (0.1.0)
+      ffi (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    ffi (1.15.5)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rubocop (1.46.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  lxi_rb!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Rob Carruthers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# lxi_rb
+
+![Gem](https://img.shields.io/gem/v/lxi_rb?color=green&label=version) ![Ruby](https://img.shields.io/static/v1?message=Ruby&color=red&logo=Ruby&logoColor=FFFFFF&label=v3.2.1) ![Ruby](https://img.shields.io/gitlab/license/robcarruthers/rfbeam?color=orange)
+
+Ruby wrapper for the [liblxi](https://github.com/lxi-tools/liblxi) library.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add lxi_rb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install lxi_rb
+
+## Usage
+
+```ruby
+❯ irb
+irb(main):001:0> require 'lxi_rb'
+=> true
+
+irb(main):002:0> Lxi.search
+Searching for LXI devices - please wait...
+
+Broadcast: 127.0.0.1, lo0
+Broadcast: 192.168.10.255, en0
+Device: 192.168.10.21, Siglent Technologies,SDS1104X-E,SDSMMGKC6R0011,8.2.6.1.37R8
+Device: 192.168.10.107, Siglent Technologies,SDM3055-SC,SDM35GBQ6R1882,1.01.01.25
+=> nil
+
+irb(main):003:0> Lxi.scpi '192.168.10.21', 0, nil, :vxi11, '*IDN?'
+Siglent Technologies,SDS1104X-E,SDSMMGKC6R0011,8.2.6.1.37R8
+=> 0
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lxi_rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/lxi/device.rb

@@ -0,0 +1,50 @@
+module Lxi
+  class Device
+    include FFI
+    attr_accessor :id, :address, :port, :name, :timeout, :protocol
+
+    def initialize(address, protocol)
+      @address = address
+      @port = 0
+      @name = nil
+      @timeout = 1000
+      @protocol = protocol
+      @id = -1
+
+      connect
+
+      yield self if block_given?
+    end
+
+    def connect
+      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
+
+      true
+    end
+    alias open connect
+
+    def disconnect
+      Lxi.lxi_disconnect(@id)
+    end
+    alias close disconnect
+
+    def send(message)
+      bytes_sent = Lxi.lxi_send(@id, message, message.length, @timeout)
+      raise Error, 'LXI communications error' unless bytes_sent.positive?
+
+      bytes_sent
+    end
+    alias scpi send
+    alias write send
+
+    def read(length)
+      message = FFI::MemoryPointer.new(:char, length)
+      raise Error, 'LXI communications error' unless Lxi.lxi_receive(@id, message, length, @timeout).positive?
+      message.read_string
+    end
+    alias gets read
+  end
+end

data/lib/lxi/ffi.rb

@@ -0,0 +1,90 @@
+require 'ffi'
+
+module Lxi
+  extend FFI::Library
+
+  # Set the path to the library
+  ffi_lib '/opt/homebrew/lib/liblxi.dylib'
+  ffi_lib_flags :now, :global
+
+  # Define the enums
+  enum :lxi_protocol_type, %i[vxi11 raw hyslip]
+  enum :lxi_discover_type, %i[vxi11 mdns]
+
+  # Callbacks
+  BroadcastCallback =
+    FFI::Function.new(:void, %i[pointer pointer]) do |address, interface|
+      puts "Broadcast: #{address.read_string}, #{interface.read_string}"
+    end
+
+  DeviceCallback =
+    FFI::Function.new(:void, %i[pointer pointer]) do |address, id|
+      puts "Device: #{address.read_string}, #{id.read_string}"
+    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
+
+  # Define the structs
+  class LxiInfo < FFI::Struct
+    layout :broadcast,
+           callback(%i[pointer pointer], :void),
+           :device,
+           callback(%i[pointer pointer], :void),
+           :service,
+           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
+  def self.search(timeout: 1000, type: :vxi11)
+    lxi_init
+
+    info = LxiInfo.new
+    info[:broadcast] = BroadcastCallback
+    info[:device] = DeviceCallback
+
+    puts "Searching for LXI devices - please wait...\n\n"
+
+    result = lxi_discover_internal(info, timeout, type)
+
+    puts "Error during discovery: #{result}" if result < 0
+  end
+end

data/lib/lxi/version.rb

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

data/lib/lxi_rb.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'lxi/version'
+require_relative 'lxi/ffi'
+require_relative 'lxi/device'
+
+module Lxi
+  class Error < StandardError
+  end
+  # Your code goes here...
+end

data/lxi_rb.gemspec

@@ -0,0 +1,40 @@
+# 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

data/sig/lxi_rb.rbs

@@ -0,0 +1,4 @@
+module LxiRb
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: lxi_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Carruthers
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: The gem includes methods required for discovering and communicating with
+  LXI compliant devices
+email:
+- robcarruthers@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".streerc"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lxi/device.rb
+- 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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robcarruthers/lxi_rb
+  source_code_uri: https://github.com/robcarruthers/lxi_rb
+  changelog_uri: https://github.com/robcarruthers/lxi_rb/-/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the liblxi library.
+test_files: []