Photomechanics API
Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener Interface Reference

Represents listener which periodically updates provided registers. More...

Inheritance diagram for Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener:
[legend]

Public Member Functions

void AddRegistersToObserve (IEnumerable< IObservableRegister > registerDescriptors)
 Add registers which will be periodically read from slave. More...
 
Task WriteRegistersAsync (params(IObservableRegister register, UInt16 newValue)[] registers)
 Write new values to the given registers. More...
 
Task WaitNextRegistersUpdateAsync ()
 Wait for registers to be updated. Used if needed to ensure registers update before other actions. More...
 

Properties

IModbusMaster ModbusMaster [get]
 Modbus master. More...
 
Byte SlaveAddress [get]
 SlaveID. More...
 
- Properties inherited from Photomechanics.Photo3DStudio.Common.Interfaces.IDisposableExtended
Boolean IsDisposed [get]
 Determines whether the object is being disposed or already disposed and no longer functional. More...
 

Additional Inherited Members

- Events inherited from Photomechanics.Photo3DStudio.Common.Interfaces.IDisposableExtended
TypedEventHandler< IDisposableExtendedDisposed
 Occurs when object is disposed. More...
 

Detailed Description

Represents listener which periodically updates provided registers.

Member Function Documentation

◆ AddRegistersToObserve()

void Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener.AddRegistersToObserve ( IEnumerable< IObservableRegister registerDescriptors)

Add registers which will be periodically read from slave.

◆ WriteRegistersAsync()

Task Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener.WriteRegistersAsync ( params(IObservableRegister register, UInt16 newValue) []  registers)

Write new values to the given registers.

Attempts to write multiple registers at once if addresses are sequentional. Used by modbus commands.

◆ WaitNextRegistersUpdateAsync()

Task Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener.WaitNextRegistersUpdateAsync ( )

Wait for registers to be updated. Used if needed to ensure registers update before other actions.

Property Documentation

◆ ModbusMaster

IModbusMaster Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener.ModbusMaster
get

Modbus master.

◆ SlaveAddress

Byte Photomechanics.Photo3DStudio.TurntableControl.RD300.Interfaces.IModbusListener.SlaveAddress
get

SlaveID.