yaq/traits/is-homeable


requires

has-position

state

Daemons with the is-homeable trait will provide the following state information:

position (float)
from has-position

destination (float)
from has-position

messages

Daemons with the is-homeable trait expose the following public messages:

home
Initiates the homing procedure. The daemon will report as busy during the homing procedure. After the homing procedure is complete, the daemon will return to the current destination.

get_destination ➜ float
Get current daemon destination.
from has-position

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

get_position ➜ float
Get current daemon position.
from has-position

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

position (float)

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

distance (float)

daemons

The following daemons implement the is-homeable trait:

lightcon-topas4-motor
micro-hr
newport-connex-agp
newport-smc100
pmc
thorlabs-bsc201
thorlabs-k10cr1
thorlabs-kdc101
thorlabs-kst101
thorlabs-lts150
thorlabs-lts300
zaber-binary


built 2020-08-18 17:11:11                                      CC0: no copyright