yaq/daemons/seabreeze


Sensor daemon for Ocean Optics SeaBreeze spectrometers.

external links

source
bugtracker
manufacturer

installation

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

PyPI

traits

The seabreeze daemon is composed of the following traits:

is-sensor
is-daemon

hardware

The seabreeze daemon has been tested with the following hardware:

usb2000

configuration

correct_dark_counts (boolean) default: False

correct_nonlinearity (boolean) default: False

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

serial (string) default: NULL
Serial number for the particular device represented by the daemon
from is-daemon

make (String) default: NULL
from is-daemon

model (String) default: NULL
from is-daemon

state

The seabreeze daemon will provide the following state information:

integration_time_micros
type: number
Integration time for collecting pixels

methods

Daemons with the seabreeze trait expose the following public methods:

set_integration_time_micros
Set the integration time in microseconds.
Arguments:

set_integration_time_micros, {'type': 'number'}

get_integration_time_micros ➜ number
Get the integration time in microseconds.

measure ➜ number
Initiate a measurement. Returns integer, measurement ID.
from is-sensor
Arguments:

loop, {'type': 'boolean'}

get_measured ➜ dictionary name: value
Get most recent measured value. Additional key of measurement ID.
from is-sensor

stop_looping
Stop looping measurement.
from is-sensor

get_channel_names ➜ list of string
Get current channel names.
from is-sensor

get_channel_shapes ➜ dictionary name: list of int
Get current channel shapes. If list is empty, channel is scalar.
from is-sensor

get_channel_units ➜ dictionary name: units
Get current channel units.
from is-sensor

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

id ➜ dictionary
JSON object with information to identify the daemon, including name, kind, make, model, serial.
from is-daemon

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

get_config ➜ dictionary
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_traits ➜ [string]
Get a full list of the daemon traits.
from is-daemon

get_state ➜ dictionary
Get daemon state, as saved in the state.toml file.
from is-daemon

set_state
Set daemon state. Accepts any subset of the state dictionary, dynamically.
from is-daemon

list_methods ➜ [string]
Get an array of all known public method names.
from is-daemon

shutdown
Cleanly shutdown (or restart) daemon.
from is-daemon
Arguments:

restart, {'type': 'boolean', 'default': False}

help ➜ string
If method not given, return a human-readable string with information about the daemon as a whole. If method is given, return a human-readable string with the signature of the method on the first line and a description of the method on subsequent lines. The signature is not specified to be in any particular language. It is intended for usage by humans ONLY.
from is-daemon
Arguments:

method, {'type': 'string'}


built 2020-05-24 18:31:17                                      CC0: no copyright