yaq/daemons/wright-ingaas


bugtracker
source

installation

The wright-ingaas daemon can be installed using the following package managers:

PyPI

traits

The wright-ingaas daemon is composed of the following traits:

is-sensor
uses-serial
uses-uart
is-daemon
has-measure-trigger

configuration

baud_rate (int)

calibration_pixel (int) default: 100
Pixel that spectrometer setpoint appears at.

focal_length (float) default: 140.0
Spectrometer focal length (mm).

focal_length_tilt (float) default: 0.0
Spectrometer focal length tilt (degrees).

grooves_per_mm (float) default: 150.0
Spectrometer grating grooves per mm.

inclusion_angle (float) default: 24.0
Spectrometer inclusion angle (degrees).

loop_at_startup (boolean)
If set to true, the daemon will begin to loop measure as soon as it starts.

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

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

order (int) default: 1
Spectrometer order of defraction.

port (int)
TCP port for daemon to occupy.

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

serial_port (string)

spectra_averaged (int)
Number of spectra to average.

messages

The wright-ingaas daemon will expose the following public messages:

busy ➜ boolean
Returns true if daemon is currently busy.

direct_serial_write ➜ null
Expose direct access to the serial port to clients. This should not be encouraged for normal use, but may be very important for debugging. If a device is expected to return data, it should be logged at the INFO level, not returned to the client. This is done to allow long tasks to be run asynchronously, and to explicitly discourage use of this method except when debugging. Setting `busy` to true is encouraged, but individual daemon writers should consider their own use case.
parameters:

message (bytes)

get_channel_names ➜ {'items': 'string', 'type': 'array'}
Get current channel names.

get_channel_shapes ➜ {'type': 'map', 'values': {'items': 'int', 'type': 'array'}}
Get current channel shapes. If list is empty, channel is scalar.

get_channel_units ➜ {'type': 'map', 'values': ['null', 'string']}
Get current channel units.

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_map ➜ ndarray
Get color at each pixel, in nanometers. Must give mono setpoint in nanometers.
parameters:

mono_setpoint (float)

get_measured ➜ {'type': 'map', 'values': ['float', 'ndarray']}
Get most recent measured value.

get_state ➜ string
Get version of the running daemon

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

measure ➜ int
Initiate a measurement. Returns integer, measurement ID.
parameters:

loop (boolean) default: False

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

restart (boolean) default: False

stop_looping ➜ null
Stop looping measurement.


built 2020-10-27 13:47:08                                      CC0: no copyright