lxi_rb 0.2.6 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4bc605d049472e8d0144e47698bbe5b2ea5e943464956fe44da6ad97b6e05e
-  data.tar.gz: 0ac0386d1043a2de040339e87d3dd494fa67ccec21d3e86453903a46aec433bd
+  metadata.gz: 0a2d5028a0fea52868aca234aa718d1224af6eb885cec75f25326047deecf2ce
+  data.tar.gz: a4c56ba50ae93eee1e93084015dfe3b5cee85b8a72c0b983e53535ae6d671f4b
 SHA512:
-  metadata.gz: 1cda03b1354f2d8b2b413b2139ef490e7b66869e1304db263774541578f389e85e6cd7dcb60221ad2be7e1ffd47514e72124a22af7f8389da29894ed3a946437
-  data.tar.gz: f30e8e12228cee9e8bdf05106f447413af3bf3c5f3313179b20cd1d539aff78c922bc94b394e2bf42caf3665efbe1140d56681452f309965a6697fe536a314b2
+  metadata.gz: 163b3f6f7721b8bf2a0123a81b0a945c5b219606d414aa036df1be75037a5f4e9fb39b2c609df77c5755ca5b9babbc332aa3565de37b1509c2696fc348f6b2ba
+  data.tar.gz: fa3dd7e0b992cf1c84a88c45af370a81f69ede9ae193e315769b0dd0094b38364d00583354b0a8f0ae8a5e079bc07a048085e24cddb646fb3ed1bddd570cdcc7

data/.cz.toml

@@ -0,0 +1,7 @@
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_type = "semver"
+version = "0.2.12"
+update_changelog_on_bump = true
+major_version_zero = true

data/CHANGELOG.md

