`CONTrol` - Control adjustments

The CONTrol root path provides access to control the behavior upon incoming external signals (:INPut) and outgoing signals to trigger events on external devices (:OUTPut). The out-of-band emission of spectra can be configured using :MANual path. Finally the information provided by the status LED on the front plate of the Spektralwerk Core can be altered.

`:INDicator:STATus` - Status LED behavior control

command and query

To reduce light pollution disturbing measurements, the status LED of Spektralwerk Core can be adjusted. Changes of the LED status are only kept until the next reboot of Spektralwerk Core. The default mode of the status LED is auto (LED is used to inform a user about current status). The other options are on and off, see appendix Indicator status for more information.

Parent Command: CONTrol:INDicator

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:STATus`	returns the current status of the status LED	: change the status of the status LED until the next reboot

Example:

> CONTrol:INDicator:STATus?
auto
> CONTrol:INDicator:STATus off
# turns off the status LED
> CONTrol:INDicator:STATus?
off

`:INPut` - Incoming signal control

command and query

External trigger signals can be used to toggle spectra sampling. The SYSTem:INPut branch offers endpoints enabling control from external sources and defining how the signal of these external sources triggers spectral sampling. Furthermore, the emission of spectral samples can be configured using CONTrol:INPut:EMITter:CONFig and status information can be obtained (CONTrol:INPut:EMITter:STATus). In contrast to CONTrol:MANual, the CONTrol:INPut path defines the reaction upon incoming signals.

More details about possible values for CONTrol:INPut:EDGE can be found in the appendix Trigger edges.

Parent path: CONTrol:INPUT

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:EDGE`	returns the signal flank which triggers the input	`<TRIGGER_EDGES>`: sets the trigger observable
`:LEVel`	returns the current signal level of the input	-

Example:

> CONTrol:INPut:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:INPut:EDGE?
raising
> CONTrol:INPut:EDGE any
# the emission is started upon each edge change
> CONTrol:INPut:EDGE?
any
> CONTrol:INPut:LEVel?
1
> CONTrol:INPut:EDGE none
# spectral emission is never triggered

`:EMITter` - External triggered out-of-band spectral emission

The CONTrol:INPut:EMITter parent path provides access to the spectral emission triggered by incoming signals.

`CONFig` - Configuration of triggered out-of-band spectral emission

command and query

Analogous to the configuration of in-band spectral retrieval MEASure:SPECtrum:REQuest:CONFig, CONTrol:INPut:EMITter:CONFig allows the configuration of the emitted spectral sample upon incoming signals. The emission will not start until a valid destination is provide (CONTrol:INPut:EMITter:DESTination). More details about the configuration possibilities can be found in MEASure:SPECtrum:REQuest:CONFig.

Parent path CONTrol:INPut:EMITter:CONFig

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:COUNt`	returns the number of spectra returned from out-of-band emission.	`<INTEGER>`: set the number of spectra returned from out-of-band emission.
`:FORMat`	returns format of the spectra to be returned from out-of-band emission.	`<OUTPUT_FORMAT>`: set the number of spectra to be returned from out-of-band emission.
`:PROCessing`	returns the applied processing steps to be applied on spectral emission	`<PROCESSING_STEPS>`: set the processing steps to be applied on spectral emission.
`:ROI`	returns the currently set region-of-interest (ROI).	`<INTEGER,INTEGER>`: set the first and last pixel for region of interest.
`:FREQuency`	returns the current sampling frequency.	`<FLOAT>`: set sampling frequency.
`:UNIT`	returns the unit of frequency	-

Example:

> CONTrol:INPut:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:INPut:EMITter:CONFig:COUNt?
1
> CONTrol:INPut:EMITter:CONFig:COUNt 10

> CONTrol:INPut:EMITter:CONFig:COUNt?
10
> CONTrol:INPut:EMITter:CONFig:FORMat?
human
> CONTrol:INPut:EMITter:CONFig:FORMat base64_int16

> CONTrol:INPut:EMITter:CONFig:FORMat?
base64_int16
> CONTrol:INPut:EMITter:CONFig:PROCessing?
# no processing is enabled by default
> CONTrol:INPut:EMITter:CONFig:PROCessing reference_light,average

> CONTrol:INPut:EMITter:CONFig:PROCessing?
reference_light,average
> CONTrol:INPut:EMITter:CONFig:ROI?
0,255
> CONTrol:INPut:EMITter:CONFig:ROI 100,200

> CONTrol:INPut:EMITter:CONFig:ROI?
100,200
> CONTrol:INPut:EMITter:CONFig:FREQuency?
0
> CONTrol:INPut:EMITter:CONFig:FREQuency 10

> CONTrol:INPut:EMITter:CONFig:FREQuency?
10
> CONTrol:INPut:EMITter:CONFig:FREQuency:UNIT?
Hz

`:DESTination` - Emitted spectra destination

The destination of the spectral samples can be adjusted using CONTrol:INPut:EMITter:DESTination. The provided path must be a a valid tcp or udp uri.

Parent path CONTrol:INPut:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:DESTination`	returns the current destination for the emission of spectral data	`<STRING>`: uri of the destination for the emissioned spectra

