ATMonochromator¶
Commands¶
changeWavelength¶
Description: Command to change the wavelength of the monochromator
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_command_changeWavelength |
calibrateWavelength¶
Description: Command to calibrate the wavelength
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_command_calibrateWavelength |
power¶
Description: Command to turn the power ON and OFF
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_command_power |
selectGrating¶
Description: Select the grating (Blue,Red, Mirror) that will be in the path of light
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_command_selectGrating |
gratingType¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
| Enumeration: | gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror |
Description: grating type
changeSlitWidth¶
Description: Command to change Front enterance or Front exit slit width to width specified
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_command_changeSlitWidth |
slit¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
| Enumeration: | slit_Slit_FrontEntrance,slit_Slit_FrontExit |
Description: slit
updateMonochromatorSetup¶
Description: Command used to setup monochromator with a single command
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_command_updateMonochromatorSetup |
gratingType¶
| IDL_Type: | long |
|---|---|
| Units: | unitless |
| Count: | 1 |
| Enumeration: | gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror |
Description: Grating type
fontEntranceSlitWidth¶
| IDL_Type: | double |
|---|---|
| Units: | unitless |
| Count: | 1 |
Description: slitwidth for front entrance
Events¶
- SummaryState_DisabledState
- SummaryState_EnabledState
- SummaryState_FaultState
- SummaryState_OfflineState
- SummaryState_StandbyState
- DetailedState_NotEnabled
- DetailedState_Ready
- DetailedState_ChangingWavelength
- DetailedState_CalibratingWavelength
- DetailedState_Powering
- DetailedState_SelectingGrating
- DetailedState_ChangingSlitWidth
- DetailedState_UpdatingMonochromatorSetup
- Status_SettingUp
- Status_Ready
- Status_Offline
- Status_Fault
- Grating_Blue
- Grating_Red
- Grating_Mirror
- Slit_Entry
- Slit_Exit
- LightStatus_On
- LightStatus_Off
- Device_Monochromator
- Device_LightSource
- Device_ThermoelectricCooler
internalCommand¶
Description: internalcommand
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_internalCommand |
commandObject¶
| IDL_Type: | byte |
|---|---|
| Units: | dimensionless |
| Count: | 900 |
Description: The error code being published.
loopTimeOutOfRange¶
Description: Exceeds loop time
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_loopTimeOutOfRange |
loopTimeOutOfRange¶
| IDL_Type: | boolean |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
Description: loop Time is not in range
detailedState¶
Description: Detailed State
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_detailedState |
detailedState¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
| Enumeration: | detailedState_DetailedState_DisabledState,detailedState_DetailedState_EnabledState,detailedState_DetailedState_FaultState,detailedState_DetailedState_OfflineState,detailedState_DetailedState_StandbyState,detailedState_DetailedState_MonoSettingUpState,detailedState_DetailedState_StoppedState,detailedState_DetailedState_StoppedCoolerOffState,detailedState_DetailedState_StoppedLightOffState,detailedState_DetailedState_StoppedLightOnState,detailedState_DetailedState_MonoManualSetup,detailedState_DetailedState_MonoAutomaticSetup |
Description: An enumeration indicating the detailed state. See the DetailedStateValue enumeration defined in the Typedefs package.
status¶
Description: Controller status
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_status |
status¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
Description: An enumeration indicating the controller status.
rejectedCommand¶
Description: Event published when a command is rejected either because command is received when in incorrect state or parameters of command are invalid
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_rejectedCommand |
detailedState¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
| Enumeration: | detailedState_DetailedState_DisabledState,detailedState_DetailedState_EnabledState,detailedState_DetailedState_FaultState,detailedState_DetailedState_OfflineState,detailedState_DetailedState_StandbyState,detailedState_DetailedState_MonoSettingUpState,detailedState_DetailedState_StoppedState,detailedState_DetailedState_StoppedCoolerOffState,detailedState_DetailedState_StoppedLightOffState,detailedState_DetailedState_StoppedLightOnState,detailedState_DetailedState_MonoManualSetup,detailedState_DetailedState_MonoAutomaticSetup |
Description: detailed state
settingsAppliedMonoCommunication¶
Description: setting of the monochromator
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_settingsAppliedMonoCommunication |
ip¶
| IDL_Type: | string |
|---|---|
| IDL_Size: | 15 |
| Units: | dimensionless |
| Count: | 1 |
Description: IP address of the monochromator
portRange¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
Description: port range, it will try to connect to any of the ports in this range
selectedGrating¶
Description: Event indicating the grating that was selected
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_selectedGrating |
gratingType¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
| Enumeration: | gratingType_Grating_Blue,gratingType_Grating_Red,gratingType_Grating_Mirror |
Description: Type of grating
timestamp¶
| IDL_Type: | double |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
Description: timestamp when selected grating event occurs
wavelength¶
Description: Publishes wavelength
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_wavelength |
slitWidth¶
Description: Publishes the slitwidth
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_slitWidth |
slit¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
| Enumeration: | slit_Slit_Entry,slit_Slit_Exit |
Description: Specifies which slit. Entry or exit slit
entrySlitWidth¶
Description: Publishes the slitwidth
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_entrySlitWidth |
exitSlitWidth¶
Description: Publishes the slitwidth
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_exitSlitWidth |
inPosition¶
Description: Indicates if the monochromator is inposition
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_inPosition |
inPosition¶
| IDL_Type: | boolean |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
Description: Indicates if the monochromator is inposition
device¶
| IDL_Type: | long |
|---|---|
| Units: | dimensionless |
| Count: | 1 |
| Enumeration: | device_Device_Monochromator,device_Device_LightSource,device_Device_ThermoelectricCooler |
Description: device
monochromatorConnected¶
Description: Event to inform if the monochromator is connected or not
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_monochromatorConnected |
settingsAppliedMonoHeartbeat¶
Description: Internal heartbeat of the application to indicate if communication between linux and windows controlled is active or not
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_settingsAppliedMonoHeartbeat |
timeout¶
| IDL_Type: | float |
|---|---|
| Units: | second |
| Count: | 1 |
Description: Time out for the heartbeat to test communication between linux and windows controller
settingsAppliedLoop¶
Description: Settings applied loop
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_settingsAppliedLoop |
periodAllowedJitter¶
| IDL_Type: | double |
|---|---|
| Units: | second |
| Count: | 1 |
Description: Period when jitter is allowed
settingsAppliedMonochromatorRanges¶
Description: Allowed range of different settings
| Subsystem: | ATMonochromator |
|---|---|
| Version: | 3.5.2 |
| Author: | None |
| EFDB_Topic: | ATMonochromator_logevent_settingsAppliedMonochromatorRanges |
wavelengthGR1¶
| IDL_Type: | float |
|---|---|
| Units: | nm |
| Count: | 1 |
Description: Minimum wavelength to use with Grating 1
wavelengthGR1_GR2¶
| IDL_Type: | float |
|---|---|
| Units: | nm |
| Count: | 1 |
Description: Wavelength to use to change to Grating 2
wavelengthGR2¶
| IDL_Type: | float |
|---|---|
| Units: | nm |
| Count: | 1 |
Description: Maximum wavelength to use with Grating 2