ant-wireless 0.1.0 → 0.4.0

data/lib/ant.rb

@@ -12,7 +12,7 @@ module Ant
 	extend Loggability
 
 	# Package version
-	VERSION = '0.1.0'
+	VERSION = '0.4.0'
 
 	# A Range for matching valid ANT device numbers
 	VALID_DEVICE_NUMBERS = ( 0...65535 ).freeze
@@ -26,6 +26,14 @@ module Ant
 	# The valid offsets for the "RF Frequency" setting; this is an offset from 2400Hz.
 	VALID_RF_FREQUENCIES = ( 0...124 ).freeze
 
+	# Default options for advanced burst when it's enabled.
+	DEFAULT_ADVANCED_OPTIONS = {
+		max_packet_length: 24,
+		frequency_hopping: :optional,
+		stall_count: 0,
+		retry_count: 0
+	}
+
 
 	# Loggability API -- set up a logger for the library
 	log_as :ant
@@ -35,6 +43,23 @@ module Ant
 	autoload :DataUtilities, 'ant/mixins'
 
 
+	# Capabilities hash -- set asynchronously by calling Ant.request_capabilities
+	@capabilities = nil
+	singleton_class.attr_reader( :capabilities )
+
+	# Serial number -- set asynchronously by calling Ant.request_serial_num
+	@serial_num = nil
+	singleton_class.attr_reader( :serial_num )
+
+	# Version of ANT supported by the hardware -- set asynchronously by calling
+	# Ant.request_version
+	@hardware_version = nil
+	singleton_class.attr_reader( :hardware_version )
+
+	# Add some convenience aliases
+	singleton_class.alias_method( :is_initialized?, :initialized? )
+
+
 	### Set up the given +object+ as the handler for response callbacks. It must
 	### respond to :handle_response_callback.
 	def self::set_response_handler( object=Ant::ResponseCallbacks )
@@ -126,5 +151,55 @@ module Ant
 		return offset
 	end
 
+
+	### Enable advanced burst mode with the given +options+.
+	def self::enable_advanced_burst( **options )
+		options = DEFAULT_ADVANCED_OPTIONS.merge( options )
+
+		max_packet_length = self.convert_max_packet_length( options[:max_packet_length] )
+
+		required_fields = self.make_required_fields_config( options )
+		optional_fields = self.make_optional_fields_config( options )
+
+		stall_count = options[:stall_count]
+		retry_count = options[:retry_count]
+
+		self.configure_advanced_burst( true, max_packet_length, required_fields, optional_fields,
+			stall_count, retry_count )
+	end
+
+
+	### Validate that the specified +length+ (in bytes) is a valid setting as an
+	### advanced burst max packet length configuration value. Returns the equivalent
+	### configuration value.
+	def self::convert_max_packet_length( length )
+		case length
+		when 8 then return 0x01
+		when 16 then return 0x02
+		when 24 then return 0x03
+		else
+			raise ArgumentError,
+				"invalid max packet length; expected 8, 16, or 24, got %p" % [ length ]
+		end
+	end
+
+
+	### Given an options hash, return a configuration value for required fields.
+	def self::make_required_fields_config( **options )
+		value = 0
+		value |= 0x01 if options[:frequency_hopping] == :required
+
+		return value
+	end
+
+
+	### Given an options hash, return a configuration value for optional fields.
+	def self::make_optional_fields_config( **options )
+		value = 0
+		value |= 0x01 if options[:frequency_hopping] == :optional
+
+		return value
+	end
+
 end # module Ant
 

data/spec/ant_spec.rb

@@ -33,6 +33,15 @@ RSpec.describe( Ant ) do
 	end
 
 
