Electrometer¶
Commands¶
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_performZeroCalib |
| Explanation: | http://sal.lsst.org |
value¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Attribute required by the API, but is unused
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_setDigitalFilter |
| Explanation: | http://sal.lsst.org |
activateFilter¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
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 |
| Count: | 1 |
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 |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_setIntegrationTime |
| Explanation: | http://sal.lsst.org |
intTime¶
| IDL_Type: | float |
|---|---|
| Units: | second |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_setMode |
| Explanation: | http://sal.lsst.org |
mode¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_setRange |
| Explanation: | http://sal.lsst.org |
setRange¶
| IDL_Type: | float |
|---|---|
| Units: | unitless |
| Count: | 1 |
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)
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_startScan |
| Explanation: | http://sal.lsst.org |
value¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_startScanDt |
| Explanation: | http://sal.lsst.org |
scanDuration¶
| IDL_Type: | float |
|---|---|
| Units: | second |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_command_stopScan |
| Explanation: | http://sal.lsst.org |
value¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Attribute required by the API, but is unused
Events¶
- DetailedState_DisabledState
- DetailedState_EnabledState
- DetailedState_FaultState
- DetailedState_OfflineState
- DetailedState_StandbyState
- DetailedState_NotReadingState
- DetailedState_ConfiguringState
- DetailedState_ManualReadingState
- DetailedState_ReadingBufferState
- DetailedState_SetDurationReadingState
- SummaryState_DisabledState
- SummaryState_EnabledState
- SummaryState_FaultState
- SummaryState_OfflineState
- SummaryState_StandbyState
- UnitToRead_Current
- UnitToRead_Charge
detailedState¶
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_detailedState |
| Explanation: | http://sal.lsst.org |
detailedState¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: An enumeration indicating the Electrometer detailed state. See the DetailedStateValue enumeration defined on top of this document.
digitalFilterChange¶
Description: Current update in the digital filter setup inside the Electrometer controller
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_digitalFilterChange |
| Explanation: | http://sal.lsst.org |
activateFilter¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: If this is OFF, none of the filters will operate. 0 for not active and 1 for active
activateMedianFilter¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
activateAverageFilter¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_integrationTime |
| Explanation: | http://sal.lsst.org |
intTime¶
| IDL_Type: | float |
|---|---|
| Units: | second |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_intensity |
| Explanation: | http://sal.lsst.org |
timestamp¶
| IDL_Type: | double |
|---|---|
| Units: | second |
| Count: | 1 |
Description: Timestamp when the measurement was taken
largeFileObjectAvailable¶
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_largeFileObjectAvailable |
| Explanation: | http://sal.lsst.org |
url¶
| IDL_Type: | string |
|---|---|
| IDL_Size: | 256 |
| Units: | unitless |
| Count: | 1 |
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 |
| Count: | 1 |
Description: Name of the package which generated the file being announced
version¶
| IDL_Type: | float |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: A dotted x.y version number denoting the file format revision
checkSum¶
| IDL_Type: | string |
|---|---|
| IDL_Size: | 32 |
| Units: | unitless |
| Count: | 1 |
Description: Hexadecimal character string holding the checksum of the file
mimeType¶
| IDL_Type: | string |
|---|---|
| IDL_Size: | 32 |
| Units: | unitless |
| Count: | 1 |
Description: Mime Type code for the file
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_measureRange |
| Explanation: | http://sal.lsst.org |
rangeValue¶
| IDL_Type: | double |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: The range for the intensity for measure selected.
measureType¶
Description: Current mode selected to read from the photodiode
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_measureType |
| Explanation: | http://sal.lsst.org |
mode¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_settingsAppliedReadSets |
| Explanation: | http://sal.lsst.org |
filterActive¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Digital Filter configuration. If this is OFF, none of the filters will operate
avgFilterActive¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
inputRange¶
| IDL_Type: | double |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
integrationTime¶
| IDL_Type: | double |
|---|---|
| Units: | second |
| Count: | 1 |
Description: Integration rate, this will directly affect reading rates but reading rates are not going to be the same as reading rates
medianFilterActive¶
| IDL_Type: | boolean |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
mode¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
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
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_settingsAppliedSerConf |
| Explanation: | http://sal.lsst.org |
baudRate¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Baud rate as a number. Allowed values are: 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200
parity¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Parity checking. PARITY_NONE=0, PARITY_EVEN=1, PARITY_ODD=2, PARITY_MARK=3, PARITY_SPACE=4
dataBits¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Number of data bits. Possible values: 5, 6, 7, 8
stopBits¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: Number of stop bits. Possible values: 1, 2
deviceErrorCode¶
Description: None
| Subsystem: | Electrometer |
|---|---|
| Version: | 3.8 |
| Author: | aanania |
| EFDB_Topic: | Electrometer_logevent_deviceErrorCode |
| Explanation: | http://sal.lsst.org |
errorCode¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: The error code being published. This code is the same as the one that the Electrometer publishes
errorReport¶
| IDL_Type: | string |
|---|---|
| IDL_Size: | 1 |
| Units: | unitless |
| Count: | 1 |
Description: Handle a few sentences of higher-level information describing the error.