Skip to content

Commit b537ced

Browse files
bruno-f-cruzbruno-f-cruz
committed
Favor "PulseWidth" instead of "PulseDuration"
1 parent c78974f commit b537ced

4 files changed

Lines changed: 44 additions & 44 deletions

File tree

‎Interface/Harp.LoadCells/AsyncDevice.Generated.cs‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -234,39 +234,39 @@ public async Task WriteDO0ModeAsync(DO0ModeConfig value)
234234
}
235235

236236
/// <summary>
237-
/// Asynchronously reads the contents of the DO0PulseDuration register.
237+
/// Asynchronously reads the contents of the DO0PulseWidth register.
238238
/// </summary>
239239
/// <returns>
240240
/// A task that represents the asynchronous read operation. The <see cref="Task{TResult}.Result"/>
241241
/// property contains the register payload.
242242
/// </returns>
243-
public async Task<byte> ReadDO0PulseDurationAsync()
243+
public async Task<byte> ReadDO0PulseWidthAsync()
244244
{
245-
var reply = await CommandAsync(HarpCommand.ReadByte(DO0PulseDuration.Address));
246-
return DO0PulseDuration.GetPayload(reply);
245+
var reply = await CommandAsync(HarpCommand.ReadByte(DO0PulseWidth.Address));
246+
return DO0PulseWidth.GetPayload(reply);
247247
}
248248

249249
/// <summary>
250-
/// Asynchronously reads the timestamped contents of the DO0PulseDuration register.
250+
/// Asynchronously reads the timestamped contents of the DO0PulseWidth register.
251251
/// </summary>
252252
/// <returns>
253253
/// A task that represents the asynchronous read operation. The <see cref="Task{TResult}.Result"/>
254254
/// property contains the timestamped register payload.
255255
/// </returns>
256-
public async Task<Timestamped<byte>> ReadTimestampedDO0PulseDurationAsync()
256+
public async Task<Timestamped<byte>> ReadTimestampedDO0PulseWidthAsync()
257257
{
258-
var reply = await CommandAsync(HarpCommand.ReadByte(DO0PulseDuration.Address));
259-
return DO0PulseDuration.GetTimestampedPayload(reply);
258+
var reply = await CommandAsync(HarpCommand.ReadByte(DO0PulseWidth.Address));
259+
return DO0PulseWidth.GetTimestampedPayload(reply);
260260
}
261261

262262
/// <summary>
263-
/// Asynchronously writes a value to the DO0PulseDuration register.
263+
/// Asynchronously writes a value to the DO0PulseWidth register.
264264
/// </summary>
265265
/// <param name="value">The value to be stored in the register.</param>
266266
/// <returns>The task object representing the asynchronous write operation.</returns>
267-
public async Task WriteDO0PulseDurationAsync(byte value)
267+
public async Task WriteDO0PulseWidthAsync(byte value)
268268
{
269-
var request = DO0PulseDuration.FromPayload(MessageType.Write, value);
269+
var request = DO0PulseWidth.FromPayload(MessageType.Write, value);
270270
await CommandAsync(request);
271271
}
272272

