:tocdepth: 3 ############ Electrometer ############ .. note:: This page is generated by the following python script ``generate_cet.py``. :ref:`Back to table ` Commands -------- .. _Electrometer:Commands:performZeroCalib: performZeroCalib ~~~~~~~~~~~~~~~~ **Description**: Performs a zero correction in the device. It's recommended to perform this zero correction every time the range changes. The steps taken to perform this comes from the datasheet 6517B-901-01 Rev. B / June 2009 under Zero correct. It is as following. 1- Enable Zero check, 2- Set unit to read, 3- Set range to measure 4- Enable Zero Correction 5- Disable Zero check. For unit and range, it uses the last values selected, either via command or from the configuration file :EFDB_Topic: Electrometer_command_performZeroCalib .. _Electrometer:Commands:performZeroCalib:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Attribute required by the API, but is unused .. _Electrometer:Commands:setDigitalFilter: 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 .. _Electrometer:Commands:setDigitalFilter:activateFilter: 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 .. _Electrometer:Commands:setDigitalFilter:activateAvgFilter: 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 .. _Electrometer:Commands:setDigitalFilter:activateMedFilter: 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 .. _Electrometer:Commands:setIntegrationTime: 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 .. _Electrometer:Commands:setIntegrationTime:intTime: intTime ******* :IDL_Type: float :Units: second **Description**: Integration rate in seconds (166.67e-6 to 200e-3) for each sample .. _Electrometer:Commands:setMode: setMode ~~~~~~~ **Description**: Set unit to measure, the possibilities are: Current, Voltage, Charge or Resistance :EFDB_Topic: Electrometer_command_setMode .. _Electrometer:Commands:setMode:mode: 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 .. _Electrometer:Commands:setRange: setRange ~~~~~~~~ **Description**: Set measurement range, it will use the current unit selected :EFDB_Topic: Electrometer_command_setRange .. _Electrometer:Commands:setRange: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 .. _Electrometer:Commands:startScan: 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 .. _Electrometer:Commands:startScan:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Attribute required by the API, but is unused .. _Electrometer:Commands:startScanDt: 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 .. _Electrometer:Commands:startScanDt:scanDuration: 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 .. _Electrometer:Commands:stopScan: 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 .. _Electrometer:Commands:stopScan:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Attribute required by the API, but is unused abort ~~~~~ :EFDB_Topic: SALGeneric_command_abort .. _Electrometer:abort:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used disable ~~~~~~~ **Description**: Transition from state Enabled to Disabled. :EFDB_Topic: SALGeneric_command_disable .. _Electrometer:disable:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used enable ~~~~~~ **Description**: Transition from state Disabled to Enabled. :EFDB_Topic: SALGeneric_command_enable .. _Electrometer:enable:value: 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 .. _Electrometer:enterControl:value: 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 .. _Electrometer:exitControl:value: value ***** :IDL_Type: boolean :Units: unitless **Description**: Not used setAuthList ~~~~~~~~~~~ :EFDB_Topic: SALGeneric_command_setAuthList .. _Electrometer:setAuthList:authorizedUsers: 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. .. _Electrometer:setAuthList:nonAuthorizedCSCs: 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 .. _Electrometer:setLogLevel:level: 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 .. _Electrometer:setValue:parametersAndValues: 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 .. _Electrometer:standby:value: 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 .. _Electrometer:start:settingsToApply: settingsToApply *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: Name of the selected settings set Enumerations ------------ :DetailedState: * DisabledState * EnabledState * FaultState * OfflineState * StandbyState * NotReadingState * ConfiguringState * ManualReadingState * ReadingBufferState * SetDurationReadingState :SummaryState: * DisabledState * EnabledState * FaultState * OfflineState * StandbyState :UnitToRead: * Current * Charge Events ------ .. _Electrometer:Events:detailedState: detailedState ~~~~~~~~~~~~~ :EFDB_Topic: Electrometer_logevent_detailedState .. _Electrometer:Events:detailedState: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. .. _Electrometer:Events:deviceErrorCode: deviceErrorCode ~~~~~~~~~~~~~~~ **Description**: None :EFDB_Topic: Electrometer_logevent_deviceErrorCode .. _Electrometer:Events:deviceErrorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: The error code being published. This code is the same as the one that the Electrometer publishes .. _Electrometer:Events:deviceErrorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: Handle a few sentences of higher-level information describing the error. .. _Electrometer:Events:digitalFilterChange: digitalFilterChange ~~~~~~~~~~~~~~~~~~~ **Description**: Current update in the digital filter setup inside the Electrometer controller :EFDB_Topic: Electrometer_logevent_digitalFilterChange .. _Electrometer:Events:digitalFilterChange:activateFilter: 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 .. _Electrometer:Events:digitalFilterChange:activateMedianFilter: activateMedianFilter ******************** :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 active and 0 for not active .. _Electrometer:Events:digitalFilterChange:activateAverageFilter: 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 .. _Electrometer:Events:integrationTime: integrationTime ~~~~~~~~~~~~~~~ **Description**: Integration rate, this will directly affect reading rates :EFDB_Topic: Electrometer_logevent_integrationTime .. _Electrometer:Events:integrationTime:intTime: intTime ******* :IDL_Type: float :Units: second **Description**: Integration rate in seconds (166.67e-6 to 200e-3) .. _Electrometer:Events:intensity: intensity ~~~~~~~~~ **Description**: Intensity of light measured with the photo-diode in the unit previously configured :EFDB_Topic: Electrometer_logevent_intensity .. _Electrometer:Events:intensity:intensity: intensity ********* :IDL_Type: double :Units: unitless **Description**: Measure read by the device .. _Electrometer:Events:intensity:unit: unit **** :IDL_Type: string :Units: unitless **Description**: Unit used .. _Electrometer:Events:intensity:timestamp: timestamp ********* :IDL_Type: double :Units: second **Description**: Timestamp when the measurement was taken .. _Electrometer:Events:largeFileObjectAvailable: largeFileObjectAvailable ~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: Electrometer_logevent_largeFileObjectAvailable .. _Electrometer:Events:largeFileObjectAvailable:url: 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. .. _Electrometer:Events:largeFileObjectAvailable:generator: generator ********* :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: Name of the package which generated the file being announced .. _Electrometer:Events:largeFileObjectAvailable:version: version ******* :IDL_Type: float :Units: unitless **Description**: A dotted x.y version number denoting the file format revision .. _Electrometer:Events:largeFileObjectAvailable:checkSum: checkSum ******** :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: Hexadecimal character string holding the checksum of the file .. _Electrometer:Events:largeFileObjectAvailable:mimeType: mimeType ******** :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: Mime Type code for the file .. _Electrometer:Events:largeFileObjectAvailable:byteSize: byteSize ******** :IDL_Type: long :Units: unitless **Description**: Size of file in bytes .. _Electrometer:Events:largeFileObjectAvailable:id: id ** :IDL_Type: string :IDL_Size: 32 :Units: unitless **Description**: A generic identifier field .. _Electrometer:Events:measureRange: 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 .. _Electrometer:Events:measureRange:rangeValue: rangeValue ********** :IDL_Type: double :Units: unitless **Description**: The range for the intensity for measure selected. .. _Electrometer:Events:measureType: measureType ~~~~~~~~~~~ **Description**: Current mode selected to read from the photodiode :EFDB_Topic: Electrometer_logevent_measureType .. _Electrometer:Events:measureType:mode: mode **** :IDL_Type: long :Units: unitless **Description**: mode: 1- Current, 2- Charge, 3- Voltage, 4- Resistance .. _Electrometer:Events:settingsAppliedReadSets: settingsAppliedReadSets ~~~~~~~~~~~~~~~~~~~~~~~ **Description**: Initial configuration of the electrometer, this has been set in the current configuration file in use :EFDB_Topic: Electrometer_logevent_settingsAppliedReadSets .. _Electrometer:Events:settingsAppliedReadSets:filterActive: filterActive ************ :IDL_Type: boolean :Units: unitless **Description**: Digital Filter configuration. If this is OFF, none of the filters will operate .. _Electrometer:Events:settingsAppliedReadSets:avgFilterActive: 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 .. _Electrometer:Events:settingsAppliedReadSets:inputRange: inputRange ********** :IDL_Type: double :Units: unitless **Description**: Ranges use to read values from the photodiode using the current Mode. -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 .. _Electrometer:Events:settingsAppliedReadSets:integrationTime: 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 .. _Electrometer:Events:settingsAppliedReadSets:medianFilterActive: medianFilterActive ****************** :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, true for ON and False for OFF .. _Electrometer:Events:settingsAppliedReadSets:mode: mode **** :IDL_Type: long :Units: unitless **Description**: Mode used in the configuration file, 0-Current, 1-Charge, 2-Voltage, 3-Resistance .. _Electrometer:Events:settingsAppliedSerConf: 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 .. _Electrometer:Events:settingsAppliedSerConf:visaResource: visaResource ************ :IDL_Type: string :Units: unitless **Description**: Visa resource or port .. _Electrometer:Events:settingsAppliedSerConf:baudRate: baudRate ******** :IDL_Type: long :Units: unitless **Description**: Baud rate as a number. Allowed values are: 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200 .. _Electrometer:Events:settingsAppliedSerConf:parity: parity ****** :IDL_Type: long :Units: unitless **Description**: Parity checking. PARITY_NONE=0, PARITY_EVEN=1, PARITY_ODD=2, PARITY_MARK=3, PARITY_SPACE=4 .. _Electrometer:Events:settingsAppliedSerConf:dataBits: dataBits ******** :IDL_Type: long :Units: unitless **Description**: Number of data bits. Possible values: 5, 6, 7, 8 .. _Electrometer:Events:settingsAppliedSerConf:stopBits: stopBits ******** :IDL_Type: long :Units: unitless **Description**: Number of stop bits. Possible values: 1, 2 .. _Electrometer:Events:settingsAppliedSerConf:timeout: timeout ******* :IDL_Type: float :Units: unitless **Description**: time out in seconds .. _Electrometer:Events:settingsAppliedSerConf:termChar: termChar ******** :IDL_Type: string :Units: unitless **Description**: termination char, endl for end line .. _Electrometer:Events:settingsAppliedSerConf:xonxoff: xonxoff ******* :IDL_Type: boolean :Units: unitless **Description**: Software flow control. .. _Electrometer:Events:settingsAppliedSerConf:dsrdtr: dsrdtr ****** :IDL_Type: boolean :Units: unitless **Description**: hardware (DSR/DTR) flow control .. _Electrometer:Events:settingsAppliedSerConf:bytesToRead: bytesToRead *********** :IDL_Type: long :Units: unitless **Description**: The maximum amount of bytes to read appliedSettingsMatchStart ~~~~~~~~~~~~~~~~~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_appliedSettingsMatchStart .. _Electrometer:appliedSettingsMatchStart:appliedSettingsMatchStartIsTrue: appliedSettingsMatchStartIsTrue ******************************* :IDL_Type: boolean :Units: unitless **Description**: True when the configuration matches the start conditions authList ~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_authList .. _Electrometer:authList:authorizedUsers: authorizedUsers *************** :IDL_Type: string :Units: unitless **Description**: Comma seperated list of authorized users currently allowed to command this CSC. .. _Electrometer:authList:nonAuthorizedCSCs: 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 .. _Electrometer:errorCode:errorCode: errorCode ********* :IDL_Type: long :Units: unitless **Description**: A numeric error code .. _Electrometer:errorCode:errorReport: errorReport *********** :IDL_Type: string :Units: unitless **Description**: An string providing detailed information about the error .. _Electrometer:errorCode:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: An optional stack trace of the error condition heartbeat ~~~~~~~~~ :EFDB_Topic: SALGeneric_logevent_heartbeat .. _Electrometer:heartbeat:heartbeat: heartbeat ********* :IDL_Type: boolean :Units: unitless **Description**: Beats the drum. logLevel ~~~~~~~~ **Description**: Current logging level. :EFDB_Topic: SALGeneric_logevent_logLevel .. _Electrometer:logLevel:level: 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 .. _Electrometer:logMessage:name: name **** :IDL_Type: string :Units: unitless **Description**: Log name. .. _Electrometer:logMessage:level: level ***** :IDL_Type: int :Units: unitless **Description**: Message level, a Python logging level: error=40, warning=30, info=20, debug=10. .. _Electrometer:logMessage:message: message ******* :IDL_Type: string :Units: unitless **Description**: Log message. .. _Electrometer:logMessage:traceback: traceback ********* :IDL_Type: string :Units: unitless **Description**: Exception traceback; "" if not an exception. .. _Electrometer:logMessage:filePath: filePath ******** :IDL_Type: string :Units: unitless **Description**: Path to source file. .. _Electrometer:logMessage:functionName: functionName ************ :IDL_Type: string :Units: unitless **Description**: Function or method name. .. _Electrometer:logMessage:lineNumber: lineNumber ********** :IDL_Type: long :Units: unitless **Description**: Line number in the file specified by filePath. .. _Electrometer:logMessage:process: 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 .. _Electrometer:settingVersions:recommendedSettingsVersion: recommendedSettingsVersion ************************** :IDL_Type: string :Units: unitless **Description**: List of comma seperated recomended versions of settings sets .. _Electrometer:settingVersions:recommendedSettingsLabels: recommendedSettingsLabels ************************* :IDL_Type: string :Units: unitless **Description**: List of comma seperated names of settings sets .. _Electrometer:settingVersions:settingsUrl: 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 .. _Electrometer:settingsApplied:settingsVersion: settingsVersion *************** :IDL_Type: string :IDL_Size: 256 :Units: unitless **Description**: The SHA or name corresponding to the published configuration .. _Electrometer:settingsApplied:otherSettingsEvents: 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 .. _Electrometer:simulationMode:mode: 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 .. _Electrometer:softwareVersions:salVersion: salVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of SAL generation .. _Electrometer:softwareVersions:xmlVersion: xmlVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of CSC XML .. _Electrometer:softwareVersions:openSpliceVersion: openSpliceVersion ***************** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the current version of OpenSplice .. _Electrometer:softwareVersions:cscVersion: cscVersion ********** :IDL_Type: string :IDL_Size: 16 :Units: unitless **Description**: This is the top-level version of the CSC .. _Electrometer:softwareVersions:subsystemVersions: 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 .. _Electrometer:summaryState:summaryState: summaryState ************ :IDL_Type: long :Units: unitless **Description**: High level state machine state identifier