OpenedFrameType and OpenedPortType have been removed.

The GetSerialString and GetProductDescription methods in AntUsbRadio have been marked as obsolete.
Overloads in the interfaces have been removed in favor of optional arguments with default values. The GetDeviceCapabilities method may require rework in implementations.

Author: StephenHidem

AntRadioInterface/AntRadioInterface.csproj

@@ -23,7 +23,10 @@
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <PackageIcon>PackageLogo.png</PackageIcon>
     <PackageReadmeFile>readme.md</PackageReadmeFile>
-    <PackageReleaseNotes>OpenedFrameType and OpenedPortType have been removed in this release. The GetSerialString method in IAntUsbRadio is redundant and has been marked as obsolete.</PackageReleaseNotes>
+    <PackageReleaseNotes>
+        OpenedFrameType and OpenedPortType have been removed in this release. The GetSerialString and GetProductDescription methods in IAntUsbRadio have been marked as obsolete.
+        Overloads in the interfaces have been removed in favor of optional arguments with default values. The GetDeviceCapabilities method may require rework in implementations.
+    </PackageReleaseNotes>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">

AntRadioInterface/IAntConfiguration.cs

@@ -34,7 +34,7 @@ public enum LibConfigFlags
         RadioConfigAlways = 0x01,
         /// <summary>The message out inc time stamp</summary>
         MesgOutIncTimeStamp = 0x20,
-        /// <summary>The message out inc rssi</summary>
+        /// <summary>The message out inc RSSI</summary>
         MesgOutIncRssi = 0x40,
         /// <summary>The message out inc device identifier</summary>
         MesgOutIncDeviceId = 0x80,
@@ -48,37 +48,23 @@ public interface IAntConfiguration
         /// <param name="maxPacketLength">Maximum length of the packet.</param>
         /// <param name="requiredFields">The required fields.</param>
         /// <param name="optionalFields">The optional fields.</param>
-        void ConfigureAdvancedBursting(bool enable, byte maxPacketLength, AdvancedBurstConfigFlags requiredFields, AdvancedBurstConfigFlags optionalFields);
-        /// <summary>Configures the advanced bursting.</summary>
-        /// <param name="enable">if set to <c>true</c> [enable].</param>
-        /// <param name="maxPacketLength">Maximum length of the packet.</param>
-        /// <param name="requiredFields">The required fields.</param>
-        /// <param name="optionalFields">The optional fields.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool ConfigureAdvancedBursting(bool enable, byte maxPacketLength, AdvancedBurstConfigFlags requiredFields, AdvancedBurstConfigFlags optionalFields, uint responseWaitTime);
-        /// <summary>Configures the extended advanced bursting.</summary>
-        /// <param name="enable">if set to <c>true</c> [enable].</param>
-        /// <param name="maxPacketLength">Maximum length of the packet.</param>
-        /// <param name="requiredFields">The required fields.</param>
-        /// <param name="optionalFields">The optional fields.</param>
-        /// <param name="stallCount">The stall count.</param>
-        /// <param name="retryCount">The retry count.</param>
-        void ConfigureAdvancedBursting_ext(bool enable, byte maxPacketLength, AdvancedBurstConfigFlags requiredFields, AdvancedBurstConfigFlags optionalFields, ushort stallCount, byte retryCount);
+        bool ConfigureAdvancedBursting(bool enable, byte maxPacketLength, AdvancedBurstConfigFlags requiredFields, AdvancedBurstConfigFlags optionalFields, uint responseWaitTime = 0);
         /// <summary>Configures the extended advanced bursting.</summary>
         /// <param name="enable">if set to <c>true</c> [enable].</param>
         /// <param name="maxPacketLength">Maximum length of the packet.</param>
         /// <param name="requiredFields">The required fields.</param>
         /// <param name="optionalFields">The optional fields.</param>
         /// <param name="stallCount">The stall count.</param>
         /// <param name="retryCount">The retry count.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool ConfigureAdvancedBursting_ext(bool enable, byte maxPacketLength, AdvancedBurstConfigFlags requiredFields, AdvancedBurstConfigFlags optionalFields, ushort stallCount, byte retryCount, uint responseWaitTime);
