Commands
setDigitalFilter
Description: Configure the digital filter inside the Electrometer controller. Be aware that activating any filters will reduce the number of readings per second the device will be able to handle
EFDB_Topic: | Electrometer_command_setDigitalFilter |
activateFilter
IDL_Type: | boolean |
Units: | unitless |
Description: Activate the filter. If this is OFF (set to 0), none of the filters will operate regardless of their settings below
activateAvgFilter
IDL_Type: | boolean |
Units: | unitless |
Description: Activate the average filter inside the electrometer, it uses the Default value inside the device (last 10 readings) to do the average calculation, 1 for ON and 0 for OFF
activateMedFilter
IDL_Type: | boolean |
Units: | unitless |
Description: The median filter is used to determine the middle-most reading from a group of readings that are arranged according to size. Activate the median filter inside the electrometer, 1 for ON and 0 for OFF
setIntegrationTime
Description: This is the length of time for a given sample from the electrometer, however, due to the time it takes to read the buffer and process the data, this is not the rate at which samples are taken
EFDB_Topic: | Electrometer_command_setIntegrationTime |
intTime
IDL_Type: | float |
Units: | second |
Description: Integration rate in seconds (166.67e-6 to 200e-3) for each sample
setMode
Description: Set unit to measure, the possibilities are: Current, Voltage, Charge or Resistance
EFDB_Topic: | Electrometer_command_setMode |
mode
IDL_Type: | long |
Units: | unitless |
Description: Set electrometer to use different modes: 1.- Current 2.- Volt 3.- Charge 4.- Resistance. The units will depend on the current settings
setRange
Description: Set measurement range, it will use the current unit selected
EFDB_Topic: | Electrometer_command_setRange |
setRange
IDL_Type: | float |
Units: | unitless |
Description: -1 for automatic range. Volts range from 0 to 210 Volts, Current range from 0 to 21e-3 Amps, Resistance from 0 to 100e18 Ohms, Charge from 0 to +2.1e-6 Coulombs
startScan
Description: Start storing readings inside the electrometer buffer, this command will change detailedState from NotReadingState to ManualReadingState and continues storing data into the buffer. The data will be published to the LFO when stopScan command is received or a timeout occurs (300 seconds)
EFDB_Topic: | Electrometer_command_startScan |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Attribute required by the API, but is unused
startScanDt
Description: Start storing readings inside the electrometer buffer for a fixed time, this command will change detailedState from NotReadingState to SetDurationReadingState and to stop storing data into the buffer and publish the LFO there are 2 possibilities. Reading during scanDuration time input in the command or sending a stopScan command
EFDB_Topic: | Electrometer_command_startScanDt |
scanDuration
IDL_Type: | float |
Units: | second |
Description: Time in seconds from the start of the reading until the stop and then store into the FITS file. The start of the scan will take about 0.2seconds which is what the device takes to start the reading process
stopScan
Description: Command to stop a current reading process, when it finishes stopping the process it will read the data from the buffer and will publish the LFO event
EFDB_Topic: | Electrometer_command_stopScan |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Attribute required by the API, but is unused
abort
EFDB_Topic: | SALGeneric_command_abort |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
disable
Description: Transition from state Enabled to Disabled.
EFDB_Topic: | SALGeneric_command_disable |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
enable
Description: Transition from state Disabled to Enabled.
EFDB_Topic: | SALGeneric_command_enable |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
enterControl
Description: Transition from state Offline to Standby. Only “externally commandable” CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.
EFDB_Topic: | SALGeneric_command_enterControl |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
exitControl
Description: Transition from state Standby to Offline. For CSCs that are not “externally commandable” this makes the CSC quit.
EFDB_Topic: | SALGeneric_command_exitControl |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
setAuthList
EFDB_Topic: | SALGeneric_command_setAuthList |
authorizedUsers
IDL_Type: | string |
Units: | unitless |
- Description: Comma seperated list of authorized users currently allowed to command this CSC,
- in the form user@host.
If the first character is +/- then the specified users are added/removed.
Duplicates are silently ignored.
The CSC’s own user@host is silently ignored, because it is always authorized.
For removal, CSCs that are not in the list are silently ignored.
Whitespace is allowed after the optional initial +/- and after each comma.
nonAuthorizedCSCs
IDL_Type: | string |
Units: | unitless |
- Description: Comma seperated list of CSC’s not currently allowed to command this CSC,
- in the form name[:index]. An index of 0 is stripped (name:0 becomes name).
If the first character is +/- then the specified CSCs are added/removed.
Duplicates are silently ignored.
For removal, CSCs that are not in the list are silently ignored.
Whitespace is allowed after the optional initial +/- and after each comma.
setLogLevel
Description: Set the logging level.
EFDB_Topic: | SALGeneric_command_setLogLevel |
level
IDL_Type: | int |
Units: | unitless |
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
setValue
EFDB_Topic: | SALGeneric_command_setValue |
parametersAndValues
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: List of parameters and their values as a Json string
standby
Description: Transition from state Offline, Disabled or Fault to Standby.
EFDB_Topic: | SALGeneric_command_standby |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
start
Description: Transition from state Standby to Disable, in a specified configuration.
EFDB_Topic: | SALGeneric_command_start |
settingsToApply
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: Name of the selected settings set
Events
detailedState
EFDB_Topic: | Electrometer_logevent_detailedState |
detailedState
IDL_Type: | long |
Units: | unitless |
Description: An enumeration indicating the Electrometer detailed state. See the DetailedStateValue enumeration defined on top of this document.
deviceErrorCode
Description: None
EFDB_Topic: | Electrometer_logevent_deviceErrorCode |
errorCode
IDL_Type: | long |
Units: | unitless |
Description: The error code being published. This code is the same as the one that the Electrometer publishes
errorReport
IDL_Type: | string |
Units: | unitless |
Description: Handle a few sentences of higher-level information describing the error.
digitalFilterChange
Description: Current update in the digital filter setup inside the Electrometer controller
EFDB_Topic: | Electrometer_logevent_digitalFilterChange |
activateFilter
IDL_Type: | boolean |
Units: | unitless |
Description: If this is OFF, none of the filters will operate. 0 for not active and 1 for active
activateAverageFilter
IDL_Type: | boolean |
Units: | unitless |
Description: Activate the average filter inside the electrometer, it uses the Default value inside the device (last 10 readings) to do the average calculation, 1 for active and 0 for not active
integrationTime
Description: Integration rate, this will directly affect reading rates
EFDB_Topic: | Electrometer_logevent_integrationTime |
intTime
IDL_Type: | float |
Units: | second |
Description: Integration rate in seconds (166.67e-6 to 200e-3)
intensity
Description: Intensity of light measured with the photo-diode in the unit previously configured
EFDB_Topic: | Electrometer_logevent_intensity |
intensity
IDL_Type: | double |
Units: | unitless |
Description: Measure read by the device
unit
IDL_Type: | string |
Units: | unitless |
Description: Unit used
timestamp
IDL_Type: | double |
Units: | second |
Description: Timestamp when the measurement was taken
largeFileObjectAvailable
EFDB_Topic: | Electrometer_logevent_largeFileObjectAvailable |
url
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: A Uniform Resource Locator which links to a Large File Object
either for ingest into the EFD Large File Annex, or to announce
the successful copy of same to the EFD Large File Annex.
Protocols are those supported by the cURL library.
generator
IDL_Type: | string |
IDL_Size: | 32 |
Units: | unitless |
Description: Name of the package which generated the file being announced
version
IDL_Type: | float |
Units: | unitless |
Description: A dotted x.y version number denoting the file format revision
checkSum
IDL_Type: | string |
IDL_Size: | 32 |
Units: | unitless |
Description: Hexadecimal character string holding the checksum of the file
mimeType
IDL_Type: | string |
IDL_Size: | 32 |
Units: | unitless |
Description: Mime Type code for the file
byteSize
IDL_Type: | long |
Units: | unitless |
Description: Size of file in bytes
id
IDL_Type: | string |
IDL_Size: | 32 |
Units: | unitless |
Description: A generic identifier field
measureRange
Description: Current range, -1 for automatic range. Volts range from 0 to 210V, Current range from 0 to 21e-3Amps, Resistance from 0 to 100e18, Charge from 0 to +2.1e-6
EFDB_Topic: | Electrometer_logevent_measureRange |
rangeValue
IDL_Type: | double |
Units: | unitless |
Description: The range for the intensity for measure selected.
measureType
Description: Current mode selected to read from the photodiode
EFDB_Topic: | Electrometer_logevent_measureType |
mode
IDL_Type: | long |
Units: | unitless |
Description: mode: 1- Current, 2- Charge, 3- Voltage, 4- Resistance
settingsAppliedReadSets
Description: Initial configuration of the electrometer, this has been set in the current configuration file in use
EFDB_Topic: | Electrometer_logevent_settingsAppliedReadSets |
filterActive
IDL_Type: | boolean |
Units: | unitless |
Description: Digital Filter configuration. If this is OFF, none of the filters will operate
avgFilterActive
IDL_Type: | boolean |
Units: | unitless |
Description: Average digital filter status inside the electrometer, it uses the Default value inside the device (last 10 readings) to do the average calculation, true for ON and False for OFF
integrationTime
IDL_Type: | double |
Units: | second |
Description: Integration rate, this will directly affect reading rates but reading rates are not going to be the same as reading rates
mode
IDL_Type: | long |
Units: | unitless |
Description: Mode used in the configuration file, 0-Current, 1-Charge, 2-Voltage, 3-Resistance
settingsAppliedSerConf
Description: Serial configuration for the Electrometer port. This configuration needs to be the same as the one set in the Electrometer device. For proper configuration please read the reference manual 6517B-901-01 Rev. B / June 2009 section Selecting interface parameters
EFDB_Topic: | Electrometer_logevent_settingsAppliedSerConf |
visaResource
IDL_Type: | string |
Units: | unitless |
Description: Visa resource or port
baudRate
IDL_Type: | long |
Units: | unitless |
Description: Baud rate as a number. Allowed values are: 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200
parity
IDL_Type: | long |
Units: | unitless |
Description: Parity checking. PARITY_NONE=0, PARITY_EVEN=1, PARITY_ODD=2, PARITY_MARK=3, PARITY_SPACE=4
dataBits
IDL_Type: | long |
Units: | unitless |
Description: Number of data bits. Possible values: 5, 6, 7, 8
stopBits
IDL_Type: | long |
Units: | unitless |
Description: Number of stop bits. Possible values: 1, 2
timeout
IDL_Type: | float |
Units: | unitless |
Description: time out in seconds
termChar
IDL_Type: | string |
Units: | unitless |
Description: termination char, endl for end line
xonxoff
IDL_Type: | boolean |
Units: | unitless |
Description: Software flow control.
dsrdtr
IDL_Type: | boolean |
Units: | unitless |
Description: hardware (DSR/DTR) flow control
bytesToRead
IDL_Type: | long |
Units: | unitless |
Description: The maximum amount of bytes to read
appliedSettingsMatchStart
EFDB_Topic: | SALGeneric_logevent_appliedSettingsMatchStart |
appliedSettingsMatchStartIsTrue
IDL_Type: | boolean |
Units: | unitless |
Description: True when the configuration matches the start conditions
authList
EFDB_Topic: | SALGeneric_logevent_authList |
authorizedUsers
IDL_Type: | string |
Units: | unitless |
Description: Comma seperated list of authorized users currently allowed to command this CSC.
nonAuthorizedCSCs
IDL_Type: | string |
Units: | unitless |
Description: Comma seperated list of CSC’s not currently allowed to command this CSC.
errorCode
Description: Output when a CSC goes into the Fault state as an explanation of the problem.
EFDB_Topic: | SALGeneric_logevent_errorCode |
errorCode
IDL_Type: | long |
Units: | unitless |
Description: A numeric error code
errorReport
IDL_Type: | string |
Units: | unitless |
Description: An string providing detailed information about the error
traceback
IDL_Type: | string |
Units: | unitless |
Description: An optional stack trace of the error condition
heartbeat
EFDB_Topic: | SALGeneric_logevent_heartbeat |
heartbeat
IDL_Type: | boolean |
Units: | unitless |
Description: Beats the drum.
logLevel
Description: Current logging level.
EFDB_Topic: | SALGeneric_logevent_logLevel |
level
IDL_Type: | int |
Units: | unitless |
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
logMessage
Description: A log message.
EFDB_Topic: | SALGeneric_logevent_logMessage |
name
IDL_Type: | string |
Units: | unitless |
Description: Log name.
level
IDL_Type: | int |
Units: | unitless |
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
message
IDL_Type: | string |
Units: | unitless |
Description: Log message.
traceback
IDL_Type: | string |
Units: | unitless |
Description: Exception traceback; “” if not an exception.
filePath
IDL_Type: | string |
Units: | unitless |
Description: Path to source file.
functionName
IDL_Type: | string |
Units: | unitless |
Description: Function or method name.
lineNumber
IDL_Type: | long |
Units: | unitless |
Description: Line number in the file specified by filePath.
process
IDL_Type: | long |
Units: | unitless |
Description: Process ID.
settingVersions
Description: Information about settings which can be specified in the start command.
EFDB_Topic: | SALGeneric_logevent_settingVersions |
recommendedSettingsVersion
IDL_Type: | string |
Units: | unitless |
Description: List of comma seperated recomended versions of settings sets
recommendedSettingsLabels
IDL_Type: | string |
Units: | unitless |
Description: List of comma seperated names of settings sets
settingsUrl
IDL_Type: | string |
Units: | unitless |
Description: The URL where the settings sets definitions can be found
settingsApplied
Description: Base settings applied.
EFDB_Topic: | SALGeneric_logevent_settingsApplied |
settingsVersion
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: The SHA or name corresponding to the published configuration
otherSettingsEvents
IDL_Type: | string |
Units: | unitless |
Description: A comma delimited list of other specific CSC configuration events. This may be blank if no other CSC specific events are necessary
simulationMode
Description: Current simulation mode.
EFDB_Topic: | SALGeneric_logevent_simulationMode |
mode
IDL_Type: | int |
Units: | unitless |
Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.
softwareVersions
Description: Current versions of software in use by CSC.
EFDB_Topic: | SALGeneric_logevent_softwareVersions |
salVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the current version of SAL generation
xmlVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the current version of CSC XML
openSpliceVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the current version of OpenSplice
cscVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the top-level version of the CSC
subsystemVersions
IDL_Type: | string |
Units: | unitless |
Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within a CSC
summaryState
Description: Current summary state of the CSC
EFDB_Topic: | SALGeneric_logevent_summaryState |
summaryState
IDL_Type: | long |
Units: | unitless |
Description: High level state machine state identifier