Skip to content

Commit b4fc03a

Browse files
committed
Updating documentation and fix some spelling errors.
1 parent 9f42a3d commit b4fc03a

File tree

64 files changed

+159
-94
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+159
-94
lines changed

AntPlus/DeviceProfiles/AssetTracker/Asset.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public enum AssetStatus
8888
/// Gets the color of the asset. This is an 8 bit RGB value.
8989
/// </summary>
9090
/// <value>
91-
/// The color. Uses the 3-3-2 bit RGB colour palette.
91+
/// The color. Uses the 3-3-2 bit RGB color palette.
9292
/// </value>
9393
public byte Color { get; private set; }
9494
/// <summary>Gets the distance.</summary>

AntPlus/DeviceProfiles/AssetTracker/Tracker.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,10 @@ public override void Parse(byte[] dataPage)
6969
asset.ParseLocation1(dataPage);
7070
if (asset.Status.HasFlag(Asset.AssetStatus.RemoveAsset))
7171
{
72-
Assets.Remove(asset);
72+
lock (Assets.CollectionLock)
73+
{
74+
Assets.Remove(asset);
75+
}
7376
}
7477
break;
7578
case DataPage.AssetLocation2:

AntPlus/DeviceProfiles/BicyclePower/MeasurementCollection.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace SmallEarthTech.AntPlus.DeviceProfiles.BicyclePower
55
{
66
/// <summary>
7-
/// A thread safe collection of measurments reported during calibration.
7+
/// A thread safe collection of measurements reported during calibration.
88
/// </summary>
99
public class MeasurementCollection : ObservableCollection<MeasurementOutputData>
1010
{

AntPlus/DeviceProfiles/BicyclePower/TorqueEffectivenessAndPedalSmoothness.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public class TorqueEffectivenessAndPedalSmoothness : INotifyPropertyChanged
2424

2525
/// <summary>
2626
/// Parses the torque effectiveness and pedal smoothness data page.
27-
/// Note that if the right and left pedal smootness is combined, the right and left values will be the same.
27+
/// Note that if the right and left pedal smoothness is combined, the right and left values will be the same.
2828
/// </summary>
2929
/// <param name="dataPage">The data page.</param>
3030
public void Parse(byte[] dataPage)

AntPlus/DeviceProfiles/FitnessEquipment/Climber.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public enum CapabilityFlags
2323

2424
/// <summary>Gets the stride cycles. Accumulated value of the complete number of stride cycles (i.e. number of steps climbed/2)</summary>
2525
public int StrideCycles { get; private set; }
26-
/// <summary>Gets the cadence in stride cycles per minuter.</summary>
26+
/// <summary>Gets the cadence in stride cycles per minute.</summary>
2727
public byte Cadence { get; private set; }
2828
/// <summary>Gets the instantaneous power in watts.</summary>
2929
public int InstantaneousPower { get; private set; }

AntPlus/DeviceProfiles/Geocache.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ public async Task<MessagingReturnCode> UpdateLoggedVisits()
271271
/// <param name="longitude">The longitude in decimal degrees.</param>
272272
/// <param name="hint">The next stage hint or message.</param>
273273
/// <returns>Status of the request. See <see cref="MessagingReturnCode"/>.</returns>
274-
public MessagingReturnCode ProgramGeocache(string id, uint? pin, double? latitude, double? longitude, string hint)
274+
public async Task<MessagingReturnCode> ProgramGeocache(string id, uint? pin, double? latitude, double? longitude, string hint)
275275
{
276276
programmingGeocache = true;
277277
byte page = 1; // initial page number for optional pages
@@ -352,7 +352,7 @@ public MessagingReturnCode ProgramGeocache(string id, uint? pin, double? latitud
352352
MessagingReturnCode returnCode = MessagingReturnCode.Pass;
353353
foreach (byte[] msg in messages)
354354
{
355-
returnCode = SendExtAcknowledgedMessage(msg, 16000).Result;
355+
returnCode = await SendExtAcknowledgedMessage(msg, 16000);
356356
if (returnCode != MessagingReturnCode.Pass)
357357
{
358358
break;

AntRadioInterface/IAntRadio.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ public enum ResponseMsgId : byte
119119
InvalidScanTxChannels = 0x31,
120120
/// <summary>The invalid parameter</summary>
121121
InvalidParameter = 0x33,
122-
/// <summary>The encrypt negotiation succes</summary>
123-
EncryptNegotiationSucces = 0x38,
122+
/// <summary>The encrypt negotiation success</summary>
123+
EncryptNegotiationSuccess = 0x38,
124124
/// <summary>The encrypt negotiation failed</summary>
125125
EncryptNegotiationFail = 0x39,
126126
/// <summary>The NVM full error</summary>

AntRadioInterface/IAntUsbRadio.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public interface IAntUsbRadio
1919
/// <returns>The vendor ID of this device.</returns>
2020
ushort GetVID();
2121

22-
/// <summary>Gets the USB device droduct description.</summary>
22+
/// <summary>Gets the USB device product description.</summary>
2323
/// <returns>The USB product string of this device.</returns>
2424
string GetProductDescription();
2525

Documentation/Content/VersionHistory/VersionHistory.aml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ life of the project.</para>
2020
<link xlink:href="47871b73-83b7-4cf4-8842-44d7520804aa" />
2121
</para>
2222
</listItem>
23+
<listItem>
24+
<para>
25+
<link xlink:href="07393f6f-e5a8-47d3-bbcc-6c6dd391afb9" />
26+
</para>
27+
</listItem>
2328

2429
<!--<listItem>
2530
<para>[TODO: Add links to each specific version page]</para>
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="07393f6f-e5a8-47d3-bbcc-6c6dd391afb9" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<para>Version 2.1.0.0 was released on July 29, 2023.</para>
6+
</introduction>
7+
<section>
8+
<title>Breaking Changes in This Release</title>
9+
<content>
10+
<list class="bullet">
11+
<listItem>
12+
<para>Refactored class library and examples to use async/await.</para>
13+
</listItem>
14+
<listItem>
15+
<para>Removed MessageRate property from geocache.</para>
16+
</listItem>
17+
<listItem>
18+
<para>Changed AntUsbStick target platform to x86.</para>
19+
</listItem>
20+
<listItem>
21+
<para>Code clean up, tweaks, and logging updates.</para>
22+
</listItem>
23+
</list>
24+
</content>
25+
</section>
26+
<relatedTopics>
27+
<link xlink:href="4a8ae1c2-5d9b-4e27-bd18-34b479401b65" />
28+
</relatedTopics>
29+
</developerConceptualDocument>
30+
</topic>

0 commit comments

Comments
 (0)