ant-wireless 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abd16b62c0eb3b3e7e683fd46cca0382fa6b0400f23d8ae8a12de4455e66599a
-  data.tar.gz: c0e7b0571d2cb8285f072b23027b226ac4c472e0b2147faa34c1bd13d4c78aef
+  metadata.gz: b16333eed832c3068cd6e95d167bffe8132aaba7543ccabd773d809fac840199
+  data.tar.gz: 92d089d1bcf5121dd46477befeabc33e43abbac10de105d3d94d176b54c9af8a
 SHA512:
-  metadata.gz: 994058a2faa922f5d5469b9ab04aa5eecefaa6fdac4921a035a9bfe4f0ca58bea90a32f225c54d695f93b5cc27bcaf87ce2442b80160984944e7a04234eb0036
-  data.tar.gz: 11f91861b51651d3cfba2309334ac4e9253a4ea9bc313bd0434f42eaa4a86e05d3659b11cfed13a85b162761b1913afb2da13d99faf58f1b14cf53b52fb03da3
+  metadata.gz: 51dbc06b6c199f16404fb0d79fd78e10cf53c4ca68e221462d225e1dff171a51f5f1807da2ebe2719e45109e981ece26781090ebd583d4c8c01d6e1539c5e43a
+  data.tar.gz: da1492d614d52e83402c85bbeed0d45d03f7f101bd6b5036ae9bc7a488dfbd5df41ee5aa2a0a3b0a7b4e7019c4d95bc55d0167a3a6e77c1825565ca299ba492e

data/History.md

@@ -1,6 +1,14 @@
 # Release History for ruby-ant
 
 ---
+## v0.3.0 [2021-10-11] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add frequency agility config to Channel
+- Add tunable transmit power knob
+
+
 ## v0.2.1 [2021-09-30] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes:

data/ext/ant_ext/ant_ext.c

@@ -309,6 +309,32 @@ rant_s_set_network_key( VALUE _module, VALUE network_number, VALUE key )
 }
 
 
