Class AsyncDevice
- Namespace
- Harp.TimestampGeneratorGen3
- Assembly
- Harp.TimestampGeneratorGen3.dll
Represents an asynchronous API to configure and interface with TimestampGeneratorGen3 devices.
public class AsyncDevice : AsyncDevice, IDisposable- Inheritance
-
AsyncDevice
- Implements
- Inherited Members
Methods
ReadBatteryAsync(CancellationToken)
Asynchronously reads the contents of the Battery register.
public Task<float> ReadBatteryAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<float>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadBatteryCalibration0Async(CancellationToken)
Asynchronously reads the contents of the BatteryCalibration0 register.
public Task<ushort> ReadBatteryCalibration0Async(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<ushort>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadBatteryCalibration1Async(CancellationToken)
Asynchronously reads the contents of the BatteryCalibration1 register.
public Task<ushort> ReadBatteryCalibration1Async(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<ushort>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadBatteryRateAsync(CancellationToken)
Asynchronously reads the contents of the BatteryRate register.
public Task<BatteryRateConfiguration> ReadBatteryRateAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<BatteryRateConfiguration>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadBatteryThresholdHighAsync(CancellationToken)
Asynchronously reads the contents of the BatteryThresholdHigh register.
public Task<float> ReadBatteryThresholdHighAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<float>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadBatteryThresholdLowAsync(CancellationToken)
Asynchronously reads the contents of the BatteryThresholdLow register.
public Task<float> ReadBatteryThresholdLowAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<float>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadConfigAsync(CancellationToken)
Asynchronously reads the contents of the Config register.
public Task<ConfigurationFlags> ReadConfigAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<ConfigurationFlags>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadDevicesConnectedAsync(CancellationToken)
Asynchronously reads the contents of the DevicesConnected register.
public Task<byte> ReadDevicesConnectedAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<byte>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadRepeaterStatusAsync(CancellationToken)
Asynchronously reads the contents of the RepeaterStatus register.
public Task<RepeaterFlags> ReadRepeaterStatusAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<RepeaterFlags>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadTimestampedBatteryAsync(CancellationToken)
Asynchronously reads the timestamped contents of the Battery register.
public Task<Timestamped<float>> ReadTimestampedBatteryAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<float>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedBatteryCalibration0Async(CancellationToken)
Asynchronously reads the timestamped contents of the BatteryCalibration0 register.
public Task<Timestamped<ushort>> ReadTimestampedBatteryCalibration0Async(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<ushort>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedBatteryCalibration1Async(CancellationToken)
Asynchronously reads the timestamped contents of the BatteryCalibration1 register.
public Task<Timestamped<ushort>> ReadTimestampedBatteryCalibration1Async(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<ushort>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedBatteryRateAsync(CancellationToken)
Asynchronously reads the timestamped contents of the BatteryRate register.
public Task<Timestamped<BatteryRateConfiguration>> ReadTimestampedBatteryRateAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<BatteryRateConfiguration>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedBatteryThresholdHighAsync(CancellationToken)
Asynchronously reads the timestamped contents of the BatteryThresholdHigh register.
public Task<Timestamped<float>> ReadTimestampedBatteryThresholdHighAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<float>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedBatteryThresholdLowAsync(CancellationToken)
Asynchronously reads the timestamped contents of the BatteryThresholdLow register.
public Task<Timestamped<float>> ReadTimestampedBatteryThresholdLowAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<float>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedConfigAsync(CancellationToken)
Asynchronously reads the timestamped contents of the Config register.
public Task<Timestamped<ConfigurationFlags>> ReadTimestampedConfigAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<ConfigurationFlags>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedDevicesConnectedAsync(CancellationToken)
Asynchronously reads the timestamped contents of the DevicesConnected register.
public Task<Timestamped<byte>> ReadTimestampedDevicesConnectedAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<byte>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedRepeaterStatusAsync(CancellationToken)
Asynchronously reads the timestamped contents of the RepeaterStatus register.
public Task<Timestamped<RepeaterFlags>> ReadTimestampedRepeaterStatusAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<RepeaterFlags>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
WriteBatteryCalibration0Async(ushort, CancellationToken)
Asynchronously writes a value to the BatteryCalibration0 register.
public Task WriteBatteryCalibration0Async(ushort value, CancellationToken cancellationToken = default)Parameters
valueushortThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.
WriteBatteryCalibration1Async(ushort, CancellationToken)
Asynchronously writes a value to the BatteryCalibration1 register.
public Task WriteBatteryCalibration1Async(ushort value, CancellationToken cancellationToken = default)Parameters
valueushortThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.
WriteBatteryRateAsync(BatteryRateConfiguration, CancellationToken)
Asynchronously writes a value to the BatteryRate register.
public Task WriteBatteryRateAsync(BatteryRateConfiguration value, CancellationToken cancellationToken = default)Parameters
valueBatteryRateConfigurationThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.
WriteBatteryThresholdHighAsync(float, CancellationToken)
Asynchronously writes a value to the BatteryThresholdHigh register.
public Task WriteBatteryThresholdHighAsync(float value, CancellationToken cancellationToken = default)Parameters
valuefloatThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.
WriteBatteryThresholdLowAsync(float, CancellationToken)
Asynchronously writes a value to the BatteryThresholdLow register.
public Task WriteBatteryThresholdLowAsync(float value, CancellationToken cancellationToken = default)Parameters
valuefloatThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.
WriteConfigAsync(ConfigurationFlags, CancellationToken)
Asynchronously writes a value to the Config register.
public Task WriteConfigAsync(ConfigurationFlags value, CancellationToken cancellationToken = default)Parameters
valueConfigurationFlagsThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.
WriteRepeaterStatusAsync(RepeaterFlags, CancellationToken)
Asynchronously writes a value to the RepeaterStatus register.
public Task WriteRepeaterStatusAsync(RepeaterFlags value, CancellationToken cancellationToken = default)Parameters
valueRepeaterFlagsThe value to be stored in the register.
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task
The task object representing the asynchronous write operation.