yaq/daemons/fake-discrete-hardware


bugtracker
source

installation

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

PyPI
conda-forge

traits

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

is-daemon
is-discrete
has-position

configuration

identifiers ({'type': 'map', 'values': 'float'}) default: {}
Position identifiers
from is-discrete

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

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

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

sleep (float) default: 1.0

tolerance (float) default: 1.0

state

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

destination (float)

position (float)

position_identifier (['null', 'string'])

messages

Daemons with the fake-discrete-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_identifier ➜ ['null', 'string']
Get current identifier string. Current identifier may be None.

get_position ➜ float
Get current daemon position.

get_position_identifiers ➜ {'type': 'map', 'values': 'float'}
Get position identifiers. Identifiers may not change at runtime.

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.

set_identifier ➜ float
Set using an identifier. Returns new destination.
parameters:

identifier (string)

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