ant-wireless 0.1.0.pre.20210715102740 → 0.2.1

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
@@ -64,7 +64,7 @@ module Ant::Channel::EventCallbacks
 
 	### 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 )
@@ -77,11 +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.debug "Sending our own broadcast data: %p." % [ 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
 
 
@@ -139,18 +138,27 @@ module Ant::Channel::EventCallbacks
 	end
 
 
-	# def on_event_rx_flag_acknowledged( channel_num, data )
-	#
-	# end
+	def on_event_rx_flag_acknowledged( channel_num, data )
+		flags = data.bytes[ 9 ]
+		if flags & Ant::ANT_EXT_MESG_BITFIELD_DEVICE_ID
+			usDeviceNumber     = data.bytes[10] | (data.bytes[11] << 8)
+			ucDeviceType       = data.bytes[12]
+			ucTransmissionType = data.bytes[13]
+			self.log.debug "Got an acknowledge on Chan ID(%d/%d/%d)" %
+				[usDeviceNumber, ucDeviceType, ucTransmissionType]
+		end
+
+		self.on_event_rx_acknowledged( channel_num, data )
+	end
+
 
-	### Handle an RX_FLAG_BURST_PACKET event.
 	def on_event_rx_flag_burst_packet( channel_num, data )
 		flags = data.bytes[ 9 ]
 		if flags & Ant::ANT_EXT_MESG_BITFIELD_DEVICE_ID
 			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
 
@@ -158,14 +166,13 @@ module Ant::Channel::EventCallbacks
 	end
 
 
-	### Handle an RX_FLAG_BROADCAST event.
 	def on_event_rx_flag_broadcast( channel_num, data )
 		flags = data.bytes[ 9 ]
 		if flags & Ant::ANT_EXT_MESG_BITFIELD_DEVICE_ID
 			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
 
@@ -173,23 +180,21 @@ module Ant::Channel::EventCallbacks
 	end
 
 
-	# def on_event_rx_acknowledged( channel_num, data )
-	#
-	# end
+	def on_event_rx_acknowledged( channel_num, data )
+		self.log.debug "Acknowledged: Rx [%d]:\n%s" % [ data.bytes[0], Ant::DataUtilities.hexdump(data[1..9]) ]
+	end
 
 
-	### Handle an RX_BURST_PACKET event.
 	def on_event_rx_burst_packet( channel_num, data )
 		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..8]) ]
+		self.log.debug "Burst (0x%02x): Rx: %d:\n%s" % [ channel, sequence_num, Ant::DataUtilities.hexdump(data[1..9]) ]
 	end
 
 
-	### Handle an RX_BROADCAST event.
 	def on_event_rx_broadcast( channel_num, data )
-		self.log.info "Broadcast: Rx:\n%s" % [ hexdump(data[1..8]) ]
+		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,24 +46,68 @@ class Ant::Channel
 
 
 	### Set up the given +mod+ as the handler module for channel events.
-	def set_event_handlers( mod=Ant::Channel::EventCallbacks )
-		self.extend( mod )
-		self.on_event( &self.method(:handle_event_callback) )
+	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
 
+