Class AsyncDevice
- Namespace
- Harp.Synchronizer
- Assembly
- Harp.Synchronizer.dll
Represents an asynchronous API to configure and interface with Synchronizer devices.
public class AsyncDevice : AsyncDevice, IDisposable- Inheritance
-
AsyncDevice
- Implements
- Inherited Members
Methods
ReadDO0ConfigAsync(CancellationToken)
Asynchronously reads the contents of the DO0Config register.
public Task<DO0ConfigMode> ReadDO0ConfigAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<DO0ConfigMode>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadDigitalInputStateAsync(CancellationToken)
Asynchronously reads the contents of the DigitalInputState register.
public Task<DigitalInputs> ReadDigitalInputStateAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<DigitalInputs>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadDigitalInputsSamplingModeAsync(CancellationToken)
Asynchronously reads the contents of the DigitalInputsSamplingMode register.
public Task<DigitalInputsSamplingConfig> ReadDigitalInputsSamplingModeAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<DigitalInputsSamplingConfig>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadDigitalOutputStateAsync(CancellationToken)
Asynchronously reads the contents of the DigitalOutputState register.
public Task<DigitalOutputs> ReadDigitalOutputStateAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<DigitalOutputs>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadEnableEventsAsync(CancellationToken)
Asynchronously reads the contents of the EnableEvents register.
public Task<SynchronizerEvents> ReadEnableEventsAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<SynchronizerEvents>
A task that represents the asynchronous read operation. The Result property contains the register payload.
ReadTimestampedDO0ConfigAsync(CancellationToken)
Asynchronously reads the timestamped contents of the DO0Config register.
public Task<Timestamped<DO0ConfigMode>> ReadTimestampedDO0ConfigAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<DO0ConfigMode>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedDigitalInputStateAsync(CancellationToken)
Asynchronously reads the timestamped contents of the DigitalInputState register.
public Task<Timestamped<DigitalInputs>> ReadTimestampedDigitalInputStateAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<DigitalInputs>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedDigitalInputsSamplingModeAsync(CancellationToken)
Asynchronously reads the timestamped contents of the DigitalInputsSamplingMode register.
public Task<Timestamped<DigitalInputsSamplingConfig>> ReadTimestampedDigitalInputsSamplingModeAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<DigitalInputsSamplingConfig>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedDigitalOutputStateAsync(CancellationToken)
Asynchronously reads the timestamped contents of the DigitalOutputState register.
public Task<Timestamped<DigitalOutputs>> ReadTimestampedDigitalOutputStateAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<DigitalOutputs>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
ReadTimestampedEnableEventsAsync(CancellationToken)
Asynchronously reads the timestamped contents of the EnableEvents register.
public Task<Timestamped<SynchronizerEvents>> ReadTimestampedEnableEventsAsync(CancellationToken cancellationToken = default)Parameters
cancellationTokenCancellationTokenA CancellationToken which can be used to cancel the operation.
Returns
- Task<Timestamped<SynchronizerEvents>>
A task that represents the asynchronous read operation. The Result property contains the timestamped register payload.
WriteDO0ConfigAsync(DO0ConfigMode, CancellationToken)
Asynchronously writes a value to the DO0Config register.
public Task WriteDO0ConfigAsync(DO0ConfigMode value, CancellationToken cancellationToken = default)Parameters
valueDO0ConfigModeThe 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.
WriteDigitalInputsSamplingModeAsync(DigitalInputsSamplingConfig, CancellationToken)
Asynchronously writes a value to the DigitalInputsSamplingMode register.
public Task WriteDigitalInputsSamplingModeAsync(DigitalInputsSamplingConfig value, CancellationToken cancellationToken = default)Parameters
valueDigitalInputsSamplingConfigThe 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.
WriteDigitalOutputStateAsync(DigitalOutputs, CancellationToken)
Asynchronously writes a value to the DigitalOutputState register.
public Task WriteDigitalOutputStateAsync(DigitalOutputs value, CancellationToken cancellationToken = default)Parameters
valueDigitalOutputsThe 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.
WriteEnableEventsAsync(SynchronizerEvents, CancellationToken)
Asynchronously writes a value to the EnableEvents register.
public Task WriteEnableEventsAsync(SynchronizerEvents value, CancellationToken cancellationToken = default)Parameters
valueSynchronizerEventsThe 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.