Example:

> CONTrol:INPut:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:INPut:EMITter:DESTination?
"udp://192.168.4.23:8100"
> CONTrol:INPut:EDGE raising
# upon receiving an input trigger signal, the emission of spectra to the destination starts

`:SAMPles` - Previously emitted spectra

query only

Emitting spectra using the CONTrol:INPut:EMITter will not return any spectra in-band. CONTrol:INPut:EMITter:SAMPles provides some impression of the delivered spectra since the last five spectra delivered are stored as a base64 encoded string.

Parent path: CONTrol:INPut:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:SAMPles`	returns the last five delivered spectra to a destination	-

Example:

// Spectral samples are `json` formatted:
{
  "spectra": [
    {
      "timestamp": 123,
      "pixel_intensities": [0.3, 0.8, ...,1.0, 0.73]
    },
    {
      ...
    }
  ]
}
// This will result in a base64 string:
// ewogICJzcGVjdHJhIjogWwogIC...AuLi4KICAgIH0KICBdCn0K

> CONTrol:INPut:EMITter:DESTINATION "udp://192.168.4.23:8100"

> CONTrol:INPut:EMITter:CONFig:COUNt 10

> CONTrol:INPut:EDGE falling
# enable the emission of spectra upon falling edges
> CONTrol:INPut:EMITter:SAMPles?
# lists the last 5 spectral samples
ewogICJzcGVjdHJhIjogWwogIC...AuLi4KICAgIH0KICBdCn0K

`STATus` - Status of triggered out-of-band spectral emission

query only

CONTrol:INPut:EMITter:STATus? query provides details about the currently emitted spectra status (see appendix Emitter status. Logging messages and events occurring while spectral data is emitted to the destination is collected and available by querying CONTrol:INPut:EMITter:STATus:LOG? In addition, the number of emitted spectra since the last reconfiguration can be obtained from querying CONTrol:INPut:EMITter:STATus:ECOunt?. The currently achieved sample rate is provided by CONTrol:INPut:EMITter:STATus:RATE.

Parent path: CONTrol:INPut:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:STATus`	returns the current status of the emission to the destination	-
`:ECOunt`	returns the number of emitted spectra since the last configuration change	-
`:LOG`	returns the last notable emitter events since the last configuration change	-
`:RATE`	returns the currently achieved sample rate since the last configuration change	-

Example:

> CONTrol:INPut:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:INPut:EMITter:STATus?
idle
> CONTrol:INPut:EMITter:CONFig:COUNt 10

> CONTrol:INPut:EDGE any
# enable the emission of spectra upon any detected edge
> CONTrol:INPut:EMITter:STATus?
busy
> CONTrol:INPut:EMITter:STATus:ECOunt?
10
> CONTrol:INPut:EMITter:STATus?
idle
> CONTrol:INPut:EMITter:STATus:LOG?
# some notable events

`:MANual` - Manual out-of-band emission control

command and query

Beside external triggered emission of spectral samples (CONTrol:INPut:EMITter), the Spektralwerk Core allows a user to manual run the emission of spectral samples to a destination, independent of the emission triggered by an incoming signal.

