BRML Drivers


XYTableT

Namespace: BRML.Drivers
Parent Module: XYTable

Driver for Movtec XY table.

Constructors

ConstructorDescription
new(config)
Signature: config:XYTableConfigT -> XYTableT

CompiledName: .ctor

Instance members

Instance memberDescription
CurrentPos
Signature: float<MeasureOne> * float<MeasureOne>

The latest available position.

CompiledName: get_CurrentPos

Dispose()
Signature: unit -> unit

Stops the table, releases the serial port and disposes the driver instance.

DriveTo(pos, vel, accel, decel)
Signature: (pos:XYTupleT * vel:(float * float) option * accel:(float * float) option * decel:(float * float) option) -> Async<unit>

Drives to the specified position. Optionally drive velocity, acceleration and deceleration can be specified. Acceleration and deceleration is performed using a linear ramp.

DriveWithVel(vel, accel)
Signature: (vel:XYTupleT * accel:(float * float) option) -> unit

Starts driving with the specified velocity. Use negative velocities to move in the opposite direction. The acceleration is performed linearly to the target velocity. This method may be called repetitively (without stopping the table in-between) to adjust the movement velocity.

GetNextPos()
Signature: unit -> XYTupleT

Waits for the next position sample and returns it.

Home()
Signature: unit -> Async<unit>

Homes the XY table, if it is currently not homed.

OptimalVelToPos(tPos, maxVel, maxAccel)
Signature: (tPos:(float<MeasureOne> * float<MeasureOne>) * maxVel:float option * maxAccel:float option) -> float * float

Optimal velocity to reach target position in shortest time with the specified maximum velocity and acceleration.

PosAcquired
Signature: IEvent<XYTupleT>

This event is raised, when a new position sample is acquired.

CompiledName: get_PosAcquired

PosReportInterval()
Signature: unit -> int

Position reporting interval in ms.

CompiledName: set_PosReportInterval

PosReportInterval()
Signature: unit -> unit

Position reporting interval in ms.

CompiledName: get_PosReportInterval

Stop(decel)
Signature: (decel:(float * float) option) -> unit

Stops the XY table with the optionally specified deceleration.

Fork me on GitHub