@@ -1,17 +1,47 @@
-## Unreleased (2023-05-07)
+## Unreleased ([addbdb8..76314bf](https://github.com/robcarruthers/lxi_rb/compare/addbdb8..76314bf))
+#### Features
+- **(Test)** Some great Feature - ([76314bf](https://github.com/robcarruthers/lxi_rb/commit/76314bf4ccd40d9df8efe11bb1fc6046299b0284)) - [@robcarruthers](https://github.com/robcarruthers)
+
+- - -
+## [v0.2.18](https://github.com/robcarruthers/lxi_rb/compare/v0.2.16..v0.2.18) - 2023-05-08
+#### Features
+- **(Test)** Some great Feature - ([76314bf](https://github.com/robcarruthers/lxi_rb/commit/76314bf4ccd40d9df8efe11bb1fc6046299b0284)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Miscellaneous Chores
+- **(Changelog)** Update - ([8f7371b](https://github.com/robcarruthers/lxi_rb/commit/8f7371b5f2e0130476f5e173d5beb8aa32be7a6f)) - [@robcarruthers](https://github.com/robcarruthers)
+
+- - -
+
+
+## [v0.2.16](https://github.com/robcarruthers/lxi_rb/compare/1c313adf0923f740888c4a54550b855f3ed3c51a..v0.2.16) - 2023-05-08
+#### Bug Fixes
+- **(Testing)** Changed some file - ([a3f7a3a](https://github.com/robcarruthers/lxi_rb/commit/a3f7a3a01b385e6d8ebeb0d027beef7a79007f64)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Documentation
+- **(Changelog)** Update - ([0351586](https://github.com/robcarruthers/lxi_rb/commit/03515867cc91da4d3939fc26723729845c1336e1)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Update - ([4beb9d8](https://github.com/robcarruthers/lxi_rb/commit/4beb9d8dd1e95af30dc948fe81d79e7aa6262a7c)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** reset - ([13053e1](https://github.com/robcarruthers/lxi_rb/commit/13053e1abb88564a5deb87c2755199402c96714b)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Update cog config - ([857a9e8](https://github.com/robcarruthers/lxi_rb/commit/857a9e8b7d5580fee7a5b15f4f46dad96bda3378)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Update - ([9159d41](https://github.com/robcarruthers/lxi_rb/commit/9159d417ba38bee06d6676b563a1725f52569b5c)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Update cog config - ([a38d66c](https://github.com/robcarruthers/lxi_rb/commit/a38d66c0af084d4389a1e37acda47348acf489bb)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Update - ([0e53608](https://github.com/robcarruthers/lxi_rb/commit/0e536086b2f832d1e7e3a1660a017ba59d08b50f)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Add cog config - ([df15cb2](https://github.com/robcarruthers/lxi_rb/commit/df15cb2ed5de101820bd827b8b68ea311eaf45d6)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Changelog)** Update - ([5962f8d](https://github.com/robcarruthers/lxi_rb/commit/5962f8d7ffdb6378b7686005922793bde9011f92)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(Cog)** Update post bump hook - ([7c0d3d5](https://github.com/robcarruthers/lxi_rb/commit/7c0d3d58e8e18330f2172a1343ba9312c5da70ec)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(changelog)** Updated - ([556e501](https://github.com/robcarruthers/lxi_rb/commit/556e5011482c76dd3c0d1b8f9c57442e0e729296)) - [@robcarruthers](https://github.com/robcarruthers)
+- update README - ([d107e6d](https://github.com/robcarruthers/lxi_rb/commit/d107e6d33df272debc3a1944a794d85f3c01826b)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Features
+- **(NewFeature)** Add wonderful new feature - ([bf73cd1](https://github.com/robcarruthers/lxi_rb/commit/bf73cd148067492db8445376f9acafdd1b7e1680)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(device)** Init LXI Session - ([4880f26](https://github.com/robcarruthers/lxi_rb/commit/4880f2602b0a63713186a407ac4b3d2bd2dd4b10)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(ffi)** Add search class method - ([8f7351f](https://github.com/robcarruthers/lxi_rb/commit/8f7351f9b541614a717a83d291d169b1fd8db356)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Miscellaneous Chores
+- **(version)** v0.2.9 - ([155886b](https://github.com/robcarruthers/lxi_rb/commit/155886bd9fc05400293b80732ac16b6f39cd65ee)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(version)** v0.2.8 - ([2d77322](https://github.com/robcarruthers/lxi_rb/commit/2d77322d6a137ba710b393cfcf718981bcca0f1e)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(version)** v0.2.7 - ([8b4b6c5](https://github.com/robcarruthers/lxi_rb/commit/8b4b6c59984f53921b17b6446550413d90b22b90)) - [@robcarruthers](https://github.com/robcarruthers)
+- add github CI yml - ([145a3de](https://github.com/robcarruthers/lxi_rb/commit/145a3defba492d3985ea9ac4d4fba2a07259735e)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Refactoring
+- **(Rubocop)** fix offences - ([c3e4d23](https://github.com/robcarruthers/lxi_rb/commit/c3e4d232b76466ca71af7418ed7863b6de99af8e)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(ffi)** Remove comment - ([5fab4bf](https://github.com/robcarruthers/lxi_rb/commit/5fab4bf68e0f4dc6deb0ae690e3fdbe84d5c0a0c)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Style
+- **(Testing)** Some edits - ([7773b5e](https://github.com/robcarruthers/lxi_rb/commit/7773b5e256600e40146a67d7454c1e6aa7651755)) - [@robcarruthers](https://github.com/robcarruthers)
+#### Tests
+- make default tests pass - ([2a90b70](https://github.com/robcarruthers/lxi_rb/commit/2a90b70676c75ba90d94e1fc4d098f09b897978d)) - [@robcarruthers](https://github.com/robcarruthers)
 
-### New feature:
-
-- **device**: Init LXI Session([`4880f26`](https://github.com/robcarruthers/lxi_rb/commit/4880f2602b0a63713186a407ac4b3d2bd2dd4b10)) (by Rob Carruthers)
-
-## v0.2.3 (2023-05-07)
-
-## v0.2.1 (2023-05-07)
-
-### New feature:
-
-- **ffi**: Add search class method([`8f7351f`](https://github.com/robcarruthers/lxi_rb/commit/8f7351f9b541614a717a83d291d169b1fd8db356)) (by Rob Carruthers)
-
-## v0.2.0 (2023-05-07)
-
-## v0.1.0 (2023-05-07)

data/Gemfile.lock

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

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'structured_changelog/tasks'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'

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

@@ -2,6 +2,8 @@
 module Lxi
   class Device
     include FFI
+    include LxiMethods
+
     attr_accessor :id, :address, :port, :name, :timeout, :protocol
 
     def initialize(address, protocol)

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.6'
+  VERSION = '0.2.18'
 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.6
+  version: 0.2.18
 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
@@ -32,16 +32,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".cz.toml"
 - ".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,91 +0,0 @@
-# frozen_string_literal: true
-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(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
-
-    lxi_discover_internal(info, timeout, type)
-    sleep 0.1
-    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.negative?
-  end
-end