Parent path: CONTrol:MANual

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:RUN`	returns whether the emission is running or not	`<BOOLEAN>`: starts/stops the emission of spectra

Example:

> CONTrol:MANual:DESTination "udp://192.168.4.23:8100"

> CONTrol:MANual:CONFig:COUNt 0

> CONTrol:MANual:RUN 1

> CONTrol:MANual:STATus?
busy
> CONTrol:MANual:RUN?
1
> CONTrol:MANual:RUN 0

> CONTrol:MANual:STATus?
idle

`EMITter` - Manual triggered out-of-band- spectral emission

The CONTrol:MANual:EMITter parent path allows a user to start an out-of-band emission of spectra to a destination.

`CONFig` - Configuration of the manual out-of-band spectral emission

command and query

Analogous to the configuration of in-band spectral retrieval MEASure:SPECtrum:REQuest:CONFig, CONTrol:MANual:EMITter:CONFig allows the configuration of a user controlled emission of spectral samples. The emission will not start until a valid destination is provide (CONTrol:MANual:EMITter:DESTination). More details about the configuration possibilities can be found in MEASure:SPECtrum:REQuest:CONFig.

Parent path CONTrol:MANual:EMITter:CONFig

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:COUNt`	returns the number of spectra returned from out-of-band emission.	`<INTEGER>`: set the number of spectra returned from out-of-band emission.
`:FORMat`	returns format of the spectra to be returned from out-of-band emission.	`<OUTPUT_FORMAT>`: set the number of spectra to be returned from out-of-band emission.
`:PROCessing`	returns the applied processing steps to be applied on spectral emission	`<PROCESSING_STEPS>`: set the processing steps to be applied on spectral emission.
`:ROI`	returns the currently set region-of-interest (ROI).	`<INTEGER,INTEGER>`: set the first and last pixel for region of interest.
`:FREQuency`	returns the current sampling frequency.	`<FLOAT>`: set sampling frequency.
`:UNIT`	returns the unit of frequency	-

Example:

> CONTrol:MANual:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:MANual:EMITter:CONFig:COUNt?
1
> CONTrol:MANual:EMITter:CONFig:COUNt 10

> CONTrol:MANual:EMITter:CONFig:COUNt?
10
> CONTrol:MANual:EMITter:CONFig:FORMat?
human
> CONTrol:MANual:EMITter:CONFig:FORMat base64_int16

> CONTrol:MANual:EMITter:CONFig:FORMat?
base64_int16
> CONTrol:MANual:EMITter:CONFig:PROCessing?
# no processing is enabled by default
> CONTrol:MANual:EMITter:CONFig:PROCessing reference_light,average

> CONTrol:MANual:EMITter:CONFig:PROCessing?
reference_light,average
> CONTrol:MANual:EMITter:CONFig:ROI?
0,255
> CONTrol:MANual:EMITter:CONFig:ROI 100,200

> CONTrol:MANual:EMITter:CONFig:ROI?
100,200
> CONTrol:MANual:EMITter:CONFig:FREQuency?
0
> CONTrol:MANual:EMITter:CONFig:FREQuency 10

> CONTrol:MANual:EMITter:CONFig:FREQuency?
10
> CONTrol:MANual:EMITter:CONFig:FREQuency:UNIT?
Hz

`:DESTination` - Emitted spectra destination

The destination of the spectral samples can be adjusted using CONTrol:MANual:EMITter:DESTination. The provided path must be a a valid tcp or udp uri.

Parent path CONTrol:MANual:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:DESTination`	returns the current destination for the emission of spectral data	`<STRING>`: uri of the destination for the emissioned spectra

Example:

> CONTrol:MANual:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:MANual:EMITter:DESTination?
"udp://192.168.4.23:8100"
> CONTrol:MANual:RUN 1
# upon receiving an input trigger signal, the emission of spectra to the destination starts

`:SAMPles` - Previously emitted spectra

query only

Emitting spectra using the CONTrol:MANual:EMITter will not return any spectra in-band. CONTrol:MANual:EMITter:SAMPles provides some impression of the delivered spectra since the last five spectra delivered are stored as a base64 encoded string.

Parent path: CONTrol:MANual:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:SAMPles`	returns the last five delivered spectra to a destination	-

Example:

// Spectral samples are `json` formatted:
{
  "spectra": [
    {
      "timestamp": 123,
      "pixel_intensities": [0.3, 0.8, ...,1.0, 0.73]
    },
    {
      ...
    }
  ]
}
// This will result in a base64 string:
// ewogICJzcGVjdHJhIjogWwogIC...AuLi4KICAgIH0KICBdCn0K

> CONTrol:MANual:EMITter:DESTINATION "udp://192.168.4.23:8100"

> CONTrol:MANual:EMITter:CONFig:COUNt 10

> CONTrol:MANual:RUN 1

> CONTrol:MANual:EMITter:SAMPles?
# lists the last 5 spectral samples
ewogICJzcGVjdHJhIjogWwogIC...AuLi4KICAgIH0KICBdCn0K

`STATus` - Status of the manual out-of-band spectral emission

query only

