EnlightenPlugin.EnlightenPluginResponse Class Reference

After a plug-in has received an EnlightenPluginRequest and processed it, the plug-in should instantiate and send an EnlightenPluginResponse in reply. More...

Public Member Functions
	__init__ (self, request, commands=None, message=None, metadata=None, outputs=None, overrides=None, signals=None, series=None)

Public Attributes
	commands = commands
	message = message
	metadata = metadata
	outputs = outputs
	overrides = overrides
	request = request
	series = series
	signals = signals

Detailed Description

After a plug-in has received an EnlightenPluginRequest and processed it, the plug-in should instantiate and send an EnlightenPluginResponse in reply.

Commands

An array of (setting, value) tuples to send to the currently selected spectrometer (or multiple spectrometers if controls are locked?)

Metadata

Key-value scalar pairs will be added to the "metadata" saved with each .CSV or .JSON Measurement (requires block_enlighten=True).

Overrides

Currently limited to "processed", "recordable_dark" and "recordable_reference".
May someday include wavelengths, wavenumbers etc.

Todo

add metadata arrays as CSV columns

Constructor & Destructor Documentation

__init__()

EnlightenPlugin.EnlightenPluginResponse.__init__	(		self,
			request,
			commands = None,
			message = None,
			metadata = None,
			outputs = None,
			overrides = None,
			signals = None,
			series = None )

Parameters

request	handle to the originiating EnlightenPluginRequest
commands	array of (setting, value) tuples for spectrometer
message	string to display on scope marquee
metadata	dict added to any Measurements saved from this ProcessedReading (requires block_enlighten)
outputs	dict of configured EnlightenPluginField "output" values
overrides	dict of replacement arrays for ProcessedReading etc
series	a dict of series names to series x/y data

Member Data Documentation

commands

EnlightenPlugin.EnlightenPluginResponse.commands = commands

message

EnlightenPlugin.EnlightenPluginResponse.message = message

metadata

EnlightenPlugin.EnlightenPluginResponse.metadata = metadata

outputs

EnlightenPlugin.EnlightenPluginResponse.outputs = outputs

overrides

EnlightenPlugin.EnlightenPluginResponse.overrides = overrides

request

EnlightenPlugin.EnlightenPluginResponse.request = request

series

EnlightenPlugin.EnlightenPluginResponse.series = series

signals

EnlightenPlugin.EnlightenPluginResponse.signals = signals

---

The documentation for this class was generated from the following file:

• plugins/EnlightenPlugin.py