+	it "knows if it's been initialized or not", :hardware do
+		expect( Ant ).to_not be_initialized
+		Ant.init
+		expect( Ant ).to be_initialized
+		Ant.close
+		expect( Ant ).to_not be_initialized
+	end
+
+
 	it "can validate a device number" do
 		expect( described_class.validate_device_number(111) ).to eq( 111 )
 		expect {

data/spec/bitvector_spec.rb

@@ -0,0 +1,141 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+require 'ant/bitvector'
+
+
+RSpec.describe( Ant::BitVector ) do
+
+	context 'when first instantiated' do
+
+		it "is empty when created without arguments" do
+			v = described_class.new
+			expect( v.to_i ).to eq( 0 )
+			expect( v.size ).to eq( 1 )
+		end
+
+
+		it "accepts a decimal argument" do
+			v = described_class.new( 242 )
+			expect( v.to_hex ).to eq( '0x00f2' )
+		end
+
+
+		it "accepts a hexadecimal argument" do
+			v = described_class.new( 0x00f2 )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "accepts a bit string argument" do
+			v = described_class.new( 0b11110010 )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "accepts a different BitVector argument" do
+			v = described_class.new( described_class.new( 242 ) )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "accepts a string argument" do
+			v = described_class.new( "242" )
+			expect( v.to_i ).to eq( 242 )
+		end
+
+
+		it "rejects objects that don't have a 'to_i' method" do
+			expect {
+				described_class.new( Class )
+			}.to raise_error( ArgumentError, /don't know what to do/i )
+		end
+
+	end
+
+
+	context 'after modified with a value' do
+
+		let( :bv ) { described_class.new( 242 ) }
+
+
+		it "can be converted into various formats" do
+			expect( bv.to_int ).to eq( 242 )
+			expect( bv.to_hex ).to eq( '0x00f2' )
+			expect( bv.to_bin ).to eq( '0b11110010' )
+		end
+
+
+		it "knows the size of its own bit string" do
+			expect( bv.size ).to eq( 8 )
+			bv.toggle( 9 )
+			expect( bv.size ).to eq( 10 )
+		end
+
+
+		it "can switch specific bits on and off" do
+			expect( bv.on?( 12 ) ).to be_falsey
+
+			bv.on( 12 )
+			expect( bv[12] ).to be_truthy
+
+			bv.off( 12 )
+			expect( bv.off?( 12 ) ).to be_truthy
+
+			bv[12] = true
+			expect( bv.on?( 12 ) ).to be_truthy
+		end
+
+
+		it "can set bits in a range" do
+			expect( bv[ 8] ).to be_falsey
+			expect( bv[ 9] ).to be_falsey
+			expect( bv[10] ).to be_falsey
+			expect( bv[11] ).to be_falsey
+			expect( bv[12] ).to be_falsey
+
+			bv[8..12] = true
+
+			expect( bv[ 8] ).to be_truthy
+			expect( bv[ 9] ).to be_truthy
+			expect( bv[10] ).to be_truthy
+			expect( bv[11] ).to be_truthy
+			expect( bv[12] ).to be_truthy
+		end
+
+
+		it "delegates math operations to the underlying integer" do
+			bv2 = described_class.new( 4112 )
+
+			bv3 = bv + bv2
+			expect( bv3.to_int ).to eq( 4354 )
+
+			bv3 = bv | bv2
+			expect( bv3.to_int ).to eq( 4338 )
+
+			bv3 = bv & bv2
+			expect( bv3.to_int ).to eq( 16 )
+
+			expect( bv3 ).to be_a( described_class )
+		end
+
+
+		it "can compare different bitvector objects" do
+			bv1 = described_class.new( bv )
+			bv2 = described_class.new( 4112 )
+			expect( bv ).to eq( bv1 )
+			expect( bv ).to be < bv2
+		end
+
+
+		it "is enumerable" do
+			bits = bv.to_a
+			expect( bits ).to eq( [0, 1, 0, 0, 1, 1, 1, 1] )
+		end
+
+	end
+
+end
+

data/spec/spec_helper.rb

@@ -20,6 +20,8 @@ RSpec.configure do |config|
 		Ant.init
 		Ant.close
 	rescue => err
+		$stderr.puts "%p while initializing hardware: %s; disabling hardware specs" %
+			[ err.class, err.message ]
 		config.filter_run_excluding( :hardware )
 	end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ant-wireless
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
   k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -106,6 +106,7 @@ files:
 - ext/ant_ext/version.h
 - lib/ant-wireless.rb
 - lib/ant.rb
+- lib/ant/bitvector.rb
 - lib/ant/channel.rb
 - lib/ant/channel/event_callbacks.rb
 - lib/ant/message.rb
@@ -113,6 +114,7 @@ files:
 - lib/ant/response_callbacks.rb
 - lib/ant/wireless.rb
 - spec/ant_spec.rb
+- spec/bitvector_spec.rb
 - spec/spec_helper.rb
 homepage: https://sr.ht/~ged/ruby-ant-wireless/
 licenses: