ant-wireless 0.1.0 → 0.4.0

data/lib/ant/bitvector.rb

@@ -0,0 +1,197 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+# vim: set nosta noet ts=4 sw=4:
+
+require 'ant' unless defined?( Ant )
+
+# Ant::BitVector -- a convenience class for manipulating and
+# comparing bit vectors.
+#
+# This is a slightly-modified version of the same utility in StaticCling.
+#
+# == Synopsis
+#
+#   require 'ant/bitvector'
+#
+#   vector = Ant::BitVector.new
+#
+#   vector.on( 4 )     # => 16
+#   vector.on( 12 )    # => 4112
+#   vector.toggle( 4 ) # => 4096
+#   vector.on?( 4 )    # => false
+#   vector.size        # => 13
+#   vector.to_hex      # => 0x1000
+#
+#   vector2 = Ant::BitVector.new( 5 )
+#   vector > vector2   # => true
+#
+#   vector2.each_with_index do |bit, i|
+#		puts "Bit %d is %s" % [ i + 1, bit.zero? ? 'off' : 'on' ]
+#	end
+#
+#		Bit 1 is on
+#		Bit 2 is off
+#		Bit 3 is on
+#
+# == Version
+#
+#  $Id$
+#
+# == Author
+#
+# * Mahlon E. Smith <mahlon@martini.nu>
+#
+# == License
+#
+# Copyright (c) 2000-2013, Mahlon E. Smith <mahlon@martini.nu>
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#     * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#     * Neither the name of the author, nor the names of contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+class Ant::BitVector
+	include Enumerable,
+		Comparable
+
+	### Create a new bit vector object, optionally from a pre-existing
+	### +init+ number (Any number that ruby supports natively should be
+	### fine -- 0b, 0x, or decimal.)
+	def initialize( init=0 )
+		unless init.respond_to?( :to_i )
+			raise ArgumentError, "I don't know what to do with a %s object." % [ init.class.name ]
+		end
+
+		@bv = init.to_i
+	end
+
+
+	######
+	public
+	######
+
+	# let any additional methods fall through to Fixnum/Bignum objs,
+	# and return new vector objects.  This allows for doing bitwise math
+	# or simple addition/subtraction on two BitVector objects.
+	%w{ % & * ** + - / << >> ^ | ~ }.each do |op|
+		define_method( op.to_sym ) do |arg|
+			res = @bv.send( op.to_sym, arg.bv )
+			return self.class.new( res )
+		end
+	end
+
+
+	##
+	# Allow external access to the underlying Fixnum/Bignum
+	attr_reader :bv
+
+
+	### Return the bit vector as a decimal.
+	def to_i
+		return @bv
+	end
+	alias_method :to_int, :to_i
+	alias_method :to_dec, :to_i
+
+
+	### Return the bit vector as a binary string.
+	def to_bin
+		return "0b%s" % @bv.to_s(2)
+	end
+
+
+	### Return the bit vector as a hexidecimal string.
+	def to_hex
+		return "0x%04x" % @bv
+	end
+
+
+	### Return the length of the vector in bytes.
+	def size
+		return @bv.to_s(2).length
+	end
+
+
+	### Switch a +bit+ on.
+	def on( bit )
+		@bv = @bv | ( 1 << bit )
+	end
+
+
+	### Return boolean true if given +bit+ is currently on.
+	def on?( bit )
+		return @bv[ bit ].zero? ? false : true
+	end
+	alias_method :[], :on?
+
+
+	### Switch a +bit+ off.
+	def off( bit )
+		@bv = @bv & ~( 1 << bit )
+	end
+
+
+	### Return boolean true if given +bit+ is currently +off+.
+	def off?( bit )
+		return ! self.on?( bit )
+	end
+
+
+	### Swap the current state of the given +bit+.
+	def toggle( bit )
+		@bv = @bv ^ ( 1 << bit )
+	end
+	alias_method :flip, :toggle
+
+
+	### Set a +bit+ to +bool+ -- either true (on) or false (off).
+	### Any value other than nil or false is treated as true.
+	### This form also accepts ranges of bits, a la: vector[ 1..4 ] = true
+	def []=( bit, bool )
+		if bit.respond_to?( :each )
+			bit.each { |b| bool ? self.on( b ) : self.off( b ) }
+		else
+			bool ? self.on( bit ) : self.off( bit )
+		end
+	end
+
+
+	### Yield each binary position, least significant +bit+ first.
+	def each
+		@bv.to_s(2).reverse.each_byte do |bit|
+			yield bit.chr.to_i
+		end
+	end
+
+
+	### Comparision operator for Comparable mixin, fallthrough to
+	### Fixnum/Bignum.  Compares current state against +cmp+.
+	def <=>( cmp )
+		@bv <=> cmp.bv
+	end
+
+end # class Ant::BitVector
+

data/lib/ant/channel/event_callbacks.rb

@@ -13,8 +13,8 @@ require 'ant/mixins'
 # Refs:
 # * 9.5.6.1 Channel Response / Event (0x40) [ANT Message Protocol and Usage, Rev 5.1]
 module Ant::Channel::EventCallbacks
-	extend Loggability
-	include Ant::DataUtilities
+	extend Loggability,
+		Ant::DataUtilities
 
 
 	# Mapping of response message IDs to handler methods
@@ -62,13 +62,9 @@ module Ant::Channel::EventCallbacks
 	end
 
 
-	###############
-	module_function
-	###############
-
 	### Default callback hook -- handles event callbacks.
 	def handle_event_callback( channel_num, event_id, data )
-		handler_method = HANDLER_METHODS[ event_id ] or
+		handler_method = Ant::Channel::EventCallbacks::HANDLER_METHODS[ event_id ] or
 			raise "Unhandled channel event %p" % [ event_id ]
 
 		if self.respond_to?( handler_method )
@@ -81,10 +77,10 @@ module Ant::Channel::EventCallbacks
 
 	### Handle an TX event.
 	def on_event_tx( channel_num, data )
-		# self.log.info "Broadcast message on channel %d was transmitted." % [ channel_num ]
-		data = SecureRandom.bytes( 8 )
-		self.log.info "Sending our own broadcast data: \n%s" % [ hexdump(data) ]
-		self.send_broadcast_data( data )
+		channel = Ant::Channel.registry[ channel_num ]
+		self.log.debug "%p ready for transmission." % [ channel ]
+		ident = [ 1, 33 ].pack( "CC" )
+		channel.send_broadcast_data( ident )
 	end
 
 
@@ -148,7 +144,7 @@ module Ant::Channel::EventCallbacks
 			usDeviceNumber     = data.bytes[10] | (data.bytes[11] << 8)
 			ucDeviceType       = data.bytes[12]
 			ucTransmissionType = data.bytes[13]
-			self.log.info "Got an acknowledge on Chan ID(%d/%d/%d)" %
+			self.log.debug "Got an acknowledge on Chan ID(%d/%d/%d)" %
 				[usDeviceNumber, ucDeviceType, ucTransmissionType]
 		end
 
@@ -162,7 +158,7 @@ module Ant::Channel::EventCallbacks
 			usDeviceNumber     = data.bytes[10] | (data.bytes[11] << 8)
 			ucDeviceType       = data.bytes[12]
 			ucTransmissionType = data.bytes[13]
-			self.log.info "Got a burst on Chan ID(%d/%d/%d)" %
+			self.log.debug "Got a burst on Chan ID(%d/%d/%d)" %
 				[usDeviceNumber, ucDeviceType, ucTransmissionType]
 		end
 
@@ -176,7 +172,7 @@ module Ant::Channel::EventCallbacks
 			usDeviceNumber     = data.bytes[10] | (data.bytes[11] << 8)
 			ucDeviceType       = data.bytes[12]
 			ucTransmissionType = data.bytes[13]
-			self.log.info "Got a broadcast on Chan ID(%d/%d/%d)" %
+			self.log.debug "Got a broadcast on Chan ID(%d/%d/%d)" %
 				[usDeviceNumber, ucDeviceType, ucTransmissionType]
 		end
 
@@ -185,7 +181,7 @@ module Ant::Channel::EventCallbacks
 
 
 	def on_event_rx_acknowledged( channel_num, data )
-		self.log.info "Acknowledged: Rx:\n%s" % [ hexdump(data[1..9]) ]
+		self.log.debug "Acknowledged: Rx [%d]:\n%s" % [ data.bytes[0], Ant::DataUtilities.hexdump(data[1..9]) ]
 	end
 
 
@@ -193,12 +189,12 @@ module Ant::Channel::EventCallbacks
 		channel = (data.bytes[0] & CHANNEL_NUMBER_MASK) >> 5
 		sequence_num = data.bytes[0] & SEQUENCE_NUMBER_MASK
 
-		self.log.info "Burst (0x%02x): Rx: %d:\n%s" % [ channel, sequence_num, hexdump(data[1..9]) ]
+		self.log.debug "Burst (0x%02x): Rx: %d:\n%s" % [ channel, sequence_num, Ant::DataUtilities.hexdump(data[1..9]) ]
 	end
 
 
 	def on_event_rx_broadcast( channel_num, data )
-		self.log.info "Broadcast: Rx:\n%s" % [ hexdump(data[1..9]) ]
+		self.log.debug "Broadcast: Rx [%d]:\n%s" % [ data.bytes[0], Ant::DataUtilities.hexdump(data[1..9]) ]
 	end
 
 

data/lib/ant/channel.rb

@@ -9,6 +9,7 @@ require 'ant' unless defined?( Ant )
 class Ant::Channel
 	extend Loggability
 
+
 	# The default network number
 	DEFAULT_NETWORK_NUMBER = 0
 
@@ -20,7 +21,8 @@ class Ant::Channel
 	# Autoloads
 	#
 
-	autoload :EventCallbacks, 'ant/channel/event_callbacks'
+	require 'ant/channel/event_callbacks'
+	include Ant::Channel::EventCallbacks
 
 
 	# Loggability API -- log to the Ant logger
@@ -44,23 +46,68 @@ class Ant::Channel
 
 
 	### Set up the given +mod+ as the handler module for channel events.
-	def set_event_handlers( object=Ant::Channel::EventCallbacks )
+	def set_event_handlers( object=self )
 		self.on_event( &object.method(:handle_event_callback) )
 	end
 
 
+	### Return the ANT channel ID if one has been assigned.
+	def channel_id
+		device_number     = self.device_number or return nil
+		device_type       = self.device_type & 0x7f
+		pairing_bit       = self.device_type & 0x80
+		transmission_type = self.transmission_type
+
+		return "%d/%d/%d%s" % [
+			device_number,
+			device_type,
+			transmission_type,
+			pairing_bit.nonzero? ? '+' : '',
+		]
+	end
+
+
+	### Return a human-readable description of the channel type.
+	def channel_type_description
+		case self.channel_type
+		when Ant::PARAMETER_RX_NOT_TX
+			return :slave
+		when Ant::PARAMETER_TX_NOT_RX
+			return :master
+		when Ant::PARAMETER_SHARED_CHANNEL
+			return :shared
+		when Ant::PARAMETER_NO_TX_GUARD_BAND
+			return :no_tx_guard_band
+		when Ant::PARAMETER_ALWAYS_RX_WILD_CARD_SEARCH_ID
+			return :always_rx_wild_card_search_id
+		when Ant::PARAMETER_RX_ONLY
+			return :rx_only
+		else
+			return nil
+		end
+	end
+
+
+	### Returns +true+ if the channel is not closed.
+	def open?
+		return !self.closed?
+	end
+
+
 	### Return a human-readable version of the object suitable for debugging.
 	def inspect
-		return "#<%p:%#x {%d} %#02x on network %d: %d%s>" % [
+		return "#<%p:%#x %s {%s} #%d @%dMHz on network %d%s>" % [
 			self.class,
 			self.object_id,
+			self.channel_type_description,
+			self.channel_id || '-',
 			self.channel_number,
-			self.channel_type,
+			self.rf_frequency + 2400,
 			self.network_number,
-			self.extended_options,
 			self.closed? ? " (closed)" : "",
 		]
 	end
 
 end # class Ant::Channel
 
+