+        bool ConfigureAdvancedBursting_ext(bool enable, byte maxPacketLength, AdvancedBurstConfigFlags requiredFields, AdvancedBurstConfigFlags optionalFields, ushort stallCount, byte retryCount, uint responseWaitTime = 0);
         /// <summary>Configures the advanced burst splitting.</summary>
         /// <param name="splitBursts">if set to <c>true</c> [split bursts].</param>
         /// <returns>
@@ -89,111 +75,76 @@ public interface IAntConfiguration
         /// <param name="config">The configuration.</param>
         /// <param name="size">The size.</param>
         /// <param name="time">The time.</param>
-        void ConfigureEventBuffer(EventBufferConfig config, ushort size, ushort time);
-        /// <summary>Configures the event buffer.</summary>
-        /// <param name="config">The configuration.</param>
-        /// <param name="size">The size.</param>
-        /// <param name="time">The time.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool ConfigureEventBuffer(EventBufferConfig config, ushort size, ushort time, uint responseWaitTime);
-        /// <summary>Configures the event filter.</summary>
-        /// <param name="eventFilter">The event filter.</param>
-        void ConfigureEventFilter(ushort eventFilter);
+        bool ConfigureEventBuffer(EventBufferConfig config, ushort size, ushort time, uint responseWaitTime = 0);
         /// <summary>Configures the event filter.</summary>
         /// <param name="eventFilter">The event filter.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool ConfigureEventFilter(ushort eventFilter, uint responseWaitTime);
+        bool ConfigureEventFilter(ushort eventFilter, uint responseWaitTime = 0);
         /// <summary>Configures the high duty search.</summary>
         /// <param name="enable">if set to <c>true</c> [enable].</param>
         /// <param name="suppressionCycles">The suppression cycles.</param>
-        void ConfigureHighDutySearch(bool enable, byte suppressionCycles);
-        /// <summary>Configures the high duty search.</summary>
-        /// <param name="enable">if set to <c>true</c> [enable].</param>
-        /// <param name="suppressionCycles">The suppression cycles.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool ConfigureHighDutySearch(bool enable, byte suppressionCycles, uint responseWaitTime);
+        bool ConfigureHighDutySearch(bool enable, byte suppressionCycles, uint responseWaitTime = 0);
         /// <summary>Configures the user NVM.</summary>
         /// <param name="address">The address.</param>
         /// <param name="data">The data.</param>
         /// <param name="size">The size.</param>
-        void ConfigureUserNvm(ushort address, byte[] data, byte size);
-        /// <summary>Configures the user NVM.</summary>
-        /// <param name="address">The address.</param>
-        /// <param name="data">The data.</param>
-        /// <param name="size">The size.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool ConfigureUserNvm(ushort address, byte[] data, byte size, uint responseWaitTime);
+        bool ConfigureUserNvm(ushort address, byte[] data, byte size, uint responseWaitTime = 0);
         /// <summary>Crystal enable.</summary>
-        void CrystalEnable();
-        /// <summary>Crystal enable.</summary>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool CrystalEnable(uint responseWaitTime);
-        /// <summary>Enables the led.</summary>
-        /// <param name="isEnabled">if set to <c>true</c> [is enabled].</param>
-        void EnableLED(bool isEnabled);
-        /// <summary>Enables the led.</summary>
+        bool CrystalEnable(uint responseWaitTime = 0);
+        /// <summary>Enables the LED.</summary>
         /// <param name="isEnabled">if set to <c>true</c> [is enabled].</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool EnableLED(bool isEnabled, uint responseWaitTime);
+        bool EnableLED(bool isEnabled, uint responseWaitTime = 0);
         /// <summary>Enables Rx extended messages.</summary>
         /// <param name="isEnabled">if set to <c>true</c> [is enabled].</param>
