yaq/traits/has-position


Daemons with this trait have one specific value that describes their current position. This position can be set (using the set_position method). In general, these daemons may not be able to reach exactly the set position. The destination (get_destination) returns exactly the set position, while the position (get_position) returns the current actual position of the daemon. These daemons should start motion and become busy when set_daemon is called. They should release busy once they arrive as close as possible to the destination, and their position should not change until set_position is called again.

state

Daemons with the has-position trait will provide the following state information:

destination (double)

position (double)

messages

Daemons with the has-position trait expose the following public messages:

get_destination ➜ double
Get current daemon destination.

get_position ➜ double
Get current daemon position.

get_units ➜ ['null', 'string']
Get units of daemon. These units apply to the position and destination fields.

set_position
Give the daemon a new destination, and begin motion towards that destination.
parameters:

position (double)

set_relative ➜ double
Give the daemon a new destination relative to its current position. Daemon will immediately begin motion towards new destination. Returns new destination.
parameters:

distance (double)

daemons

The following daemons implement the has-position trait:

acton-2150i
fake-continuous-hardware
fake-discrete-hardware
fake-has-turret
gpio-digital-output
lightcon-topas4-motor
lightcon-topas4-shutter
micro-hr
newport-connex-agp
newport-smc100
pmc
thorlabs-bsc201
thorlabs-k10cr1
thorlabs-kdc101
thorlabs-kst101
thorlabs-lts150
thorlabs-lts300
wright-filter-wheel
zaber-binary


built 2020-10-27 13:47:08                                      CC0: no copyright