yaq/daemons/fake-continuous-hardware


bugtracker
documentation
source

installation

The fake-continuous-hardware daemon can be installed using the following package managers:

PyPI
conda-forge

traits

The fake-continuous-hardware daemon is composed of the following traits:

has-position
has-limits
is-daemon

configuration

limits (array) default: [-inf, inf]
Configuration limits are strictly optional.
from has-limits

make (['null', 'string']) default: __null__
from is-daemon

model (['null', 'string']) default: __null__
from is-daemon

out_of_limits (enum) default: closest
Control behavior of daemon when set_position is given a value outside of limits.
from has-limits

port (int)
TCP port for daemon to occupy.
from is-daemon

serial (['null', 'string']) default: __null__
Serial number for the particular device represented by the daemon
from is-daemon

velocity (float) default: 1.0

state

The fake-continuous-hardware daemon will provide the following state information:

destination (float)

hw_limits (array)

position (float)

messages

Daemons with the fake-continuous-hardware trait expose the following public messages:

busy ➜ boolean
Returns true if daemon is currently busy.

get_config ➜ string
Full configuration for the individual daemon as defined in the TOML file. This includes defaults and shared settings not directly specified in the daemon-specific TOML table.

get_config_filepath ➜ string
String representing the absolute filepath of the configuration file on the host machine.

get_destination ➜ float
Get current daemon destination.

get_limits ➜ {'items': 'float', 'type': 'array'}
Get daemon limits.Limits will be the intersection of config limits and driver limits (when appliciable).

get_position ➜ float
Get current daemon position.

get_state ➜ string
Get version of the running daemon

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

id ➜ {'type': 'map', 'values': ['null', 'string']}
JSON object with information to identify the daemon, including name, kind, make, model, serial.

in_limits ➜ boolean
Check if a given position is within daemon limits.
parameters:

position (float)

set_position ➜ null
Give the daemon a new destination, and begin motion towards that destination.
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.
parameters:

distance (float)

shutdown ➜ null
Cleanly shutdown (or restart) daemon.
parameters:

restart (boolean) default: False


built 2020-07-31 16:06:40                                      CC0: no copyright