yaq/daemons/seabreeze


Sensor daemon for Ocean Optics SeaBreeze spectrometers.

bugtracker
manufacturer
source

installation

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

PyPI

traits

The seabreeze daemon is composed of the following traits:

is-daemon
is-sensor

configuration

correct_dark_counts (boolean) default: False

correct_nonlinearity (boolean) default: False

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

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

port (int)
TCP port for daemon to occupy.

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

state

The seabreeze daemon will provide the following state information:

integration_time_micros (int)
Integration time for collecting pixels

messages

The seabreeze daemon will expose the following public messages:

busy ➜ boolean
Returns true if daemon is currently busy.

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_integration_time_micros ➜ int
Get the integration time in microseconds.

get_measured ➜ {'type': 'map', 'values': [{'type': 'float'}, {'fields': [{'name': 'shape', 'type': {'items': 'int', 'type': 'array'}}, {'name': 'typestr', 'type': 'string'}, {'name': 'data', 'type': 'bytes'}, {'name': 'version', 'type': 'int'}], 'logicalType': 'ndarray', 'name': 'ndarray', 'type': 'record'}]}
Get most recent measured value. Additional key of measurement ID.

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

set_integration_time_micros ➜ null
Set the integration time in microseconds.
parameters:

set_integration_time_micros (int)

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