‎Interface/Harp.LoadCells/Device.Generated.cs‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public Device() : base(WhoAmI) { }
4343
{ 35, typeof(DO0) },
4444
{ 39, typeof(DI0Mode) },
4545
{ 40, typeof(DO0Mode) },
46-
{ 41, typeof(DO0PulseDuration) },
46+
{ 41, typeof(DO0PulseWidth) },
4747
{ 42, typeof(DOSet) },
4848
{ 43, typeof(DOClear) },
4949
{ 44, typeof(DOToggle) },
@@ -123,7 +123,7 @@ public override IObservable<IGroupedObservable<Type, HarpMessage>> Process(IObse
123123
/// <seealso cref="DO0"/>
124124
/// <seealso cref="DI0Mode"/>
125125
/// <seealso cref="DO0Mode"/>
126-
/// <seealso cref="DO0PulseDuration"/>
126+
/// <seealso cref="DO0PulseWidth"/>
127127
/// <seealso cref="DOSet"/>
128128
/// <seealso cref="DOClear"/>
129129
/// <seealso cref="DOToggle"/>
@@ -175,7 +175,7 @@ public override IObservable<IGroupedObservable<Type, HarpMessage>> Process(IObse
175175
[XmlInclude(typeof(DO0))]
176176
[XmlInclude(typeof(DI0Mode))]
177177
[XmlInclude(typeof(DO0Mode))]
178-
[XmlInclude(typeof(DO0PulseDuration))]
178+
[XmlInclude(typeof(DO0PulseWidth))]
179179
[XmlInclude(typeof(DOSet))]
180180
[XmlInclude(typeof(DOClear))]
181181
[XmlInclude(typeof(DOToggle))]
@@ -248,7 +248,7 @@ string INamedElement.Name
248248
/// <seealso cref="DO0"/>
249249
/// <seealso cref="DI0Mode"/>
250250
/// <seealso cref="DO0Mode"/>
251-
/// <seealso cref="DO0PulseDuration"/>
251+
/// <seealso cref="DO0PulseWidth"/>
252252
/// <seealso cref="DOSet"/>
253253
/// <seealso cref="DOClear"/>
254254
/// <seealso cref="DOToggle"/>
@@ -300,7 +300,7 @@ string INamedElement.Name
300300
[XmlInclude(typeof(DO0))]
301301
[XmlInclude(typeof(DI0Mode))]
302302
[XmlInclude(typeof(DO0Mode))]
303-
[XmlInclude(typeof(DO0PulseDuration))]
303+
[XmlInclude(typeof(DO0PulseWidth))]
304304
[XmlInclude(typeof(DOSet))]
305305
[XmlInclude(typeof(DOClear))]
306306
[XmlInclude(typeof(DOToggle))]
@@ -352,7 +352,7 @@ string INamedElement.Name
352352
[XmlInclude(typeof(TimestampedDO0))]
353353
[XmlInclude(typeof(TimestampedDI0Mode))]
354354
[XmlInclude(typeof(TimestampedDO0Mode))]
355-
[XmlInclude(typeof(TimestampedDO0PulseDuration))]
355+
[XmlInclude(typeof(TimestampedDO0PulseWidth))]
356356
[XmlInclude(typeof(TimestampedDOSet))]
357357
[XmlInclude(typeof(TimestampedDOClear))]
358358
[XmlInclude(typeof(TimestampedDOToggle))]
@@ -422,7 +422,7 @@ public Parse()
422422
/// <seealso cref="DO0"/>
423423
/// <seealso cref="DI0Mode"/>
424424
/// <seealso cref="DO0Mode"/>
425-
/// <seealso cref="DO0PulseDuration"/>
425+
/// <seealso cref="DO0PulseWidth"/>
426426
/// <seealso cref="DOSet"/>
427427
/// <seealso cref="DOClear"/>
428428
/// <seealso cref="DOToggle"/>
@@ -474,7 +474,7 @@ public Parse()
474474
[XmlInclude(typeof(DO0))]
475475
[XmlInclude(typeof(DI0Mode))]
476476
[XmlInclude(typeof(DO0Mode))]
477-
[XmlInclude(typeof(DO0PulseDuration))]
477+
[XmlInclude(typeof(DO0PulseWidth))]
478478
[XmlInclude(typeof(DOSet))]
479479
[XmlInclude(typeof(DOClear))]
480480
[XmlInclude(typeof(DOToggle))]
@@ -1149,25 +1149,25 @@ public static Timestamped<DO0ModeConfig> GetPayload(HarpMessage message)
11491149
/// Represents a register that pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Mode == Pulse.
11501150
/// </summary>
11511151
[Description("Pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Mode == Pulse.")]
1152-
public partial class DO0PulseDuration
1152+
public partial class DO0PulseWidth
11531153
{
11541154
/// <summary>
1155-
/// Represents the address of the <see cref="DO0PulseDuration"/> register. This field is constant.
1155+
/// Represents the address of the <see cref="DO0PulseWidth"/> register. This field is constant.
11561156
/// </summary>
11571157
public const int Address = 41;
11581158

11591159
/// <summary>
1160-
/// Represents the payload type of the <see cref="DO0PulseDuration"/> register. This field is constant.
1160+
/// Represents the payload type of the <see cref="DO0PulseWidth"/> register. This field is constant.
11611161
/// </summary>
11621162
public const PayloadType RegisterType = PayloadType.U8;
11631163

11641164
/// <summary>
1165-
/// Represents the length of the <see cref="DO0PulseDuration"/> register. This field is constant.
1165+
/// Represents the length of the <see cref="DO0PulseWidth"/> register. This field is constant.
11661166
/// </summary>
11671167
public const int RegisterLength = 1;
11681168

11691169
/// <summary>
1170-
/// Returns the payload data for <see cref="DO0PulseDuration"/> register messages.
1170+
/// Returns the payload data for <see cref="DO0PulseWidth"/> register messages.
11711171
/// </summary>
11721172
/// <param name="message">A <see cref="HarpMessage"/> object representing the register message.</param>
11731173
/// <returns>A value representing the message payload.</returns>
@@ -1177,7 +1177,7 @@ public static byte GetPayload(HarpMessage message)
11771177
}
11781178

11791179
/// <summary>
1180-
/// Returns the timestamped payload data for <see cref="DO0PulseDuration"/> register messages.
1180+
/// Returns the timestamped payload data for <see cref="DO0PulseWidth"/> register messages.
11811181
/// </summary>
11821182
/// <param name="message">A <see cref="HarpMessage"/> object representing the register message.</param>
11831183
/// <returns>A value representing the timestamped message payload.</returns>
@@ -1187,12 +1187,12 @@ public static Timestamped<byte> GetTimestampedPayload(HarpMessage message)
11871187
}
11881188

11891189
/// <summary>
1190-
/// Returns a Harp message for the <see cref="DO0PulseDuration"/> register.
1190+
/// Returns a Harp message for the <see cref="DO0PulseWidth"/> register.
11911191
/// </summary>
11921192
/// <param name="messageType">The type of the Harp message.</param>
11931193
/// <param name="value">The value to be stored in the message payload.</param>
11941194
/// <returns>
1195-
/// A <see cref="HarpMessage"/> object for the <see cref="DO0PulseDuration"/> register
1195+
/// A <see cref="HarpMessage"/> object for the <see cref="DO0PulseWidth"/> register
11961196
/// with the specified message type and payload.
11971197
/// </returns>
11981198
public static HarpMessage FromPayload(MessageType messageType, byte value)
@@ -1201,14 +1201,14 @@ public static HarpMessage FromPayload(MessageType messageType, byte value)
12011201
}
12021202

