lxi_rb 0.2.3 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e72bc52c850f4d1904dd30130293eda4a68c004f201026f7b90f967980820db
-  data.tar.gz: bf7cf567edc90d38f1a295ffee34b7ac1eef04a564b5ebca1003995c9381fbea
+  metadata.gz: e5a2e41d04c72d5f37b67d05dcfd14355b2f58701267eb3383be70a93001029d
+  data.tar.gz: '0259e1a5cd12424ea7b45553f65fe8ba651e530db53411c901577dd5338e70b5'
 SHA512:
-  metadata.gz: 56dd416d6c473a111929c8b69dcf12f8c4c0a71b65f3c3b1f8d37333022ceb902f6228d691fb8dbfb4884dcf284a6f9c07c9da8892e9eb8fcd038b15e75d959c
-  data.tar.gz: 44fea582e9a62f9f3c1c3eadc89838d471e1d9649c3627ad837d49a5e4ef5c5caf48036626f82782da307451635c0452de32f1d9eaf49820f44ea0b371baa896
+  metadata.gz: e4251c145be1dd444778f4be52552892dd169cc348a7a3fc3f737f4b45c1a2aad871aa6d880280d38a274e25df16ac10f19cdc18bdce5d896bf14ae7f5a3ad67
+  data.tar.gz: eb41b5d33114abf02156ad77fdd3c91a3864a6f3b2e09f6f712344aede5baef9d4ac8e026577a0fd6a3cf22fd2ec99b02c07b168515d06f8fb2a5b26fb5fcc1f

data/CHANGELOG.md

@@ -1,11 +1,21 @@
-## v0.2.3 (2023-05-07)
-## v0.2.2 (2023-05-07)
-## v0.2.1 (2023-05-07)
+# Changelog
 
-### New feature:
+## [v0.2.6](https://github.com/robcarruthers/lxi_rb/tree/v0.2.6) (2023-05-07)
 
