LeCroy Satellite#

Name	LeCroy
Description	Satellite controlling a LeCroy oscilloscope using the LeCrunch library
Category	Oscilloscopes
Language	Python

Description#

This satellite uses the LeCrunch3 library by Nicola Minafra, based on LeCrunch2 and LeCrunch, to control and fetch each channel waveform from a LeCroy Waverunner series scope. Using a TCP connection to the scope’s Waverunner software, it provides a simplified method to start a single- or sequenced-waveform acquisition and transmits it through the CDTP to Constellation receivers.

Requirements#

This satellite requires the [lecroy] component, which can be installed with:

PyPI

pip install ConstellationDAQ[lecroy]

Source

pip install --no-build-isolation -e .[lecroy]

Supported devices#

This satellite is compatible with a broad class of Teledyne-LeCroy devices, and was successfully tested with a Waverunner 8104. The device to be controlled by this satellite can be accessed via the ip_address and port configuration parameters. By default the port is set to 1861 by the embedded acquisition software.

To set up the TCP transfer, run the “Utilities Setup” from the “Utilities” menu, switch to the “Remote” tab and enable the “TCPIP (VICP)” option. The IP address to use in this satellite will be provided beside the selection box.

Parameters#

Parameter	Description	Type	Default Value
`ip_address`	Scope IP address	String	-
`port`	TCP port to connect to	Integer	1861
`timeout`	Timeout before giving up on frames retrieval	Float	5s
`nsequence`	Number of triggers to combine in a readout in sequence mode	Integer	1

Metrics#

Metric	Description	Value Type	Interval
`NUM_TRIGGERS`	Number of triggers collected so far	Integer	10s

Custom Commands#

Command	Description	Arguments	Return Value	Allowed States
`get_num_triggers`	Retrieve the number of triggers collected so far	-	Integer	any

Output data format#

Data are packed as follows, using double precision floats for each word:

Group	Word	Description
Global header	Trigger times	Absolute timing of each trigger in the sequence
	Number of samples	Number of samples in all triggers in all sequences (run-level)
Channel header	Trigger offsets	Channel-level timing offset (with respect to the absolute timing in the global header) of each individual trigger in the sequence
	Wave array	Number of samples * number of triggers/sequence double precision floats providing the sample amplitude (in V) for the given time slice

Additionally, a beginning-of-run event is generated with the following attributes:

Parameter	Description	Type
`trigger_delay`	Absolute timing for the first trigger	String
`sampling_period`	Sampling period (in s)	Float
`channels`	Comma-separated list of channels enabled in readout	[Integers]
`num_sequences`	Number of triggers combined in a readout in sequence mode	Integer

Framework Parameters#

This satellite interprets the following configuration parameter that are provided through the Constellation framework. Parameters have to be placed in their respective configuration section.

Data Transmission#

The following parameters control the data transmission of this satellite and have to be provided in the _data section:

Parameter	Type	Description	Default Value
`disable_transmission`	Boolean	Disable data transmission. This parameter turns off transmission of data to receiver satellites and instead ignores and drops all data records.	`false`
`bor_timeout`	Unsigned integer	Timeout in seconds to send the BOR message. The satellite will attempt for this interval to send the message and goes into `ERROR` state if it fails to do so. A possible reason for failure is that no receiver satellite connected to this satellite and is receiving data.	10
`eor_timeout`	Unsigned integer	Timeout in seconds to send the EOR message. The satellite will attempt for this interval to send the message and goes into `ERROR` state if it fails to do so.	10
`data_timeout`	Unsigned integer	Timeout in seconds to send the data message. The satellite will attempt for this interval to send the message and goes into `ERROR` state if it fails to do so.	10
`payload_threshold`	Unsigned integer	Threshold for sending data messages in KiB. The satellite will only send queued data records after the combined payload size of the data records has reached this threshold.	128
`_queue_size`	Unsigned integer	Size of the queue for the data records. Small values might lead to performance issues, large values lead to larger memory usage.	32768
`license`	String	License this data is recorded under. Defaults to the Open Data Commons Attribution License. This information will be added to the run metadata.	`ODC-By-1.0`

Autonomous Operation#

Parameters to control autonomy in the _autonomy section:

Parameter	Type	Description	Default Value
`role`	Role name	Role this satellite should take in the Constellation. Accepted values are `ESSENTIAL`, `DYNAMIC`, `TRANSIENT` and `NONE`.	`DYNAMIC`
`max_heartbeat_interval`	Unsigned integer	Maximum interval in seconds between heartbeats to be sent to other Constellation components. The time between heartbeat is adjusted automatically according to the number of nodes in the Constellation but will never exceed this value.	`30`

Conditional Transitions#

Parameters to control conditional transitions in the _conditions section:

Parameter	Type	Description	Default Value
`require_initializing_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `initializing` state	-
`require_launching_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `launching` state	-
`require_landing_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `landing` state	-
`require_starting_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `starting` state	-
`require_stopping_after`	List of strings	List of canonical names of remote satellites for conditional transitioning in `stopping` state	-
`transition_timeout`	Unsigned integer	Timeout in seconds to wait for all conditions to be satisfied for conditional transitioning	`30`

Framework Metrics#

This satellite provides the following metrics that are defined by the Constellation framework.

Data Transmission#

Metric	Description	Value Type	Interval
`TX_BYTES`	Amount of bytes transmitted during current run	Integer	5s
`TX_RECORDS`	Number of data records transmitted during current run	Integer	5s

Basic Satellite Metrics#

Metric	Description	Value Type	Interval
`RUN_ID`	Current run identifier. Updated whenever it changes.	String	-
`STATE`	Current satellite state. Updated when changed.	String	-
`CPU_LOAD_AVG`	CPU load average over the past 1 minute, provided in percent.	Float	10s
`MEM_AVAIL`	Available memory in Megabytes.	Integer	10s