12031203
/// <summary>
1204-
/// Returns a timestamped Harp message for the <see cref="DO0PulseDuration"/>
1204+
/// Returns a timestamped Harp message for the <see cref="DO0PulseWidth"/>
12051205
/// register.
12061206
/// </summary>
12071207
/// <param name="timestamp">The timestamp of the message payload, in seconds.</param>
12081208
/// <param name="messageType">The type of the Harp message.</param>
12091209
/// <param name="value">The value to be stored in the message payload.</param>
12101210
/// <returns>
1211-
/// A <see cref="HarpMessage"/> object for the <see cref="DO0PulseDuration"/> register
1211+
/// A <see cref="HarpMessage"/> object for the <see cref="DO0PulseWidth"/> register
12121212
/// with the specified message type, timestamp, and payload.
12131213
/// </returns>
12141214
public static HarpMessage FromPayload(double timestamp, MessageType messageType, byte value)
@@ -1219,25 +1219,25 @@ public static HarpMessage FromPayload(double timestamp, MessageType messageType,
12191219

12201220
/// <summary>
12211221
/// Provides methods for manipulating timestamped messages from the
1222-
/// DO0PulseDuration register.
1222+
/// DO0PulseWidth register.
12231223
/// </summary>
1224-
/// <seealso cref="DO0PulseDuration"/>
1225-
[Description("Filters and selects timestamped messages from the DO0PulseDuration register.")]
1226-
public partial class TimestampedDO0PulseDuration
1224+
/// <seealso cref="DO0PulseWidth"/>
1225+
[Description("Filters and selects timestamped messages from the DO0PulseWidth register.")]
1226+
public partial class TimestampedDO0PulseWidth
12271227
{
12281228
/// <summary>
1229-
/// Represents the address of the <see cref="DO0PulseDuration"/> register. This field is constant.
1229+
/// Represents the address of the <see cref="DO0PulseWidth"/> register. This field is constant.
12301230
/// </summary>
1231-
public const int Address = DO0PulseDuration.Address;
1231+
public const int Address = DO0PulseWidth.Address;
12321232

12331233
/// <summary>
1234-
/// Returns timestamped payload data for <see cref="DO0PulseDuration"/> register messages.
1234+
/// Returns timestamped payload data for <see cref="DO0PulseWidth"/> register messages.
12351235
/// </summary>
12361236
/// <param name="message">A <see cref="HarpMessage"/> object representing the register message.</param>
12371237
/// <returns>A value representing the timestamped message payload.</returns>
12381238
public static Timestamped<byte> GetPayload(HarpMessage message)
12391239
{
1240-
return DO0PulseDuration.GetTimestampedPayload(message);
1240+
return DO0PulseWidth.GetTimestampedPayload(message);
12411241
}
12421242
}
12431243

@@ -5584,7 +5584,7 @@ public static Timestamped<LoadCellEvents> GetPayload(HarpMessage message)
55845584
/// <seealso cref="CreateDO0Payload"/>
55855585
/// <seealso cref="CreateDI0ModePayload"/>
55865586
/// <seealso cref="CreateDO0ModePayload"/>
5587-
/// <seealso cref="CreateDO0PulseDurationPayload"/>
5587+
/// <seealso cref="CreateDO0PulseWidthPayload"/>
55885588
/// <seealso cref="CreateDOSetPayload"/>
55895589
/// <seealso cref="CreateDOClearPayload"/>
55905590
/// <seealso cref="CreateDOTogglePayload"/>
@@ -5636,7 +5636,7 @@ public static Timestamped<LoadCellEvents> GetPayload(HarpMessage message)
56365636
[XmlInclude(typeof(CreateDO0Payload))]
56375637
[XmlInclude(typeof(CreateDI0ModePayload))]
56385638
[XmlInclude(typeof(CreateDO0ModePayload))]
5639-
[XmlInclude(typeof(CreateDO0PulseDurationPayload))]
5639+
[XmlInclude(typeof(CreateDO0PulseWidthPayload))]
56405640
[XmlInclude(typeof(CreateDOSetPayload))]
56415641
[XmlInclude(typeof(CreateDOClearPayload))]
56425642
[XmlInclude(typeof(CreateDOTogglePayload))]
@@ -6042,10 +6042,10 @@ public IObservable<HarpMessage> Process<TSource>(IObservable<TSource> source)
60426042
/// Represents an operator that creates a sequence of message payloads
60436043
/// that pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Mode == Pulse.
60446044
/// </summary>
6045-
[DisplayName("DO0PulseDurationPayload")]
6045+
[DisplayName("DO0PulseWidthPayload")]
60466046
[WorkflowElementCategory(ElementCategory.Transform)]
60476047
[Description("Creates a sequence of message payloads that pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Mode == Pulse.")]
6048-
public partial class CreateDO0PulseDurationPayload : HarpCombinator
6048+
public partial class CreateDO0PulseWidthPayload : HarpCombinator
60496049
{
60506050
/// <summary>
60516051
/// Gets or sets the value that pulse duration (ms) for the digital output pin 0. The pulse will only be emitted when DO0Mode == Pulse.
@@ -6084,7 +6084,7 @@ public IObservable<HarpMessage> Process()
60846084
/// </returns>
60856085
public IObservable<HarpMessage> Process<TSource>(IObservable<TSource> source)
60866086
{
6087-
return source.Select(_ => DO0PulseDuration.FromPayload(MessageType, Value));
6087+
return source.Select(_ => DO0PulseWidth.FromPayload(MessageType, Value));
60886088
}
60896089
}
60906090

‎Interface/Harp.LoadCells/Harp.LoadCells.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<PackageIcon></PackageIcon>
1414
<PackageOutputPath></PackageOutputPath>
1515
<TargetFrameworks>net462;netstandard2.0</TargetFrameworks>
16-
<VersionPrefix>0.1.0-preview2</VersionPrefix>
16+
<VersionPrefix>0.1.0-preview3</VersionPrefix>
1717
<LangVersion>9.0</LangVersion>
1818
</PropertyGroup>
1919

‎device.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ registers:
7474
type: U8
7575
maskType: DO0ModeConfig
7676
description: Configuration of the digital output pin 0.
77-
DO0PulseDuration:
77+
DO0PulseWidth:
7878
address: 41
7979
access: Write
8080
type: U8

0 commit comments

Comments
 (0)