-- **ffi**: Add search class method([`8f7351f`](https://github.com/robcarruthers/lxi_rb/commit/8f7351f9b541614a717a83d291d169b1fd8db356)) (by Rob Carruthers)
+[Full Changelog](https://github.com/robcarruthers/lxi_rb/compare/v0.2.1...v0.2.6)
 
-## v0.2.0 (2023-05-07)
+## [v0.2.1](https://github.com/robcarruthers/lxi_rb/tree/v0.2.1) (2023-05-07)
 
-## v0.1.0 (2023-05-07)
+[Full Changelog](https://github.com/robcarruthers/lxi_rb/compare/v0.2.0...v0.2.1)
+
+## [v0.2.0](https://github.com/robcarruthers/lxi_rb/tree/v0.2.0) (2023-05-07)
+
+[Full Changelog](https://github.com/robcarruthers/lxi_rb/compare/v0.1.0...v0.2.0)
+
+## [v0.1.0](https://github.com/robcarruthers/lxi_rb/tree/v0.1.0) (2023-05-06)
+
+[Full Changelog](https://github.com/robcarruthers/lxi_rb/compare/1c313adf0923f740888c4a54550b855f3ed3c51a...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+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"
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

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

data/Rakefile

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

data/cog.toml

@@ -0,0 +1,26 @@
+from_latest_tag = true
+ignore_merge_commits = false
+branch_whitelist = []
+pre_bump_hooks = []
+post_bump_hooks = [
+  "rake release"
+]
+pre_package_bump_hooks = []
+post_package_bump_hooks = []
+tag_prefix = "v"
+
+[commit_types]
+
+[changelog]
+path = "CHANGELOG.md"
+template = "remote"
+remote = "github.com"
+repository = "lxi_rb"
+owner = "robcarruthers"
+authors = [
+  { signature = "Rob Carruthers", username = "robcarruthers" }
+]
+
+[bump_profiles]
+
+[packages]

data/lib/lxi/constants.rb

@@ -0,0 +1,21 @@
+module Lxi
+  # LXI Constants
+  LXI_OK = 0
+  LXI_ERROR = -1
+
+  # VXI11 Discovery 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
+end

data/lib/lxi/device.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 module Lxi
   class Device
     include FFI
+    include LxiMethods
+
     attr_accessor :id, :address, :port, :name, :timeout, :protocol
 
     def initialize(address, protocol)
@@ -17,7 +20,7 @@ module Lxi
     end
 
     def connect
-      raise Error, 'LXI Library Initialisation Error' unless Lxi.lxi_init == LXI_OK
+      init_lxi_session
 
       @id = Lxi.lxi_connect(@address, @port, @name, @timeout, @protocol)
       raise Error, 'LXI Connection Error' if @id == LXI_ERROR

data/lib/lxi/discovery.rb

@@ -0,0 +1,38 @@
+module Lxi
+  module Discovery
+    module_function
+
+    # Search for LXI-11 devices on the specified interface and return hash of devices
+    def devices(timeout: 1000, type: :vxi11)
+      raise Error, 'LXI Library Initialisation Error' unless lxi_init == LXI_OK
+
+      devices = []
+      device_callback =
+        FFI::Function.new(:void, %i[pointer pointer]) do |address, id|
+          devices << { address: address.read_string, id: id.read_string }
+        end
+
+      info = LxiInfo.new
+      info[:device] = device_callback
+
+      lxi_discover_internal(info, timeout, type)
+      sleep 0.1
+      devices
+    end
+
+    # Discover LXI-11 devices on the LAN
+    def discover_local(timeout: 1000, type: :vxi11)
+      Lxi.init_lxi_session
+
+      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.negative?
+    end
+  end
+end

data/lib/lxi/functions.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'ffi'
+
+module Lxi
+  module FFIFunctions
+    extend FFI::Library
+
+    ffi_lib '/opt/homebrew/lib/liblxi.dylib'
+    ffi_lib_flags :now, :global
+
+    # Define liblxi 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 liblxi enums
+    enum :lxi_protocol_type, %i[vxi11 raw hyslip]
+    enum :lxi_discover_type, %i[vxi11 mdns]
+
+    # 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
+  end
+end

data/lib/lxi/methods.rb

@@ -0,0 +1,10 @@
+module Lxi
+  module LxiMethods
+    private
+
+    # Initialise the LXI library
+    def init_lxi_session
+      raise Error, 'LXI Library Initialisation Error' unless Lxi.lxi_init == LXI_OK
+    end
+  end
+end

data/lib/lxi/version.rb

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

data/lib/lxi_rb.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 require_relative 'lxi/version'
-require_relative 'lxi/ffi'
+require_relative 'lxi/ffi_functions'
+require_relative 'lxi/lxi_methods'
+require_relative 'lxi/lxi_constants'
 require_relative 'lxi/device'
 
 module Lxi
+  extend FFIFunctions
+  include LxiMethods
+
   class Error < StandardError
   end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lxi_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.12
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-07 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -34,14 +34,19 @@ extra_rdoc_files: []
 files:
 - ".streerc"
 - ".tool-versions"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- cog.toml
+- lib/lxi/constants.rb
 - lib/lxi/device.rb
-- lib/lxi/ffi.rb
+- lib/lxi/discovery.rb
+- lib/lxi/functions.rb
+- lib/lxi/methods.rb
 - lib/lxi/version.rb
 - lib/lxi_rb.rb
 - sig/lxi_rb.rbs

data/lib/lxi/ffi.rb

@@ -1,92 +0,0 @@
-require 'ffi'
-
-module Lxi
-  extend FFI::Library
-
-  ffi_lib '/opt/homebrew/lib/liblxi.dylib'
-  ffi_lib_flags :now, :global
-
-  # Define liblxi 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
-
-  # 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]
-
-  # 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
-
-  # VXI11 Discovery 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
-
-  # Initialise the LXI library
-  def init_lxi_session
-    raise Error, 'LXI Library Initialisation Error' unless lxi_init == LXI_OK
-  end
-
-  # Search for LXI-11 devices on the specified interface and return hash of devices
-  def self.devices(interface: 'en0', timeout: 1000, type: :vxi11)
-    raise Error, 'LXI Library Initialisation Error' unless lxi_init == LXI_OK
-
-    devices = []
-    callback =
-      FFI::Function.new(:void, %i[pointer pointer]) do |address, id|
-        devices << { address: address.read_string, id: id.read_string }
-      end
-
-    info = LxiInfo.new
-    info[:broadcast] = BroadcastCallback
-    info[:device] = callback
-
-    result = lxi_discover_internal(info, timeout, type)
-    sleep 0.1
-    puts "result: #{result}"
-    puts "info: #{info[:device].read_string}"
-    devices
-  end
-
-  # Discover LXI-11 devices on the LAN
-  def self.discover_local(timeout: 1000, type: :vxi11)
-    init_lxi_session
-
-    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