-        void EnableRxExtendedMessages(bool isEnabled);
-        /// <summary>Enables Rx extended messages.</summary>
-        /// <param name="isEnabled">if set to <c>true</c> [is enabled].</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool EnableRxExtendedMessages(bool isEnabled, uint responseWaitTime);
+        bool EnableRxExtendedMessages(bool isEnabled, uint responseWaitTime = 0);
         /// <summary>Sets the library configuration.</summary>
         /// <param name="libConfigFlags">The library configuration flags.</param>
-        void SetLibConfig(LibConfigFlags libConfigFlags);
-        /// <summary>Sets the library configuration.</summary>
-        /// <param name="libConfigFlags">The library configuration flags.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool SetLibConfig(LibConfigFlags libConfigFlags, uint responseWaitTime);
+        bool SetLibConfig(LibConfigFlags libConfigFlags, uint responseWaitTime = 0);
         /// <summary>Sets the network key.</summary>
         /// <param name="netNumber">The network number.</param>
         /// <param name="networkKey">The network key.</param>
-        void SetNetworkKey(byte netNumber, byte[] networkKey);
-        /// <summary>Sets the network key.</summary>
-        /// <param name="netNumber">The network number.</param>
-        /// <param name="networkKey">The network key.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool SetNetworkKey(byte netNumber, byte[] networkKey, uint responseWaitTime);
-        /// <summary>Sets the transmit power for all channels.</summary>
-        /// <param name="transmitPower">The transmit power.</param>
-        void SetTransmitPowerForAllChannels(TransmitPower transmitPower);
+        bool SetNetworkKey(byte netNumber, byte[] networkKey, uint responseWaitTime = 0);
         /// <summary>Sets the transmit power for all channels.</summary>
         /// <param name="transmitPower">The transmit power.</param>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool SetTransmitPowerForAllChannels(TransmitPower transmitPower, uint responseWaitTime);
+        bool SetTransmitPowerForAllChannels(TransmitPower transmitPower, uint responseWaitTime = 0);
     }
 }

AntRadioInterface/IAntControl.cs

@@ -5,30 +5,17 @@ public interface IAntControl
     {
         /// <summary>Open channel 0 in continuous scan mode. Channel 0 should have been
         /// previously assigned and configured as a slave receive channel.</summary>
-        void OpenRxScanMode();
-        /// <summary>Open channel 0 in continuous scan mode. Channel 0 should have been
-        /// previously assigned and configured as a slave receive channel.</summary>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 0ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
-        bool OpenRxScanMode(uint responseWaitTime);
+        bool OpenRxScanMode(uint responseWaitTime = 0);
         /// <summary>This message is sent to the ANT radio to request specific information from the radio.</summary>
-        /// <param name="channelNum">The channel number.</param>
         /// <param name="messageID">The message identifier.</param>
-        void RequestMessage(byte channelNum, RequestMessageID messageID);
-        /// <summary>This message is sent to the ANT radio to request specific information from the radio.</summary>
-        /// <param name="messageID">The message identifier.</param>
-        void RequestMessage(RequestMessageID messageID);
-        /// <summary>Resets the ANT radio.</summary>
-        /// <remarks>
-        /// Execution of this command terminates all channels.All information previously configured
-        /// in the system can no longer be considered valid. The application should wait 500ms before any
-        /// further commands are issued from the host.
-        /// </remarks>
-        void ResetSystem();
+        /// <param name="channelNum">The channel number. The default channel is 0.</param>
+        void RequestMessage(RequestMessageID messageID, byte channelNum = 0);
         /// <summary>Resets the ANT radio.</summary>
-        /// <param name="responseWaitTime">The response wait time.</param>
+        /// <param name="responseWaitTime">The response wait time in milliseconds. The default is 500ms.</param>
         /// <returns>
         /// true if successful
         /// </returns>
@@ -37,6 +24,6 @@ public interface IAntControl
         /// in the system can no longer be considered valid. The application should wait 500ms before any
         /// further commands are issued from the host.
         /// </remarks>
-        bool ResetSystem(uint responseWaitTime);
+        bool ResetSystem(uint responseWaitTime = 500);
     }
 }