yaq/daemons/ndinterp


yaq daemon representing an NDimensional interpolated offset

bugtracker
source

installation

The ndinterp daemon can be installed using the following package managers:

PyPI

traits

The ndinterp daemon is composed of the following traits:

has-limits
has-position
is-daemon
is-homeable

configuration

data_path (string)
Absolute file path to a WrightTools Data object which represents the offset in ND space

enable (boolean) default: True
Disable this daemon. The kind entry-point will not attempt to start this daemon.
from is-daemon

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

log_level ({'name': 'level', 'symbols': ['debug', 'info', 'notice', 'warning', 'error', 'critical', 'alert', 'emergency'], 'type': 'enum'}) default: info
Set daemon log-level.
from is-daemon

log_to_file (boolean) default: False
Optionally force logging to a file.
from is-daemon

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

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

offset_channel (string) default: offset
Channel name of the offset

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: None
Serial number for the particular device represented by the daemon
from is-daemon

wrapped_daemon (['int', 'string'])
port or host:port string of the wrapped delay stage

state

The ndinterp daemon will provide the following state information:

control_position (map)
Cached position of the control hardware

destination (double)
from has-position

hw_limits (array)
from has-limits

offset (double)
Currently applied offset due to cosetting

offset_enabled (boolean)
Whether or not offset is enabled

position (double)
from has-position

zero_position (double)
Position in underlying stage units that represents the zero position

messages

The ndinterp daemon will expose the following public messages:

busy ➜ boolean
Returns true if daemon is currently busy.
from is-daemon

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.
from is-daemon

get_config_filepath ➜ string
String representing the absolute filepath of the configuration file on the host machine.
from is-daemon

get_control_active ➜ {'type': 'map', 'values': 'boolean'}
No-Op, here to make it behave like an attune-delay to the attune object, returns empty dict

get_control_positions ➜ {'type': 'map', 'values': 'double'}
Get underlying control positions, provides a mapping of names to positions, in native units.

get_control_tunes ➜ {'type': 'map', 'values': ['null', 'string']}
No-Op, here to make it behave like an attune-delay to the attune object, returns empty dict

get_dependent_hardware ➜ {'type': 'map', 'values': 'string'}
Get mapping of name to host:port string. 'localhost' should be replaced on the client side with the host for this daemon.

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

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

get_offset ➜ double
Get the applied offset

get_offset_enabled ➜ boolean
Get offset enabled

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

get_state ➜ string
Get version of the running daemon
from is-daemon

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

get_zero_position ➜ double
Get the zero position in underlying daemon units

get_zero_position_limits ➜ {'items': 'double', 'type': 'array'}
Get the zero position underlying daemon limits

get_zero_position_units ➜ string
Get the zero position underlying daemon units

home ➜ null
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.
from is-homeable

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

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

position (double)

set_control_active ➜ null
No-Op, here to make it behave like an attune-delay to the attune object
parameters:

control (string)

active (boolean)

set_control_position ➜ null
Set the cached value of the control hardware, causes delay to recompute its offset and adjust appropriately
parameters:

control (string)

position (double)

set_control_tune ➜ null
No-Op, here to make it behave like an attune-delay to the attune object
parameters:

control (string)

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

set_offset_enabled ➜ null
Set offset enabled
parameters:

enable (boolean)

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

distance (double)

set_zero_position ➜ null
Set the zero position in underlying daemon units
parameters:

position (double)

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

restart (boolean) default: False


built 2022-11-30 17:44:22                                      CC0: no copyright