CONTrol:MANual:EMITter:STATus? query provides details about the currently emitted spectra status (see appendix Emitter status. Logging messages and events occurring while spectral data is emitted to the destination is collected and available by querying CONTrol:MANual:EMITter:STATus:LOG? In addition, the number of emitted spectra since the last reconfiguration can be obtained from querying CONTrol:MANual:EMITter:STATus:ECOunt?. The currently achieved sample rate is provided by CONTrol:MANual:EMITter:STATus:RATE.

Parent path: CONTrol:MANual:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:STATus`	returns the current status of the emission to the destination	-
`:ECOunt`	returns the number of emitted spectra since the last configuration change	-
`:LOG`	returns the last notable emitter events since the last configuration change	-
`:RATE`	returns the currently achieved sample rate since the last configuration change	-

Example:

> CONTrol:MANual:EMITter:DESTination "udp://192.168.4.23:8100"

> CONTrol:MANual:EMITter:STATus?
idle
> CONTrol:MANual:EMITter:CONFig:COUNt 10

> CONTrol:MANual:RUN 1

> CONTrol:MANual:EMITter:STATus?
busy
> CONTrol:MANual:EMITter:STATus:ECOunt?
10
> CONTrol:MANual:RUN?
0
> CONTrol:MANual:EMITter:STATus?
idle
> CONTrol:MANual:EMITter:STATus:LOG?
# some notable events

Parent path: CONTrol:MANual:EMITter

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:STATus`	returns the current status of the emission to the destination	-
`:ECOunt`	returns the number of emitted spectra since the last configuration change	-
`:LOG`	returns the last notable emitter events since the last configuration change	-
`:RATE`	returns the currently achieved sample rate since the last configuration change	-

`:OUTPut` - Outgoing signal control

command and query

The CONTrol:OUTPut command enables and configures the control of an external device by the Spektralwerk Core device. The CONTrol:OUTPut:SOURce can be either manual or sampling (default), see appendix Trigger output source for more details.

Parent path: CONTrol:OUTPut

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:ENABled`	returns the status of the output trigger	: enables/disables the output trigger
`:LEVel:TARGet`	returns the output line's target level during the phase of activity	`<BOOLEAN>`: set the output line's target value
`:SOURce`	returns the current origin for triggering the output	`<TRIGGER_OUTPUT_SOURCE>`: change the origin for triggering the output

Example:

> CONTrol:OUTPut:SOURce?
sampling

`:DELay` - Delayed sample handling

command and query

The sample emission using the trigger can be delayed using the CONTrol:OUTPut:DELay path.

Parent path: CONTrol:OUTPut:DELay

SCPI String	Query `?`	Command `[<INPUT VALUE>]`
`:STARt`	returns the delay between level change and sampling start	`<FLOAT>`: changes the delay between level change and sampling start
`:UNIT`	returns the unit of the start delay	-
`:END`	returns the delay between end of measurement and output level change	`<FLOAT>`: changes the delay between end of measurement and output level change
`:UNIT`	returns the unit of the delay	-

Example:

> CONTrol:OUTPut:DELay:STARt:UNIT?
s
> CONTrol:OUTPut:DELay:STARt 2.5

# 2.5 seconds after an incoming trigger event, the emission starts
> CONTrol:OUTPut:ENABled 1

> CONTrol:OUTPut:DELay:END:UNIT?
s
> CONTrol:OUTPut:DELay:END 3.2
# 3.2 seconds after the spectral emission ended, the output is triggered.

CONTrol - Control adjustments

:INDicator:STATus - Status LED behavior control

:INPut - Incoming signal control

:EMITter - External triggered out-of-band spectral emission

CONFig - Configuration of triggered out-of-band spectral emission

:DESTination - Emitted spectra destination

:SAMPles - Previously emitted spectra

STATus - Status of triggered out-of-band spectral emission

:MANual - Manual out-of-band emission control

EMITter - Manual triggered out-of-band- spectral emission

CONFig - Configuration of the manual out-of-band spectral emission

:DESTination - Emitted spectra destination

:SAMPles - Previously emitted spectra

STATus - Status of the manual out-of-band spectral emission

:OUTPut - Outgoing signal control

:DELay - Delayed sample handling

`CONTrol` - Control adjustments

`:INDicator:STATus` - Status LED behavior control

`:INPut` - Incoming signal control

`:EMITter` - External triggered out-of-band spectral emission

`CONFig` - Configuration of triggered out-of-band spectral emission

`:DESTination` - Emitted spectra destination

`:SAMPles` - Previously emitted spectra

`STATus` - Status of triggered out-of-band spectral emission

`:MANual` - Manual out-of-band emission control

`EMITter` - Manual triggered out-of-band- spectral emission

`CONFig` - Configuration of the manual out-of-band spectral emission

`:DESTination` - Emitted spectra destination

`:SAMPles` - Previously emitted spectra

`STATus` - Status of the manual out-of-band spectral emission

`:OUTPut` - Outgoing signal control

`:DELay` - Delayed sample handling