yaq/traits/is-daemon


Core trait common to all yaq daemons.

configuration

Daemons with the is-daemon trait expect the following configuration:

port (int)
TCP port for daemon to occupy.

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

make (['null', 'string']) default: __null__

model (['null', 'string']) default: __null__

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

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

log_to_file (boolean) default: False
Optionally force logging to a file.

messages

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

busy ➜ boolean
Returns true if daemon is currently busy.

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

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

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.

shutdown
Cleanly shutdown (or restart) daemon.
parameters:

restart (boolean) default: False

get_state ➜ string
Get version of the running daemon

daemons

The following daemons implement the is-daemon trait:

acton-2150i
acton-sp2300i
adafruit-stepper-motor-hat
ads1115
andor-neo
andor-simcam
attune
attune-delay
becker-hickl-spc130
brooks-mfc-gf
dwyer-16b
dwyer-16c
edaq-isopod
ekspla-nt340
fake-camera
fake-continuous-hardware
fake-discrete-hardware
fake-has-turret
fake-sensor
fake-spectrometer
fake-triggered-sensor
gage-chopping
gage-compuscope
gdrive
gpio-digital-output
gpio-digital-sensor
horiba-ihr320
horiba-micro-hr
labjack-digital-output
labjack-sensor
lightcon-topas4-motor
lightcon-topas4-shutter
mcc-118
mcc-152-aout
mcp3428
mcp9600
mqtt-homie-sensor
ndinterp
new-era-continuous-nextgen
new-era-ne1000
newport-conex-agp
newport-smc100
ni-daqmx-tmux
omega-platinum
picotech-adc-triggered
pmc
rgb-qmini
scpi-sensor
scpi-set-continuous
scpi-set-discrete
seabreeze
seek-compact
system-monitor
thorlabs-bsc201
thorlabs-bsc203
thorlabs-ell18
thorlabs-k10cr1
thorlabs-kdc101
thorlabs-kst101
thorlabs-lts150
thorlabs-lts300
thorlabs-mpc320
thorlabs-pax1000
thorlabs-pm-triggered
vici-two-position
wright-aerotech
wright-filter-wheel
wright-ingaas
wright-stepper-box
wright-wl-motor
zaber-binary


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