+/*
+ * call-seq:
+ *    Ant.transmit_power = 4
+ *
+ * Set the transmit power level for all channels. Valid values are 0-4; default
+ * is 3 = 0dBm.
+ *
+ *    # Set transmit power to -5 dBm
+ *    Ant.transmit_power = 2
+ */
+static VALUE
+rant_s_transmit_power_eq( VALUE _module, VALUE power )
+{
+	const unsigned char ucTransmitPower = NUM2CHR( power );
+	BOOL rval;
+
+	if ( ucTransmitPower < 0 || ucTransmitPower > 4 ) {
+		rb_raise( rb_eArgError, "expected a value between 0 and 4, got %d", ucTransmitPower );
+	}
+
+	rval = ANT_SetTransmitPower( ucTransmitPower );
+
+	return rval ? Qtrue : Qfalse;
+}
+
+
 /*
  * call-seq:
  *    Ant.assign_channel( channel, channel_type, network_number=0, extended_options=0x0, timeout=0 )   -> channel
@@ -575,6 +601,7 @@ Init_ant_ext()
 	rb_define_singleton_method( rant_mAnt, "reset", rant_s_reset, 0 );
 
 	rb_define_singleton_method( rant_mAnt, "set_network_key", rant_s_set_network_key, 2 );
+	rb_define_singleton_method( rant_mAnt, "transmit_power=", rant_s_transmit_power_eq, 1 );
 	rb_define_singleton_method( rant_mAnt, "assign_channel", rant_s_assign_channel, -1 );
 
 	rb_define_singleton_method( rant_mAnt, "use_extended_messages=",

data/ext/ant_ext/channel.c

@@ -132,6 +132,7 @@ rant_channel_init( VALUE self, VALUE channel_number, VALUE channel_type, VALUE n
 	rb_iv_set( self, "@device_number", Qnil );
 	rb_iv_set( self, "@transmission_type", Qnil );
 	rb_iv_set( self, "@rf_frequency", Qnil );
+	rb_iv_set( self, "@agility_frequencies", Qnil );
 
 	rb_hash_aset( registry, channel_number, self );
 
@@ -299,6 +300,31 @@ rant_channel_set_channel_rf_freq( VALUE self, VALUE frequency )
 }
 
 
+static VALUE
+rant_channet_set_frequency_agility( VALUE self, VALUE freq1, VALUE freq2, VALUE freq3 )
+{
+	rant_channel_t *ptr = rant_get_channel( self );
+	unsigned char ucFreq1 = NUM2CHR( freq1 ),
+		ucFreq2 = NUM2CHR( freq2 ),
+		ucFreq3 = NUM2CHR( freq3 );
+	VALUE frequencies = rb_ary_new_from_args( 3, freq1, freq2, freq3 );
+
+	if ( ucFreq1 > 124 || ucFreq2 > 124 || ucFreq3 > 124 ) {
+		rb_raise( rb_eArgError, "frequencies must be between 0 and 124." );
+	}
+
+	rant_log_obj( self, "info",
+		"Configuring channel %d to use frequency agility on %d, %d, and %d MHz.",
+		ptr->channel_num, ucFreq1 + 2400, ucFreq2 + 2400, ucFreq3 + 2400 );
+	ANT_ConfigFrequencyAgility( ptr->channel_num, ucFreq1, ucFreq2, ucFreq3 );
+
+	rb_ary_freeze( frequencies );
+	rb_iv_set( self, "@agility_frequencies", frequencies );
+
+	return Qtrue;
+}
+
+
 
 
 /*
@@ -588,12 +614,14 @@ init_ant_channel()
 	rb_attr( rant_cAntChannel, rb_intern("device_type"), 1, 0, 0 );
 	rb_attr( rant_cAntChannel, rb_intern("transmission_type"), 1, 0, 0 );
 	rb_attr( rant_cAntChannel, rb_intern("rf_frequency"), 1, 0, 0 );
+	rb_attr( rant_cAntChannel, rb_intern("agility_frequencies"), 1, 0, 0 );
 
 	rb_define_method( rant_cAntChannel, "set_channel_id", rant_channel_set_channel_id, -1 );
 	rb_define_method( rant_cAntChannel, "set_channel_period", rant_channel_set_channel_period, -1 );
 	rb_define_method( rant_cAntChannel, "set_channel_search_timeout",
 		rant_channel_set_channel_search_timeout, -1 );
 	rb_define_method( rant_cAntChannel, "set_channel_rf_freq", rant_channel_set_channel_rf_freq, 1 );
+	rb_define_method( rant_cAntChannel, "set_frequency_agility", rant_channet_set_frequency_agility, 3 );
 
 	rb_define_method( rant_cAntChannel, "open", rant_channel_open, -1 );
 	rb_define_method( rant_cAntChannel, "close", rant_channel_close, -1 );

data/lib/ant/response_callbacks.rb

@@ -48,6 +48,8 @@ module Ant::ResponseCallbacks
 
 		Ant::Message::MESG_RADIO_TX_POWER_ID            => :on_radio_tx_power,
 
+		Ant::Message::MESG_AUTO_FREQ_CONFIG_ID          => :on_auto_freq_config,
+
 		# :TODO: There are many other MESG_ constants, but I think most or all of
 		# them are for the serial protocol.
 	}
@@ -227,6 +229,13 @@ module Ant::ResponseCallbacks
 	end
 
 
+	### Handle on_rx_ext_mesgs_enable response event.
+	def on_auto_freq_config( channel_num, data )
+		self.log_response_event( channel_num, data, "enabling frequency agility",
+			"Enabled frequency agility." )
+	end
+
+
 	### Handle capabilities response event.
 	def on_capabilities( channel_num, data )
 		std_opts  = Ant::BitVector.new( data.bytes[2] )

data/lib/ant.rb

@@ -12,7 +12,7 @@ module Ant
 	extend Loggability
 
 	# Package version
-	VERSION = '0.2.1'
+	VERSION = '0.3.0'
 
 	# A Range for matching valid ANT device numbers
 	VALID_DEVICE_NUMBERS = ( 0...65535 ).freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ant-wireless
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
   k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler