LEGACY Commands Command: legacy.legacy_ForceStatusEvents() Description: Command: legacy.dome_OnLine() Description: Return dome on-line status. Command: legacy.dome_Abort() Description: Abort (hard stop) dome movement. Command: legacy.dome_GetPosition() Description: Command: legacy.dome_Home() Description: Home the dome (69.0). Command: legacy.dome_IssuePMACCmd() Description: Required parameters: cmd - Command: legacy.dome_MoveTo() Description: Required parameters: target - Command: legacy.dome_MoveToCCAS() Description: Command: legacy.dome_SetDirection() Description: Required parameters: direction - Command: legacy.dome_SetPower() Description: Required parameters: state - Command: legacy.dome_SetVelocity() Description: Required parameters: velocity - Command: legacy.dome_Reset() Description: Reset dome power inverter. Command: legacy.dome_Status() Description: Optional parameters: update_state - Command: legacy.dome_Stop() Description: Stop (soft stop) dome movement. Command: legacy.dome_Stow() Description: Command: legacy.dome_Test() Description: Required parameters: state - Command: legacy.shutter_OnLine() Description: Return shutter on-line status. Command: legacy.shutter_Abort() Description: Return shutter on-line status. Command: legacy.shutter_Close() Description: Close the shutter. Command: legacy.shutter_IssuePMACCmd() Description: Required parameters: cmd - Command: legacy.shutter_Open() Description: Open the Shutter. Command: legacy.shutter_Reset() Description: Reset the shutter power inverter. Command: legacy.shutter_SetPower() Description: Required parameters: state - Command: legacy.shutter_Status() Description: Optional parameters: update_state - Command: legacy.shutter_Stop() Description: Stop (soft stop) shutter movement. Command: legacy.structure_OnLine() Description: Command: legacy.structure_MoveToTrueAz() Description: Required parameters: target - Command: legacy.structure_MoveToStructAz() Description: Required parameters: target - Command: legacy.structure_MoveToCCAS() Description: Command: legacy.structure_Status() Description: Optional parameters: update_state - Command: legacy.structure_Stop() Description: Command: legacy.structure_Stow() Description: Command: legacy.weather_OnLine() Description: Command: legacy.weather_GetData() Description: Optional parameters: update_state - LEGACY Events Event: legacy.dome.status Description: Status information. PAS Commands Command: pas.Status() Description: Command: pas.OnLine() Description: Check to see if the specified pipeline (camera) is available. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Command: pas.SetCycleTime() Description: Set the indicated pipeline's cycle speed. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Required parameters: seconds - The cycle speed in seconds. Command: pas.SetIntervalSpeed() Description: Set the indicated pipeline's cycle time. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Required parameters: speed - The cycle time in seconds. Command: pas.StartPipeline() Description: Start cycling the indicated pipeline. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Command: pas.StopPipeline() Description: Stop cycling the indicated pipeline. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Command: pas.TakeControl() Description: Take control of pipeline. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Command: pas.RelinquishControl() Description: Relinquish pipeline control. The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Command: pas.CyclePipeline() Description: Single cycle the indicated pipeline, The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Required parameters: procMode - Image processing mode. One of the following strings. 'guiding', 'tip-tilt', 'image-analysis', 'wave-front-sensing'. imageFilename - Name of file to store the image in (relative the startup directory). Command: pas.ForceStatusEvent() Description: Force a status event from the indicated pipeline The pipeline (camera) name, is prepended to the handler name (i.e. Guider1_). Command: pas.StartSendingImages() Description: Command: pas.StopSendingImages() Description: Command: pas.SetPixelFormat() Description: Required parameters: type - Command: pas.SetReadoutSpeed() Description: Required parameters: speed - Command: pas.SetImageType() Description: Required parameters: type - Command: pas.SetAnalysisRegion() Description: Required parameters: xmin - xmax - ymin - ymax - Command: pas.GetAnalysisRegion() Description: Command: pas.SetRegionOfInterest() Description: Required parameters: xmin - xmax - ymin - ymax<> - Command: pas.GetRegionOfInterest() Description: Command: pas.SetExposureTime() Description: Required parameters: time - Command: pas.GetExposureTime() Description: Command: pas.SetOverScan() Description: Required parameters: over_scan - Command: pas.GetOverScan() Description: Command: pas.SetFilterExposureTimeFactor() Description: Required parameters: filterName - factor - Command: pas.SetFilterZeroPoint() Description: Required parameters: filterName - zeroPoint - Command: pas.SetExposuresPerCycle() Description: Required parameters: exposures<> - Command: pas.SetFilterSequence() Description: Required parameters: sequence - Command: pas.SetBinning() Description: Required parameters: width - height - Command: pas.GetGain() Description: Command: pas.SetTargetTemperature() Description: Required parameters: temp - Command: pas.GetTemperatures() Description: Command: pas.SetNumFlushes() Description: Required parameters: flushes - Command: pas.SetObjectAndMagnitudes() Description: Sets the observed object's name and magnitudes for each filter. Required parameters: object - Identifies the observed object. Optional parameters: filterName - The parameter name is one of the five filter names for the camera. The value is the magnitude associated with this filter. Up to five of these optional parameters may be specified. Command: pas.SetLightSourcePower() Description: Required parameters: state - Command: pas.SetLightSourcePowerLevel() Description: Required parameters: level - Command: pas.GetLightSourcePowerLevel() Description: Command: pas.SetLightSourcePowerHoldTime() Description: Required parameters: time<> - Command: pas.SetCleanImages() Description: Required parameters: clean - Command: pas.SetCleaningBiasType() Description: Required parameters: type - Command: pas.SetProcessImages() Description: Required parameters: process - Command: pas.SetStoreImages() Description: Required parameters: store - Command: pas.SetProcessingType() Description: Required parameters: type - Command: pas.GetPhotPhotometryOptions() Description: Command: pas.GetWFSPhotometryOptions() Description: Command: pas.SetPhotPhotometryOptions() Description: Required parameters: mag_zero - detect_sigma - min_pixels - max_pixels - nan_value - saturation - gain - sky_order - sky_annulus - kron_aperture - fixed_aperture - Command: pas.SetWFSPhotometryOptions() Description: Required parameters: bRenewFlag - pixelsAcrossSubAperture - pixelsPerSubAperture - numZernikeModes - numZernikeModesToReconstruct - diskX - diskY - diskRadius - pixelScale - pupilRadius - rotation - refWaveLength - Command: pas.SetGROC() Description: Command: pas.EnableSACDMI() Description: Command: pas.EnableCCASDMI() Description: PFIP Commands Command: pfip.MoveProbes() Description: Move the guider and wave front sensors (wfs) to new coordinates. The coordinates are supplied as x/y in degrees. The x/y coordinates are the point to which the end of the probe arm will move on the focal plane. It is possible to disable the probes from the pfipserver configuration. If any of the probes are disabled, their new coordinate parameters are ignored, and the probe will not move. If there is a fault that prevents the combined probe move from continuing, the moves for all probes will be cancelled. It is possible to cancel a MoveProbes request by using the PFIPInterrupt() handler. Optional parameters: guider1x - The x coordinate (in degrees) for the new position of guider probe 1. Guider1y - The y coordinate (in degrees) for the new position of guider probe 1. Guider2x - The x coordinate (in degrees) for the new position of guider probe 2. Guider2y - The y coordinate (in degrees) for the new position of guider probe 2. WFS1x - The x coordinate (in degrees) for the new position of wave front sensor 1. WFS1y - The y coordinate (in degrees) for the new position of wave fron sensor 1. WFS2x - The x coordinate (in degrees) for the new position of wave front sensor 2. WFS2y - The y coordinate (in degrees) for the new position of wave front sensor 2. Command: pfip.MoveProbes_RaDec() Description: NOTE: This interface is not to be used during normal TCS operations. It is a testing interface only!! Move the guiders and wave front sensors (wfs) to new coordinates. The coordinates are supplied as Ra and Dec for each probe. These values are translated using the other supplied parameters, the focal plane axis Ra and Dec, and the parallactive angle. All angles are assumed to be in degrees. It is possible to disable the probes from the pfipserver configuration. If any of the probes are disabled, their new coordinate parameters are ignored, and the probe will not move. If there is a fault that prevents the combined probe move from continuing, the moves for all probes will be cancelled. It is possible to cancel a MoveProbes request by using the PFIPInterrupt() handler. Required parameters: Axis_Ra - The right ascension of the center of the focal plane. Axis_Dec - The declination of the center of the focal plane. Pa - The parallactic angle of the target. Optional parameters: Guider1_Ra - The right ascension of the requested guider 1 position. Guider1_Dec - The declination of the requested guider 1 position. Guider2_Ra - The right ascension of the requested guider 2 position. Guider2_Dec - The declination of the requested guider 2 position. WFS1_Ra - The right ascension of the requested position for wave front sensor 1. WFS1_Dec - The declination of the requested position for wave front sensor 1. WFS1_Ra - The right ascension of the requested position for wave front sensor 2. WFS2_Dec - The declination of the requested position for wave front sensor 1. Command: pfip.MoveProbes_Enc() Description: Move the guiders and wave front sensors (wfs) to new encoder positions. The encoder positions are supplied as carriage and arm for each probe. If there is a fault that prevents the combined probe move from continuing, the moves for all probes will be cancelled. It is possible to cancel a MoveProbes request by using the PFIPInterrupt() handler. Optional parameters: Guider1_Carriage - The carriage encoder count requested guider 1. Guider1_Arm - The arm encoder count requested for guider 1. Guider2_Carriage - The carriage encoder count requested for guider 2. Guider2_Arm - The arm encoder count requested for guider 2. WFS1_Carriage - The carriage encoder count requested for wave front sensor 1. WFS1_Arm - The arm encoder count requested for wave front sensor 1. WFS1_Carriage - The carriage encoder count requested wave front sensor 2. WFS2_Arm - The arm encoder count requested for wave front sensor 1. Command: pfip.EnableProbes() Description: Enables all the probes. If one or more of the probes is disabled by configuration, that probe will not be affected. The PFIPInterrupt() handler can be used to cancel this operation. Command: pfip.DisableProbes() Description: Disables all the probes. If one or more of the probes is disabled by configuration, that probe will not be affected. The PFIPInterrupt() handler can be used to cancel this operation. Command: pfip.HomeProbes() Description: Set each probe to point to a zero-point on the x or y axis. Guider1 and Guider2 be set to 0 in x. WFS1 and WFS2 will be set to 0 in y. If one or more of the probes is diabled by configuration, that probe will not be affected. The PFIPInterrupt() handler can be used to cancel this operation. Command: pfip.BeginRangeProbes() Description: Move all the probes and their arms to the beginning of their respective ranges. If one or more of the probes is diabled by configuration, that probe will not be affected. The PFIPInterrupt() handler can be used to cancel this operation. Command: pfip.MidRangeProbes() Description: Move all the probes and their arms to the middle of their respective ranges. If one or more of the probes is diabled by configuration, that probe will not be affected. The PFIPInterrupt() handler can be used to cancel this operation. Command: pfip.EndRangeProbes() Description: Move all the probes and their arms to the end of their respective ranges. If one or more of the probes is diabled by configuration, that probe will not be affected. The PFIPInterrupt() handler can be used to cancel this operation. Command: pfip.PowerOnAll() Description: Turn on the power to the PFIP hardware items: Switch1, Switch2, SBC1, SBC2, Guide Probes, Acquisition Camera, Pupil View/CWFS. Command: pfip.PowerACQCamera() Description: Turn on/off the power to the Acquisition Camera. Required parameters: state - true - turn on; false - turn off Command: pfip.PowerPV_CWFSCamera() Description: Turn on/off the power to the PV and CWFS. Required parameters: state - true - turn on; false - turn off Command: pfip.PowerBIBCamera() Description: Turn on/off the power to the BIB Camera. Required parameters: state - true - turn on; false - turn off Command: pfip.PowerHR_SASCamera() Description: Turn on/off the power to the HR-SAS Camera. Required parameters: state - true - turn on; false - turn off Command: pfip.PowerHPF_ACQCamera() Description: Turn on/off the power to the HR-SAS Camera. Required parameters: state - true - turn on; false - turn off Command: pfip.PowerTTCamera() Description: Turn on/off the power to the HR-SAS Camera. Required parameters: state - true - turn on; false - turn off Command: pfip.PowerSwitch1() Description: Turn on/off the power to the ENet Switch 1 Required parameters: state - true - turn on; false - turn off Command: pfip.PowerProbeCamera() Description: Turn on/off the power to one of the probes Required parameters: camera - One of \"Guider1\", \"Guider2\", \"WFS1\", or \"WFS2\" state - true - turn on; false - turn off Command: pfip.PowerSwitch2() Description: Turn on/off the power to the ENet Switch 2 Required parameters: state - true - turn on; false - turn off Command: pfip.PowerSBC1() Description: Turn on/off the power to the Single Board Computer 1 Required parameters: state - true - turn on; false - turn off Command: pfip.PowerSBC2() Description: Turn on/off the power to the Single Board Computer 2 Required parameters: state - true - turn on; false - turn off Command: pfip.PowerOffAll() Description: Turn off the power to the PFIP hardware items: Switch1, Switch2, SBC1, SBC2, Guide Probes, Acquisition Camera, Pupil View/Calibration Wave Front Sensor. Command: pfip.DeployACQCameraMirror() Description: Deploy the Acquisition Camera mirror. Command: pfip.RetractACQCameraMirror() Description: Retract the Acquisition Camera mirror. Command: pfip.DeployCWFSCameraMirror() Description: Deploy the Calibration Wave Front Sensor mirror. Command: pfip.RetractCWFSCameraMirror() Description: Retract the Calibration Wave Front Sensor mirror. Command: pfip.SetACQCameraFocus() Description: Change the focus setting for the acquisition camera Required parameters: relative - An number in units of milli-meters indicating the amount to change the focus setting. The valid focus setting is between 0 and 19.8. absolute - A absolute number in units of milli-meters indicating the new focus setting. The valid focus setting is between 0 and 19.8. Command: pfip.DeployCWFSCamera() Description: Deploy the Calibration Wave Front Sensor and retract the Pupil View Camera. Command: pfip.AdjustDither() Description: Change the dither setting. Required parameters: pos - An integer between 1 and 3 (inclusive) that identifies the level of dithering. Command: pfip.GetProbePosition() Description: Return a reply message containing information about probe position and status. Required parameters: probe - Identify the probe for which information is requested. One of: 'Guider1', 'Guider2', 'WFS1', or 'WFS2'. Command: pfip.GetProbeInfo() Description: Return a reply message containing information about probe and filter status. Required parameters: probe - Identify the probe for which information is requested. One of: 'Guider1', 'Guider2', 'WFS1', or 'WFS2'. Command: pfip.TimeoutNextMove() Description: Cause the next probe move to timeout. Optional parameters: timeout - Length of time in seconds before timeout after move call (default is 10). Command: pfip.SetProbeGains() Description: Set the gains for each probe. Optional parameters: probe_IGain - Set the IGain for the probe identified by one of: 'Guider1', 'Guider2', 'WFS1', or 'WFS2'. probe_PGain - Set the PGain for the probe identified by one of: 'Guider1', 'Guider2', 'WFS1', or 'WFS2'. Command: pfip.GetACQSystemInfo() Description: Return a reply message containing status and encoder positions for the focal plane shutter, the acquisition camera, ENWA filter, acquisition camera filter, and dither setting. Command: pfip.DeployPVCamera() Description: Deploy the Pupil View camera and retract the Calibration Wave Front Sensor. Command: pfip.ReadRegister() Description: Read the contents of a modbus register for the pfip enclosure PLC and print the value in the pfip log. Required parameters: regnum - The modbus register number to read. These numbers can be found in the PFIP enclosure hardware documentation. Command: pfip.WriteRegister() Description: Write to a modbus register for the pfip enclosure PLC. Required parameters: regnum - The modbus register number to write. These numbers can be found in the PFIP enclosure hardware documentation. regnum - The modbus register number to write. These numbers can be found in the PFIP enclosure hardware documentation. value - An integer value to store in the register. Command: pfip.SetENWAFilter() Description: Change the ENWA (Entry Window) filter setting. Required parameters: pos - An integer between 1 and 3 (inclusive) that identifies the level of dithering. Command: pfip.CloseShutter() Description: Close the focal plane shutter. Command: pfip.OpenShutter() Description: Open the focal plane shutter. Command: pfip.HomeShutter() Description: Home the focal plane shutter. Command: pfip.SetGuideCameraFilter() Description: Change the filter setting on a guider camera. Required parameters: guider - Either 'Guider1' or 'Guider2', identifying the guider camera. filter_name - The configured name of a filter (e.g., \"i\", \"g\", \"Clear\"). pos - An integer between 1 and 5 (inclusive) specifying the filter setting for the guide camera. Command: pfip.PFIPInterrupt() Description: Interrupt the shutter exposure, probe move, or probe enable/disable operation in progress. Command: pfip.TakeExposure() Description: Open the focal plabe camera shutter for a specified duration. Required parameters: duration - Number of seconds to leave the shutter open. pos - An integer between 1 and 5 (inclusive) specifying the filter setting for the guide camera. Command: pfip.SetACQCameraFilter() Description: Change the acquisition camera filter setting Required parameters: pos - An integer between 1 and 4 (inclusive) specifying the filter setting to use. filter_name - The configured name of a filter (e.g., \"i\", \"g\", \"B\"). Command: pfip.FCUDeployHead() Description: Deploy the Facility Control Unit (FCU) head for an exposure using the FCU shutter. Command: pfip.FCURetractHead() Description: Retract the Facility Control Unit (FCU) head. Command: pfip.FCUEnableLamps() Description: Toggle on or off specified FCU lamps. Required parameters: slider - Identify the slider for the light source, either 'a' or 'b'. lamps - A string containing a comma-separated list of lamp names. state - \"on\" turns specified lamps on. \"off\" turns them off. Command: pfip.FCUEnableLightSources() Description: Toggle on or off specified FCU lamps or Laser-Driven Light Source (LDLS). Required parameters: slider - Identify the slider for the light source, either 'a' or 'b'. Optional parameters: lamp1 - lamp1=\"on\" turns FCU Lamp 1 on. lamp1=\"off\" turns FCU Lamp 1 off. lamp2 - lamp2=\"on\" turns FCU Lamp 2 on. lamp2=\"off\" turns FCU Lamp 2 off. lamp3 - lamp3=\"on\" turns FCU Lamp 3 on. lamp3=\"off\" turns FCU Lamp 3 off. lamp4 - lamp4=\"on\" turns FCU Lamp 4 on. lamp4=\"off\" turns FCU Lamp 4 off. lamp5 - lamp5=\"on\" turns FCU Lamp 5 on. lamp5=\"off\" turns FCU Lamp 5 off. ldls - ldls=\"on\" turns on the LDLS. ldls=\"off\" turns off the LDLS. Command: pfip.FCUInitLightSources() Description: Configure warm-up times for the lamps and ldls in the FCU. Required parameters: slider - Identify the slider for the light source, either 'a' or 'b'. Optional parameters: lamp1 - Number of seconds of warmup time necessary for Lamp 1. lamp2 - Number of seconds of warmup time necessary for Lamp 2. lamp3 - Number of seconds of warmup time necessary for Lamp 3. lamp4 - Number of seconds of warmup time necessary for Lamp 4. lamp5 - Number of seconds of warmup time necessary for Lamp 5. ldls - Number of seconds of warmup time necessary for LDLS. Command: pfip.FCUSetLampWarmUp() Description: Configure warm-up times for FCU lamps. Required parameters: slider - Identify the slider for the light source, either 'a' or 'b'. lamp_name - The name of the lamp, as configured (e.g., \"Cd\" or \"Hg\" warm_seconds - Number of seconds of warmup time necessary for the lamp specified. Command: pfip.FCUSetLDLSWarmUp() Description: Configure warm-up time for laser-driven light source Required parameters: warm_seconds - Number of seconds of warmup time. Command: pfip.FCUDisableAllLights() Description: Turn off all the lamps and the ldls on the FCU. Command: pfip.FCUMoveSlider() Description: Move to a different lamp on the specified slider. Required parameters: slider - Specify the slider (e.g., \"a\" or \"b\") Optional parameters: pos - Specify the lamp requested by position, 1-5. If lamp is requested by position, cannot use lamp_name parameter. lamp_name - Specify the lamp requested by configured name (e.g., \"Cd\"). This should be a name specified in the configuration for the slider requested. If lamp_name parameters is used to identify the lamp position, do not use the pos parameter. Command: pfip.FCUCancelExposure() Description: Cancel FCU exposure. Required parameters: shutter - Shutter name. Command: pfip.FCUExposeSliderB() Description: Take an exposure on FCU slider B. Required parameters: time - Number of seconds to expose. Optional parameters: pos - Slider position (lamp) to use for the exposure. An integer 1-5. Default is the current slider B position. lamp_name - The name of the lamp (string) to use for the exposure. Default is the current slider B position. headpos - When this parameter is set to \"override\", do not require deployment of the FCU Head for the exposure. This option is used when the shutter is controlled by Virus. The default is to require deployment of the FCU Head for an exposure. light_guide - If the light_guide parameter is set to red (light_guide=\"red\"), use the light_guide's red setting. If the parameter is set to blue (light_guide=\"blue\"), use the blue setting. The default is to use the current light_guide setting for the exposure. shutter - If the shutter parameters is set to \"virus\", then Virus will control the shutter. The command will return immediately after positioning the slider and triggering the exposure. If no shutter parameter is supplied, the focal plane shutter will be used to control the exposure. In this case, the command returns when the exposure is complete. Default is the current slider B position. Command: pfip.FCUExposeSliderA() Description: Take an exposure on FCU slider A. Required parameters: time - Number of seconds to expose. Optional parameters: pos - Slider position (lamp) to use for the exposure. An integer 1-5. Default is the current slider A position. lamp_name - The name of the lamp (string) to use for the exposure. Default is the current slider A position. headpos - When this parameter is set to \"override\", do not require deployment of the FCU Head for the exposure. This option is used when the shutter is controlled by Virus. The default is to require deployment of the FCU Head for an exposure. light_guide - If the light_guide parameter is set to red (light_guide=\"red\"), use the light_guide's red setting. If the parameter is set to blue (light_guide=\"blue\"), use the blue setting. The default is to use the current light_guide setting for the exposure. shutter - If the shutter parameters is set to \"Virus\", then Virus will control the shutter. The command will return immediately after positioning the slider and triggering the exposure. If no shutter parameter is supplied, the focal plane shutter will be used to control the exposure. In this case, the command returns when the exposure is complete. Command: pfip.FCUExposeLDLS() Description: Take an exposure with the Laser-Driven Light Source Required parameters: time - Number of seconds to expose. Optional parameters: headpos - When this parameter is set to \"override\", do not require deployment of the FCU Head for the exposure. This option is used when the shutter is controlled by Virus. The default is to require deployment of the FCU Head for an exposure. light_guide - If the light_guide parameter is set to red (light_guide=\"red\"), use the light_guide's red setting. If the parameter is set to blue (light_guide=\"blue\"), use the blue setting. The default is to use the current light_guide setting for the exposure. shutter - If the shutter parameters is set to \"Virus\", then Virus will control the shutter. The command will return immediately after positioning the slider and triggering the exposure. If no shutter parameter is supplied, the focal plane shutter will be used to control the exposure. In this case, the command returns when the exposure is complete. Command: pfip.FCUGetCurrentExposureInfo() Description: Reply with information about the current exposure. Command: pfip.FCUGetLastExposureInfo() Description: Reply with information about the last exposure. Command: pfip.FCUPrintRegister() Description: Display the value of an FCU modbus PLC register to the PFIP server log. Required parameters: regnum - The register number to print. Command: pfip.FCUWriteRegister() Description: Store an integer value into one of the FCU modbus registers. Required parameters: regnum - The register number to write. value - The value to store in the register. Command: pfip.Venc2WriteRegister() Description: Store an integer value into the Virus Enclosure 2 (VENC) PLC. Required parameters: regnum - The register number to write. value - The value to store in the register. Command: pfip.Venc1WriteRegister() Description: Store an integer value into the Virus Enclosure 1 (VENC) PLC. Required parameters: regnum - The register number to write. value - The value to store in the register. Command: pfip.Venc2PrintRegister() Description: Print the value of a modbus register in the Virus Enclosure 2 (VENC) PLC into the PFIP server log. Required parameters: regnum - The register number to read Command: pfip.Venc1PrintRegister() Description: Print the value of a modbus register in the Virus Enclosure 1 (VENC) PLC into the PFIP server log. Required parameters: regnum - The register number to read Command: pfip.FCUMoveLightGuide() Description: Change the output light guide setting. Required parameters: light_guide - This parameter is set to either \"Red\" or \"Blue\", depending on the type of light desired. Command: pfip.FCUMoveLightBank() Description: Change the input light bank setting. Required parameters: light_bank - This parameter is set to either \"Slider A\", \"LDLS\", or \"Slider B\", depending on the light source desired. Command: pfip.FCUShutDown() Description: Shutdown the FCU. PFIP Events Event: pfip.acq_shutter.status Description: Shutter status information. Parameters: ShutEnabled - Shutter enabled: true = enabled ShutTarget - Shutter at target: true = ??? ShutFault - Shutter faulted: true = faulted ShutWarning - Shutter warning: true = warning ShutLimit - Shutter at limit: true = at limit ShutSetpoint - Shutter set point: true = ??? ShutFollowing - Shutter following error" true = following error ShutEnabledAlert - Shutter enabled alert ShutTargetAlert - Shutter target alert ShutFaultAlert - Shutter fault alert ShutWarningAlert - Shutter warning alert ShutLimitAlert - Shutter limit alert ShutSetpointAlert - Shutter setpoint alert ShutFollowingAlert - Shutter following alert ShutEncoder - Shutter encoder value (encoder count) ShutEncoderModulo - Shutter encoder modulo (encoder count) ShutPosition - Shutter position: 0 = open, 1 = close, -1 = unknown (index) ShutLastOpen - Shutter last open time (fixed time) ShutLastClose - Shutter last close time (fixed time) ShutSchedOpen - Schedule shutter open time (fixed time) ShutSchedClose - Schedule shutter close time (fixed time) ShutDuration - Shutter open duration time (fixed time) Event: pfip.ENWA.status Description: Parameters: ENWAEnabled - ??? ENWATarget - ??? ENWAFault - ??? ENWAWarning - ??? ENWALimit - ??? ENWASetpoint - ??? ENWAFollowing - ??? ENWAEnabledAlert - ??? ENWATargetAlert - ??? ENWAFaultAlert - ??? ENWAWarningAlert - ??? ENWALimitAlert - ??? ENWASetpointAlert - ??? ENWAFollowingAlert - ??? ENWAEncoder - ??? (encoder count) ENWAPosition - ??? (index) ENWAFilterName - ??? ENWAFilterNames - ??? EXWAPosition - ??? (index) EXWAFilterName - ??? EXWAFilterNames - ??? TCS Commands XXX subsystem description and caveats for handlers goes here. Command: tcs.query_trajectory() Description: Calculates a trajectory based on the given parameters and returns the trajectory descriptor. Overloads are available for sidereal and non-sidereal trajectories. Parameters are identical to those of load_trajectory. Command: tcs.go_next() Description: Sets the system up for the next trajectory. The call returns on exception or when the tracker is on trajectory. If positioning of additional telescope components is requested, those are assumed to be settled and corrected for upon return. Optional parameters: move_dome - Flag indicating that the dome should be moved to the Azimuth of the requested trajectory. If given, and any error is encountered in positioning the dome, the trajectory will be aborted and the corresponding exception thrown. move_structure - Flag indicating that the stucture should be moved to the Azimuth of the requested trajectory. If given, and any error is encountered in positioning the structure, the trajectory will be aborted and the corresponding exception thrown. move_probes - Flag indicating that any configured PFIP metrology probes should be moved to the requested position. @sa set_position override_structure_correction - Flag indicating that the correction of the trajectory, for the error in the placement of the structure, should be skipped. Command: tcs.load_trajectory() Description: XXX Command: tcs.cancel_trajectory() Description: Cancels any currently active trajectory. Command: tcs.tracker_abort() Description: Sends an ABORT command to the tracker hardware, aborting an active trajectory or move. Command: tcs.tracker_init() Description: Sends an INIT command to the tracker hardware, initiating the initialization process for the tracker. Command: tcs.tracker_move_itf() Description: Moves the tracker to the given ITF coordinate. Required parameters: x - Target x position, in ITF. (mm) y - Target y position, in ITF. (mm) z - Target z position, in ITF. (mm) rho - Target rho position, in ITF. (degree) theta - Target theta position, in ITF. (degree) phi - Target phi position, in ITF. (degree) type - The type of move requested, rel or abs, relative or absolute respectively. vel - The velocity with which to move: SLEW_SLOW, SLEW_FAST, TRK_SLOW or TRK_FAST. Command: tcs.tracker_move_tsf() Description: Moves the tracker to the given TSF coordinate. Required parameters: x - Target x position, in TSF. (mm) y - Target y position, in TSF. (mm) z - Target z position, in TSF. (mm) rho - Target rho position, in TSF. (degree) theta - Target theta position, in TSF. (degree) phi - Target phi position, in TSF. (degree) type - The type of move requested, rel or abs, relative or absolute respectively. vel - The velocity with which to move: SLEW_SLOW, SLEW_FAST, TRK_SLOW or TRK_FAST. Command: tcs.tracker_move_angular() Description: Moves the tracker to the given angular coordinates on sky. Required parameters: x - Target telecentric x position. (arcsecond) y - Target telecentric y position. (arcsecond) type - The type of move requested, rel or abs, relative or absolute respectively. vel - The velocity with which to move: SLEW_SLOW, SLEW_FAST, TRK_SLOW or TRK_FAST. Command: tcs.tracker_position() Description: Returns the current tracker position. Command: tcs.toggle_gui_token() Description: Toggles the status of the master GUI token. Once acquired, the same token must be provided to a subsequent call to release the token. Required parameters: token - The token requested or released. Command: tcs.get_current_trajectory_info() Description: XXX Command: tcs.get_next_trajectory_info() Description: XXX Command: tcs.get_current_local_sidereal_time() Description: Returns the current LST, at the HET. Return parameters: lst - Current local sidereal time at the HET. (hour) Command: tcs.get_current_pointing() Description: XXX Command: tcs.offset_trajectory() Description: Recalculates the current trajectory based on the given offset. Offsets may be given in either delta RA,Dec or delta X,Y, angular units of arc seconds in either case. When offseting by delta RA,Dec, the RA,Dec of the current trajectory (not current pointing) is adjusted. When offsetting by delta X,Y, the trajectory is recalculated to the RA,Dec of the current pointing plus the given offset. Ideally, prior to calling this method, the trajectory will have already been recalculated based on the current structure azimuth and elevation, in which case these two calling conventions have the same semantics. If the offset is flagged as a correction, then the old trajectory is simply shifted by a delta that remains static over time. The reported pointing coordinates are adjusted by the given correction to reflect the original pointing prior to correction. Optional parameters: dra - The desired offset in arc seconds of right ascension. (arcsecond) ddec - The desired offset in arc seconds of declination. (arcsecond) dx_ang - The desired offset in arc seconds aligned to the X axis of the focal surface. (arcsecond) dy_ang - The desired offset in arc seconds aligned to the Y axis of the focal surface. (arcsecond) adjust_probes - Flag indicating that the movable probes should be adjusted to account for the requested offset. correction - Flag indicating that this offset is a correction to the current trajectory, rather than an offset to a new trajectory. Command: tcs.correct_for_structure() Description: XXX Command: tcs.pfip_open_shutter() Description: XXX Command: tcs.pfip_clear_positions() Description: Clears any set probe positions so that a subsequent move will not attempt to repositions the probes. Command: tcs.pfip_close_shutter() Description: XXX Command: tcs.pfip_insert_acquisition_pickoff() Description: Inserts the acquisition camera pickoff mirror. Command: tcs.pfip_withdraw_acquisition_pickoff() Description: Withdraws the acquisition camera pickoff mirror. Command: tcs.pfip_move_probes() Description: Initiate any staged probe moves. This call blocks until probes are in position. @sa set_position Command: tcs.start() Description: XXX Command: tcs.stop() Description: XXX Command: tcs.activate() Description: XXX Command: tcs.deactivate() Description: XXX Command: tcs.force_state_event() Description: XXX Command: tcs.add_correction() Description: XXX Command: tcs.get_correction() Description: XXX Command: tcs.reset() Description: XXX Command: tcs.inject_metrology() Description: XXX Command: tcs.set_fiducial() Description: XXX Command: tcs.get_fiducial() Description: XXX Command: tcs.set_analysis_region() Description: XXX Command: tcs.get_analysis_region() Description: XXX Command: tcs.apply_offset() Description: XXX Command: tcs.tune() Description: XXX Command: tcs.get_tuning() Description: XXX Command: tcs.offset_fiducial() Description: Offsets the metrology loop's fiducial either by telecentric angle or by change in equatorial coordinates. Parameters are expected to be in arcseconds. Required parameters: compensate - Flag indicating the other probes that are setup should be moved sympathetic to the centering motion of this probe. Defaults to true. Optional parameters: dx_asec - Change of fiducial in arcseconds of x. dy_asec - Change of fiducial in arcseconds of y. dra_asec - Change of fiducial in arcseconds of RA. ddec_asec - Change of fiducial in arcseconds of Dec. Command: tcs.get_status() Description: Returns the current status of the probe. Throws an exception if the status is unknown. XXX document info returned as it evolves. Command: tcs.DMI_get_status() Description: Returns the current status of the instrument. Throws an exception if the status is unknown. XXX document info returned as it evolves. Command: tcs.set_position() Description: Set the target offset for the probe. This stages the move but does not execute probe moves. If parameters are given in x_ang, y_ang then the probe will be positioned at these telecentric angles off of the focal axis. Otherwise, ra and dec are expected and should be given relative to the trajectory at the time that the probes are moved. An equinox for the ra,dec is optional and defaults to 2000. @sa go_next, pfip_move_probes Optional parameters: x_ang - On sky degrees off focal axis in X. y_ang - On sky degrees off focal axis in Y. ra - Right ascension in decimal hours. dec - Declination in degrees. equinox - Equinox for the given ra,dec. trajectory - If probe positions are given in absolute ra,dec they will be converted to focal plain positions relative to the ra,dec of the requested trajectory, either current or next. This defaults to current. Command: tcs.unset_position() Description: Unset the target offset for the probe. A subsequent move of another probe may result in the unset probe being moved. Command: tcs.offset_itf() Description: Applies the given delta(s) to the ITF zero point assumed for all subsequent points sent to the tracker. When called multiple times, the deltas are additive. When called while on trajectory, the change in the zero point is applied immediately. When called while off trajectory, the tracker is moved from the current position to that position plus the given deltas. In either case, the change to the ITF zero point persists until reset or the control system is restarted. At least one delta is required. @sa reset_itf_offset, offset_sky, offset_focus. Optional parameters: dx - Change in ITF x. dy - Change in ITF y. dz - Change in ITF z. drho - Change in ITF rho. dtheta - Change in ITF theta. dphi - Change in ITF phi. Command: tcs.reset_itf_offset() Description: Resets the current ITF offset to to the base zero point offset. Command: tcs.get_itf_offset() Description: Returns the current offset of the ITF sphere. Command: tcs.offset_sky() Description: Adds the given angular offset on sky to the current offset applied to each position sent to the tracker. The change to the angular offset persists until reset. At least one delta is required. @sa reset_sky_offset, offset_itf, offset_focus. Optional parameters: dx_ang - Angular offset, in degrees, to apply along the tracker X axis. dy_ang - Angular offset, in degrees, to apply along the tracker Y axis. move_probes - Flag indicating that the movable probes should be adjusted to account for the requested offset. Command: tcs.reset_sky_offset() Description: the current sky offset to zero. Optional parameters: move_probes - Flag indicating that the movable probes should be adjusted to account for reset of the offset. Command: tcs.get_sky_offset() Description: Returns the current angular offset on sky. Command: tcs.offset_focus() Description: Add the given offset to the the distance held along the normal between the primary and focal spheres. Optional parameters: dw - Focus offset to be applied. Command: tcs.reset_focus_offset() Description: Resets the current focus offset to zero. Command: tcs.get_focus_offset() Description: Returns the current focus offset. Command: tcs.clear_fiducial() Description: Resets the fiducial of the underlying metrology system so that the next reading becomes the new fiducial. Command: tcs.set_filter() Description: Set the requested filter for the camera. Required parameters: filter - XXX update this to take a string... For now, integer representation of the desired filter. Command: tcs.offset_tiptilt() Description: Adds the given tip and tilt offsets to the current trajectory. Optional parameters: dtheta - Offset in degrees of theta. dphi - Offset in degrees of phi. Command: tcs.reset_tiptilt_offset() Description: Resets the current tiptilt offset to zero. Command: tcs.get_tiptilt_offset() Description: Returns the current angular offset on tiptilt. Command: tcs.reset_radec_offset() Description: Resets the radec offset register to the current apparent coordinates. Command: tcs.get_radec_offset() Description: Returns the current offset in apparent RA and DEC in arcseconds relative to the coordinates stored in the radec offset register. Command: tcs.offset_probe() Description: Offset a probe. Required parameters: dx_ang - On sky offset in x telecentric angle in arcsec from current probe position. dy_ang - On sky offset in y telecentric angle in arcsec from current probe position. Command: tcs.set_focus() Description: Sets the focus of the system to a given w or the latest reading from the DMI. Optional parameters: w - Focus setting in mm. Command: tcs.set_tiptilt_window_length() Description: Sets the number of WFS tiptilt measurements that are integrated to produce a single tiptilt correction from the WFS loop. Optional parameters: length - Number of samples to integrate. Command: tcs.get_tiptilt_window_length() Description: Returns the number of samples that are averaged to produce a single tiptilt correction from the WFS loop. The magnitude of the correction is the resulting average divided by the number of samples. Command: tcs.center() Description: Moves the probe to the center the object within the aperture, based on the current instantaneous error in telecentric x,y as reported by the WFS metrology pipeline. Command: tcs.set_focus_window_length() Description: Sets the number of WFS focus measurements that are integrated to produce a single focus correction from the WFS loop. Optional parameters: length - Number of samples to integrate. Command: tcs.get_focus_window_length() Description: Returns the number of samples that are averaged to produce a single focus correction from the WFS loop. The magnitude of the correction is the resulting average divided by the number of samples. Command: tcs.set_tiptilt_gain() Description: Sets the gain factor applied to the tiptilt correction emitted by the loop. Optional parameters: gain - The gain by which the correction is scaled prior to being applied to the trajectory. Command: tcs.get_tiptilt_gain() Description: Returns the current gain factor applied to the tiptilt correction emitted by the loop. Command: tcs.set_focus_gain() Description: Sets the gain factor applied to the focus correction emitted by the loop. Optional parameters: gain - The gain by which the correction is scaled prior to being applied to the trajectory. Command: tcs.get_focus_gain() Description: Returns the current gain factor applied to the focus correction emitted by the loop. Command: tcs.clear_trajectories() Description: Cancels any active trajectory and clear both the current and next trajectories. Command: tcs.update_setup() Description: Marks the system as being setup and ready for science instrument operations, or not. Required parameters: state - Flag indicating the state of the system. Command: tcs.wait_for_setup() Description: Returns when the system is flagged as being setup for observation. Optional parameters: timeout - Amount of time to spend waiting for the setup condition to be true. If non-negative and the time expires prior to the setup, then an exception is thrown. If negative, the call waits indefinitely. Defaults to -1. (second) Command: tcs.set_metadata() Description: Sets all parameters given as header key metadata making the key/value pairs available via get_metadata. Command: tcs.get_metadata() Description: Returns all key/value pairs set through set_metadata. Command: tcs.disable_rho() Description: Forces the rho value to remain fixed at zero the current trajectory points. Note that this only impact trajectory points, not static tracker moves. This interface is for engineering purposes only. Command: tcs.enable_rho() Description: Reenables the application the rho value to trajectory points. Note that this only impact trajectory points, not static tracker moves. This interface is for engineering purposes only. TCS Events Event: tcs.root.ra_dec Description: Primary pointing information. Parameters: ra - right ascension (hour) ra_2000 - right ascension in J2000 (hour) ra_offset - manual offset applied to right ascension (arcsecond) dec - declination (degree) dec_2000 - declination in J2000 (degree) dec_offset - manual offset applied to declination (arcsecond) az - azimuth of the structure (degree) el - elevation of the structure (degree) parallactic_angle - parallactic angle of the primary field (degree) hour_angle - hour angle of the primary field (degree) zenith_disatance - zenith distance of the primary field (degree) lst - local sidereal time (hour) offset.sky.x - offset in telecentric x (arcsecond) offset.sky.y - offset in telecentric y (arcsecond) offset.focus.w - focus offset in w, focal axis (arcsecond) offset.tiptilt.theta - angular offset about the x axis (arcsecond) offset.tiptilt.phi - angular offset about the y axis (arcsecond) offset.rho - offset in rho (arcsecond) correction.sky.x - on sky mount model terms, x (arcsecond) correction.sky.y - on sky mount model terms, y (arcsecond) correction.emp.x - emperical correction to sky model (arcsecond) correction.emp.y - emperical correction to sky model (arcsecond) setup - flag indicating that the system is setup Event: tcs.root.gui Description: Issued when the toggle_gui_token() handler is called. Parameters: token - parent GUI identity Event: tcs.root.setup Description: Issued when the system transitions to or from being ready for an observation. Parameters: status - Flag indicating the state of the setup Event: tcs.trajectory.start Description: Parameters: id - trajectory identifier Event: tcs.trajectory.stop Description: Parameters: id - trajectory identifier message - how the track ended Event: tcs.trajectory.correction Description: The current aggregate metrology correction applied to the next block of trajectory points. Parameters: id - trajectory identifier loop - metrology instrument name itf.dx - change in x_itf (mm) itf.dy - change in y_itf (mm) itf.dz - change in z_itf (mm) itf.drho - change in rho_itf (mm) itf.dtheta - change in theta_itf (mm) itf.dphi - change in phi_itf (mm) Event: tcs.trajectory.dt Description: Parameters: id - trajectory identifier dt - time delta between now and the time associated with the next point to be discarded (second) Event: tcs.trajectory.tiptilt_offset Description: Parameters: id - trajectory identifier dtheta - change in theta_itf (degree) dphi - change in phi_itf (degree) Event: tcs.trajectory.time Description: Parameters: remaining - seconds remaining (second) Event: tcs.trajectory.cancel Description: Marks the end of a trajectory when cancelled. Parameters: id - trajectory identifier ra - right ascension (hour) dec - declination (degree) eq - equinox (year) cmd_ra - commanded right ascension (hour) cmd_dec - commanded declination (degree) cmd_eq - commanded equinox (year) alt - altitude of the structure (degree) az - azimuth of the structure (degree) el - elevation of the structure (degree) pa - parallactic angle, center track (degree) dir - direction, EAST or WEST index_time - tracker index time at start of track (second) utc - UTC date at start of track duration - time remaining (second) n - number of 60 second trajectory samples t - timestamps (second) x - x_itf values (mm) y - y_itf values (mm) z - z_itf values (mm) rho - rho_itf values (degree) theta - theta_itf values (degree) phi - phi_itf values (degree) offset.theta - offset about the x axis (arcsecond) offset.phi - offset about the y axis (arcsecond) Event: tcs.trajectory.go_next Description: Marks the execution of the go_next command. Note that this event does not imply a successful start to the trajectory, see start. Parameters: id - trajectory identifier ra - right ascension (hour) dec - declination (degree) eq - equinox (year) cmd_ra - commanded right ascension (hour) cmd_dec - commanded declination (degree) cmd_eq - commanded equinox (year) alt - altitude of the structure (degree) az - azimuth of the structure (degree) el - elevation of the structure (degree) pa - parallactic angle, center track (degree) dir - direction, EAST or WEST index_time - tracker index time at start of track (second) utc - UTC date at start of track duration - time remaining (second) n - number of 60 second trajectory samples t - timestamps (second) x - x_itf values (mm) y - y_itf values (mm) z - z_itf values (mm) rho - rho_itf values (degree) theta - theta_itf values (degree) phi - phi_itf values (degree) offset.theta - offset about the x axis (arcsecond) offset.phi - offset about the y axis (arcsecond) Event: tcs.trajectory.next_trajectory Description: Marks the loading of the next trajectory. Parameters: id - trajectory identifier ra - right ascension (hour) dec - declination (degree) eq - equinox (year) cmd_ra - commanded right ascension (hour) cmd_dec - commanded declination (degree) cmd_eq - commanded equinox (year) alt - altitude of the structure (degree) az - azimuth of the structure (degree) el - elevation of the structure (degree) pa - parallactic angle, center track (degree) dir - direction, EAST or WEST index_time - tracker index time at start of track (second) utc - UTC date at start of track duration - time remaining (second) n - number of 60 second trajectory samples t - timestamps (second) x - x_itf values (mm) y - y_itf values (mm) z - z_itf values (mm) rho - rho_itf values (degree) theta - theta_itf values (degree) phi - phi_itf values (degree) offset.theta - offset about the x axis (arcsecond) offset.phi - offset about the y axis (arcsecond) Event: tcs.trajectory.offset Description: Marks that an offset has been applied to the trajectory. Parameters: id - trajectory identifier ra - right ascension (hour) dec - declination (degree) eq - equinox (year) cmd_ra - commanded right ascension (hour) cmd_dec - commanded declination (degree) cmd_eq - commanded equinox (year) alt - altitude of the structure (degree) az - azimuth of the structure (degree) el - elevation of the structure (degree) pa - parallactic angle, center track (degree) dir - direction, EAST or WEST index_time - tracker index time at start of track (second) utc - UTC date at start of track duration - time remaining (second) n - number of 60 second trajectory samples t - timestamps (second) x - x_itf values (mm) y - y_itf values (mm) z - z_itf values (mm) rho - rho_itf values (degree) theta - theta_itf values (degree) phi - phi_itf values (degree) offset.theta - offset about the x axis (arcsecond) offset.phi - offset about the y axis (arcsecond) Event: tcs.trajectory.setup Description: Issued when the system transitions to or from being ready for an observation. Parameters: id - trajectory identifier ra - right ascension (hour) dec - declination (degree) eq - equinox (year) cmd_ra - commanded right ascension (hour) cmd_dec - commanded declination (degree) cmd_eq - commanded equinox (year) alt - altitude of the structure (degree) az - azimuth of the structure (degree) el - elevation of the structure (degree) pa - parallactic angle, center track (degree) dir - direction, EAST or WEST index_time - tracker index time at start of track (second) utc - UTC date at start of track duration - time remaining (second) n - number of 60 second trajectory samples t - timestamps (second) x - x_itf values (mm) y - y_itf values (mm) z - z_itf values (mm) rho - rho_itf values (degree) theta - theta_itf values (degree) phi - phi_itf values (degree) offset.theta - offset about the x axis (arcsecond) offset.phi - offset about the y axis (arcsecond) Event: tcs.probe_name.state Description: Event indicating the status of the loop, whether it is active, enabled, or neither. Parameters: enabled - flag indicating the loop is running and processing information from pas active - flag indicating the loop is actively applying the received corrections to any running trajectory Event: tcs.probe_name.fiducial Description: Marks the point where a fiducial is set, or offset, for the loop. Parameters: object.icx - x value of new fiducial coordinate (pixel) object.icy - y value of new fiducial coordinate (pixel) Event: tcs.probe_name.analysis_region Description: Marks the point where an analysis region is set for the loop. Parameters: xmin - minimum x coordinate of new analysis region (pixel) xmax - maximum x coordinate of new analysis region (pixel) ymin - minimum y coordinate of new analysis region (pixel) ymax - maximum y coordinate of new analysis region (pixel) Event: tcs.probe_name.measurement Description: Event containing parameters for the current measurement coming from the metrology system. Parameters: valid - flag indicating whether the measurement is valid validity_error - text indicating what went wrong with the measurement, if anythign object.icx - x coordinate of the centroid (pixel) object.icy - y coordinate of the centroid (pixel) ccdpix.dx - prescribed change in x (pixel) ccdpix.dy - prescribed change in y (pixel) focal_plane.dx_asec - x correction, in focal plane (arcsecond) focal_plane.dy_asec - y correction, in focal plane (arcsecond) tracker.dx_asec - x correction, in tracker x,y (arcsecond) tracker.dy_asec - y correction, in tracker x,y (arcsecond) tracker.dphi_asec - phi correction, in tracker x,y (arcsecond) tracker.dtheta_asec - theta correction, in tracker x,y (arcsecond) ignored_for_offset - flag indicating whether the information has been ignored for an outstanding offset active - flag indicating whether the loop is active dw - prescribed change in w (mm) dgroc - prescribed change in GROC based on latest DMI read and current instantaneous dw measured (mm) focus.correction.w - current prescribed change to w, after filtering (mm) tiptilt.correction.phi_asec - current prescribed change to phi, after filtering (arcsecond) tiptilt.correction.theta_asec - current prescribed change to theta, after filtering (arcsecond) delta.w - measured error in w (mm) w - measured w (mm) correction.w - prescribed correction, after filtering (mm) Event: tcs.probe_name.focus Description: Marks a change to the target DMI value. Parameters: w - the new target DMI value (mm) Event: tcs.metrology.correction Description: Metrology correction event. Parameters: loop - string identifying the source of the correction itf.dx - change to ITF x (mm) itf.dy - change to ITF y (mm) itf.dz - change to ITF z (mm) itf.drho - change to rho (degree) itf.dtheta - change to theta (degree) itf.dphi - change to phi (degree) dw - change to w (mm) Event: tcs.tracker.following Description: Parameters: velocity - implied velocity (x,y,z) from current position to next commanded (mm/s) Event: tcs.tracker.point Description: Next commanded tracker position in RTF. Parameters: rtf.t - time of tracker position (seconds) rtf.x - x coordinate, in RTF (mm) rtf.y - y coordinate, in RTF (mm) rtf.z - z coordinate, in RTF (mm) rtf.rho - rho coordinate, in RTF (degree) rtf.theta - theta coordinate, in RTF (degree) rtf.phi - phi coordinate, in RTF (degree) Event: tcs.tracker.position Description: Current tracker position. Parameters: rtf.t - time of tracker position (seconds) rtf.x - x coordinate, in RTF (mm) rtf.y - y coordinate, in RTF (mm) rtf.z - z coordinate, in RTF (mm) rtf.rho - rho coordinate, in RTF (degree) rtf.theta - theta coordinate, in RTF (degree) rtf.phi - phi coordinate, in RTF (degree) itf.t - time of tracker position (seconds) itf.x - x coordinate, in ITF (mm) itf.y - y coordinate, in ITF (mm) itf.z - z coordinate, in ITF (mm) itf.rho - rho coordinate, in ITF (degree) itf.theta - theta coordinate, in ITF (degree) itf.phi - phi coordinate, in ITF (degree) tsf.ux - upper x coordinate, in TSF (mm) tsf.lx - lower x coordinate, in TSF (mm) tsf.y - y coordinate, in TSF (mm) tsf.h1 - hexapod 1 coordinate, in TSF (mm) tsf.h2 - hexapod 2 coordinate, in TSF (mm) tsf.h3 - hexapod 3 coordinate, in TSF (mm) tsf.h4 - hexapod 4 coordinate, in TSF (mm) tsf.h5 - hexapod 5 coordinate, in TSF (mm) tsf.h6 - hexapod 6 coordinate, in TSF (mm) tsf.rho - rho coordinate, in TSF (degree) Event: tcs.probe_name.pointing Description: Positional information for the probe. Parameters: current_x - current x position in focal plane (degree) current_y - current y position in focal plane (degree) target_x - targeted x position in focal plane (degree) target_y - targeted y position in focal plane (degree) current_arm - arm position (degree) current_carriage - carriage position (degree) current_orientation - orientation of imager (degree) ra - right ascension of the probe pointing, current epoch (hour) dec - declination of the probe pointing, current epoch (degree) ra_2000 - right ascension of the probe pointing, J2000 (hour) dec_2000 - declination of the probe pointing, J2000 (degree) target_ra - Latest commanded right ascension of the probe pointing, current epoch (hour) target_dec - Latest commanded declination of the probe pointing, current epoch (degree) target_eq - Equinox for latest commanded pointing (degree) enabled - flag indicating that metrology is enabled for this probe (degree) active - flag indicating that metrology is active for this probe (degree) TRACKER Commands Command: tracker.initTMCS() Description: Initializes the TMCS hardware. @sa tracker_init Command: tracker.setTraj() Description: Sends a trajectory point to TMCS. @sa tracker_settraj, tmcs_set_traj Required parameters: id - Identifier for the trajectory. t - ISO8601 formatted string. x - XXX y - XXX z - XXX rho - XXX theta - XXX phi - XXX Command: tracker.abortMove() Description: Aborts running trajectory by sending ABORT command to TMCS. Optional parameters: id - The ID of the trajectory to abort. Defaults to 0 Command: tracker.setBufferSize() Description: Sets the number of trajectory points that will be buffered prior to sending to TMCS. Required parameters: size - Number of points Command: tracker.clearError() Description: Clears a TMCS error by sending the CLR command to TMCS. Required parameters: idx - XXX Command: tracker.moveRTF() Description: Sends a move command in RTF coordinates. Sends with tmcs_mova_rtf or tmcs_movr_rtf command depending on the type parameter. Required parameters: type - XXX vel - XXX x - XXX y - XXX z - XXX rho - XXX theta - XXX phi - XXX Command: tracker.moveTSF() Description: Sends a move command in tracker coordinates. Required parameters: type - move type, either rel (relative) or abs (absolute) vel - velocity string, see ??? (need TMCS reference) x - x coordinate (mm) y - y coordinate (mm) rho - rho coordinate (deg) h1 - Hexapod leg 1 coordinate (mm) h2 - XXX h3 - XXX h4 - XXX h5 - XXX h6 - XXX Command: tracker.timeToIntercept() Description: Reports the time to intercept an initial trajectory vector. Sends a tmcs_move_time command pair to TMCS and responds with the time the tracker would take to move from the current position to the first point of the point pair given assuming they represent an initial trajectory vector. Required parameters: id1 - Trajectory ID of the first point t1 - Index time of the first point x1 - x coordinate of the first point (mm) y1 - y coordinate of the first point (mm) z1 - z coordinate of the first point (mm) rho1 - rho coordinate of the first point (deg) theta1 - theta coordinate of the first point (deg) phi1 - phi coordinate of the first point (deg) id2 - Trajectory ID of the second point t2 - Index time of the second point x2 - x coordinate of the second point (mm) y2 - y coordinate of the second point (mm) z2 - z coordinate of the second point (mm) rho2 - rho coordinate of the second point (deg) theta2 - theta coordinate of the second point (deg) phi2 - phi coordinate of the second point (deg) CAMRA Commands Command: camra.reset() Description: Resets the ARC hardware subsystem and rebuilds related wrapper classes. Command: camra.turn_off_leds() Description: Turns off the LEDs on one or more controllers. Optional parameters: cntl - Identifier of the controller to operate on, defaults to 0 for all. Command: camra.set_ccd_temp() Description: Set the target temperature setpoint of the given %CCD. Required parameters: temp - The target temperature setpoint. Optional parameters: ccd - Identifier of the %CCD to operate on, defaults to 0 for all. Command: camra.set_bias_offset() Description: Set the bias offset of the given amplifier. Amplifier is specified as a combination of %CCD identifier and position, either upper, lower, or all. Required parameters: count - The offset count setting. ccd - Identifier of the %CCD to operate on, defaults to 0 for all. amp - Amplifier to tune, either upper, lower, or all. Command: camra.reset_clock_voltages() Description: Resets the CCD clock voltages for all configured CCDs to the voltages given in the configuration. Command: camra.get_clock_voltages() Description: Returns the clock voltages for each CCD in the system. Command: camra.set_clock_voltages() Description: Sets the CCD clock voltages. Optional parameters: ccd - Identifier of the %CCD to operate on, defaults to 0 for all. serial_1_high - Sets the serial clock phase 1 high voltage to the given value. serial_1_low - Sets the serial clock phase 1 low voltage to the given value. parallel_1_high - Sets the parallel clock phase 1 high voltage to the given value. parallel_1_low - Sets the parallel clock phase 1 low voltage to the given value. serial_2_high - Sets the serial clock phase 2 high voltage to the given value. serial_2_low - Sets the serial clock phase 2 low voltage to the given value. parallel_2_high - Sets the parallel clock phase 2 high voltage to the given value. parallel_2_low - Sets the parallel clock phase 2 low voltage to the given value. serial_3_high - Sets the serial clock phase 3 high voltage to the given value. serial_3_low - Sets the serial clock phase 3 low voltage to the given value. parallel_3_high - Sets the parallel clock phase 3 high voltage to the given value. parallel_3_low - Sets the parallel clock phase 3 low voltage to the given value. reset_gate_high - Sets the reset gate high voltage to the given value. reset_gate_low - Sets the reset gate low voltage to the given value. summing_well_high - Sets the summing well high voltage to the given value. summing_well_low - Sets the summing well low voltage to the given value. lower_output_drain - Sets the output drain voltage for the lower amplifier. upper_output_drain - Sets the output drain voltage for the upper amplifier. reset_drain - Sets the reset drain voltage. output_gate - Sets the output gate voltage. Command: camra.get_ccd_temp() Description: Read the temperature of the given %CCD. Temperatures are returned by HRL (XXX document HRL format) key followed by a \".temp\" prefix. Optional parameters: ccd - Identifier of the %CCD to operate on, defaults to 0 for all. update_state - Flag indicating to read a new value from the hardware. Default behavior is to return the previous value read incurring no additional overhead in hardware latencies. Command: camra.get_cryo_temp() Description: Read the \"cold finger\" temperature of the given controller. Temperatures are returned by HRL (XXX document HRL format) key followed by a \".cryo_temp\" prefix. Optional parameters: cntl - Identifier of the controller to operate on, defaults to 0 for all. update_state - Flag indicating to read a new value from the hardware. Default behavior is to return the previous value read incurring no additional overhead in hardware latencies. Command: camra.get_cryo_pressure() Description: Read the cryostat pressure of the spectrograph for the given controller. Temperatures are returned by HRL (XXX document HRL format) key followed by a \".cryo_pressure\" prefix. Optional parameters: cntl - Identifier of the controller to operate on, defaults to 0 for all. update_state - Flag indicating to read a new value from the hardware. Default behavior is to return the previous value read incurring no additional overhead in hardware latencies. Command: camra.get_heater_voltage() Description: Read the CCD heater voltage. Voltages are returned by HRL (XXX document HRL format) key followed by a \".voltage\" prefix. Optional parameters: ccd - Identifier of the %CCD to operate on, defaults to 0 for all. update_state - Flag indicating to read a new value from the hardware. Default behavior is to return the previous value read incurring no additional overhead in hardware latencies. Command: camra.get_hardware_status() Description: Read all hardware status fields for the given %CCD. Optional parameters: update_state - Flag indicating to read a new value from the hardware. Default behavior is to return the previous value read incurring no additional overhead in hardware latencies. Command: camra.get_exposure_info() Description: Returns the exposure descriptor fields associated with the currently active exposure. Command: camra.read_now() Description: Ends the currenlty active exposure and initiate readout. Command: camra.abort() Description: Aborts the currenlty active exposure discarding all data. Command: camra.expose() Description: Takes an exposure. The combination of observation, exposure, effective date, and effective instrument must resolve to a unique file name with respect to the files on disk at the point of write. This handler returns when the exposure has begun. Optional parameters: object - User chosen name for the \"object\" being observed. observation - Observation number. exposure - Exposure number. dirdate - Directory date. Default is YYYYmmdd based on current UT date. recipe - The path and filename of the script invoking the command. subordinate - Flag indicating whether this exposure is a subordinate in a parallel exposure where the primary shutter is driven by another instrument. This defaults to false. observer - Name of observer. operator - Name of operator. type - The type of the exposure, one of tst, sci, zro, drk, flt, cmp, eng or twi. If given, the type specified need not adhere to that implied by the other parameters. The type given is set as a substring in the output file names for this exposure. This defaults to tst, for test. force - Flag indicating that issues with the state of the system should be ignored, and the exposure executed anyway. Defaults to false. x_binning - Factor by which the x dimmension will be binned. y_binning - Factor by which the y dimmension will be binned. seconds - Target integration time for the exposure. subordinate - Indicates that a peer system will actuate the shutter. dark - Indicates that the shutter should remain disabled for this exposaure. Command: camra.open_shutter() Description: Open the configured shutter. This may be a TTL driven lab shutter or the PFIP shutter so exercise caution. Command: camra.close_shutter() Description: Close the configured shutter. This may be a TTL driven lab shutter or the PFIP shutter so exercise caution. Command: camra.enable_shutter() Description: Enable the configured shutter. This may be a TTL driven lab shutter or the PFIP shutter so exercise caution. Command: camra.disable_shutter() Description: Disable the configured shutter. This may be a TTL driven lab shutter or the PFIP shutter so exercise caution. Command: camra.enable_pressure_gauges() Description: Enables all cryostat pressure gauges configured in the array. Command: camra.disable_pressure_gauges() Description: Disable all cryostat pressure gauges configured in the array. Command: camra.wait_for_shutter_close() Description: Returns when the shutter is closed for the given exposure. @sa wait_for_readout, wait_for_write Required parameters: exposure - Identifier of the exposure to wait on. observation - Observation identifier for the exposure to wait on. Command: camra.wait_for_readout() Description: Returns when the readout is complete for the given exposure. @sa wait_for_shutter_open, wait_for_write Required parameters: exposure - Identifier of the exposure to wait on. observation - Observation identifier for the exposure to wait on. Command: camra.wait_for_write() Description: Returns when the write is complete for the given exposure. @sa wait_for_shutter_open, wait_for_write Required parameters: exposure - Identifier of the exposure to wait on. observation - Observation identifier for the exposure to wait on. Command: camra.command_controller() Description: Sends the given command to the specified controller. Required parameters: id - Controller ID to operate on. command - Integer representation of the command to be sent. For example, to send the POF command, give command=0x504F46. Optional parameters: arg1 - Integer argument to be passed to the requested command. arg2 - Integer argument to be passed to the requested command. arg3 - Integer argument to be passed to the requested command. arg4 - Integer argument to be passed to the requested command. Return parameters: response - The string representation of the response from the controller. Command: camra.reset_mux() Description: Resets the requested mux. Required parameters: index - Index of the mux in the array, as enumerated by the software. Command: camra.reset_tcs() Description: Flags the socket connection to tcs for resetting. The reset occurs on the next subsequent failed ACK from tcs. Command: camra.populate_onewire_device_strings() Description: Reads all onewire devices in the array, populating related header fields with the information parsed. Command: camra.set_ccd_temp_xfer() Description: Sets the parameters for the given CCDs temperature transfer function. Required parameters: ccd - CCD ID to operate on. bias - Bias value for the transfer function. gain - Gain value for the transfer function. Command: camra.set_cryo_temp_xfer() Description: Sets the parameters for the temperature transfer function for the cryostat RTD associated with the given controller ID. Required parameters: cntl - Controller ID to operate on. bias - Bias value for the transfer function. gain - Gain value for the transfer function. Command: camra.override_ifu_associations() Description: Sets one or more of the following parameters for a given controller ID: IFU ID, IFU slot, and/or spectrograph slot. Note that there is no check to ensure that the values given are unique with respect to the rest of the array configuration. Note that this is a transient change and the configuration will return to the values read from the command line config upon restart. Required parameters: cntl - Controller ID to operate on. Optional parameters: ifu_id - New IFU ID for the given controller. ifu_slot - New IFU slot for the given controller. spectrograph_slot - New spectrograph slot for the given controller.