MTPtg¶
Note
This page is generated by python script generate_cet.py.
Commands¶
azCurrentWrap¶
Description: Move the azimuth axis by 360 or -360 degrees if possible.
- EFDB_Topic
MTPtg_command_azCurrentWrap
azElTarget¶
Description: Define a telescope target, with a position defined as Azimuth and Elevation.
- EFDB_Topic
MTPtg_command_azElTarget
rotPA¶
- IDL_Type
double
- Units
degree
Description: Desired instrument position angle, Eastwards from North
clearCollOffset¶
Description: Clear (set to zero) collimation CA and CE values
- EFDB_Topic
MTPtg_command_clearCollOffset
collOffset¶
Description: Set collimation CE, CA values in the pointing model
- EFDB_Topic
MTPtg_command_collOffset
debugLevel¶
Description: Set the internal debug level. Increasing the debug level increases the number of log messages produced.
- EFDB_Topic
MTPtg_command_debugLevel
ephemTarget¶
Description: Define a telescope target using ephemeris data defined in a file.
- EFDB_Topic
MTPtg_command_ephemTarget
dRA¶
- IDL_Type
double
- Units
arcsec / s
Description: Differential Track Rate in RA, in addition to any inherent tracking rate the object may have
dDec¶
- IDL_Type
double
- Units
arcsec / s
Description: Differential Track Rate in Dec, in addition to any inherent tracking rate the object may have
rotPA¶
- IDL_Type
double
- Units
degree
Description: Desired instrument position angle, Eastwards from North
validateOnly¶
- IDL_Type
boolean
- Units
unitless
Description: If set True, then this target command is validated only, don’t change the current demand. The validation result will be posted by validatedTarget event.
focusName¶
Description: Not used
- EFDB_Topic
MTPtg_command_focusName
focus¶
- IDL_Type
long
- Units
unitless
Description: Select M3 focus position: prime, nasmyth1 or nasmyth2.
iersUpdate¶
Description: Download IERS (earth rotation) data from remote server.
- EFDB_Topic
MTPtg_command_iersUpdate
offsetAbsorb¶
Description: Apply the current target offset(s) to the defined target position
- EFDB_Topic
MTPtg_command_offsetAbsorb
offsetAzEl¶
Description: Apply an offset, specified as Azimuth and Elevation offsets.
- EFDB_Topic
MTPtg_command_offsetAzEl
offsetClear¶
Description: Clear (set to zero) the currently defined target offset(s)
- EFDB_Topic
MTPtg_command_offsetClear
offsetPA¶
Description: Apply an offset, defined by a position angle and radius, to the current target position.
- EFDB_Topic
MTPtg_command_offsetPA
angle¶
- IDL_Type
double
- Units
degree
Description: Offset position angle in degrees, clockwise from North
offsetRADec¶
Description: Apply an offset in RA and Dec to the current target position.
- EFDB_Topic
MTPtg_command_offsetRADec
off1¶
- IDL_Type
double
- Units
arcsec
Description: Offset in RA or X, relative to target position (in arcsec if type is TPLANE, second if SIMPLE)
planetTarget¶
Description: Select a named major planet as the telescope target.
- EFDB_Topic
MTPtg_command_planetTarget
planetName¶
- IDL_Type
long
- Units
unitless
Description: Id of the planet name; mercury (1), venus (2), moon (3), mars (4), jupiter (5), saturn (6), uranus (7), neptune (8) or pluto (9)
dRA¶
- IDL_Type
double
- Units
arcsec / second
Description: Differential Track Rate in RA, in addition to the planet’s inherent tracking rate
dDec¶
- IDL_Type
double
- Units
arcsec / second
Description: Differential Track Rate in Declination , in addition to the planet’s inherent tracking rate
rotPA¶
- IDL_Type
double
- Units
degree
Description: Desired instrument position angle, Eastwards from North
validateOnly¶
- IDL_Type
boolean
- Units
unitless
Description: If set True, then this target command is validated only, don’t change the current demand. The validation result will be posted by validatedTarget event.
pointAddData¶
Description: Add telescope axis position data to the pointing data file.
- EFDB_Topic
MTPtg_command_pointAddData
pointLoadModel¶
Description: Load a telescope pointing model defined in an existing data file
- EFDB_Topic
MTPtg_command_pointLoadModel
pointNewFile¶
Description: Create and open a new pointing data file. A unique name for the file will be defined internally.
- EFDB_Topic
MTPtg_command_pointNewFile
poriginAbsorb¶
Description: Apply the current pointing origin offset(s) to the defined pointing origin
- EFDB_Topic
MTPtg_command_poriginAbsorb
poriginClear¶
Description: Clear (set to zero) any currently defined pointing origin offsets
- EFDB_Topic
MTPtg_command_poriginClear
poriginOffset¶
Description: Define an [X,Y] position offset for the current pointing origin on the focal plane
- EFDB_Topic
MTPtg_command_poriginOffset
poriginXY¶
Description: Define the absolute [X,Y] position of the pointing origin on the focal plane. The pointing origin is the position on the focal plane at which the current target is positioned.
- EFDB_Topic
MTPtg_command_poriginXY
x¶
- IDL_Type
double
- Units
mm
Description: X Pointing origin in the focal plane. Origin is the axis of the rotator
y¶
- IDL_Type
double
- Units
mm
Description: Y Pointing origin in the focal plane. Origin is the axis of the rotator
raDecTarget¶
Description: Define a telescope target, with a position defined as RA and Dec.
- EFDB_Topic
MTPtg_command_raDecTarget
epoch¶
- IDL_Type
double
- Units
year
Description: Target epoch in years e.g. 2000.0. Julian (J) epoch is assumed.
rotAngle¶
- IDL_Type
double
- Units
deg
Description: Desired instrument position angle, Eastwards from North if rotStartFrame is target or azel. Rotator physical angle if rotStartFrame is fixed.
rotStartFrame¶
- IDL_Type
long
- Units
unitless
Description: Rotator co-ordinate frame for rotator start position. target = same frame as target. azel = maintain sky orientation. fixed = rotator physical angle.
rotTrackFrame¶
- IDL_Type
long
- Units
unitless
Description: Rotator co-ordinate frame for rotator tracking. target = same frame as target. azel = maintain sky orientation. fixed = rotator physical angle.
azWrapStrategy¶
- IDL_Type
long
- Units
unitless
Description: Azimuth wrap strategy.(1-noUnWrap, 2-optimize, 3-maxTimeOnTarget)
validateOnly¶
- IDL_Type
boolean
- Units
unitless
Description: If set True, then this target command is validated only, don’t change the current demand. The validation result will be posted by validatedTarget event.
rotCurrentWrap¶
Description: Move the rotator axis by 360 or -360 degrees if possible.
- EFDB_Topic
MTPtg_command_rotCurrentWrap
rotOffset¶
Description: Define the instrument alignment angle (IAA)
- EFDB_Topic
MTPtg_command_rotOffset
startTracking¶
Description: Calculate the RA and Dec co-ordinates that correspond to the current mount position and start tracking on this target
- EFDB_Topic
MTPtg_command_startTracking
stopTracking¶
Description: Stop tracking. Axes positions will not be sent to the mount.
- EFDB_Topic
MTPtg_command_stopTracking
disable¶
Description: Transition from state Enabled to Disabled.
- EFDB_Topic
SALGeneric_command_disable
- Category
csc
enable¶
Description: Transition from state Disabled to Enabled.
- EFDB_Topic
SALGeneric_command_enable
- Category
csc
exitControl¶
Description: Transition from state Standby to Offline. For CSCs that start in Standby state this makes the CSC quit. CSCs that start in Offline state, they remain active.
- EFDB_Topic
SALGeneric_command_exitControl
- Category
csc
setAuthList¶
- EFDB_Topic
SALGeneric_command_setAuthList
- Category
csc
authorizedUsers¶
- IDL_Type
string
- Units
unitless
- Description: Comma seperated list of authorized users currently allowed to command this CSC,
in the form user@host. If the first character is +/- then the specified users are added/removed. Duplicates are silently ignored. The CSC’s own user@host is silently ignored, because it is always authorized. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.
nonAuthorizedCSCs¶
- IDL_Type
string
- Units
unitless
- Description: Comma seperated list of CSC’s not currently allowed to command this CSC,
in the form name[:index]. An index of 0 is stripped (name:0 becomes name). If the first character is +/- then the specified CSCs are added/removed. Duplicates are silently ignored. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.
setLogLevel¶
Description: Set the logging level.
- EFDB_Topic
SALGeneric_command_setLogLevel
- Category
csc
level¶
- IDL_Type
int
- Units
unitless
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem¶
- IDL_Type
string
- Units
unitless
Description: If the CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to the CSC itself.
standby¶
Description: Transition from state Offline, Disabled or Fault to Standby.
- EFDB_Topic
SALGeneric_command_standby
- Category
csc
start¶
Description: Transition from state Standby to Disable, in a specified configuration.
- EFDB_Topic
SALGeneric_command_start
- Category
csc
configurationOverride¶
- IDL_Type
string
- Units
unitless
- Description:
Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:
“foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.
“:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.
“bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.
settingsToApply¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: DEPRECATED: uae override instead. Name of the selected settings set
Enumerations¶
- SummaryState
DisabledState
EnabledState
FaultState
OfflineState
StandbyState
- LogLevel
none
fatal
error
warning
info
debug
verbose
- OffTypes
simple
tplane
- OnOff
on
off
- Wraps
cw
ccw
- CoordFrame
fk5
icrs
- RotFrame
target
azel
fixed
- RotMode
field
slit
- Planets
mercury
venus
moon
mars
jupiter
saturn
uranus
neptune
pluto
- Foci
prime
nasmyth1
nasmyth2
- WarningLevel
none
minor
major
- DetailedStates
notTracking
azEl
openLoop
guiding
- TargetTypes
raDec
azEl
planet
ephem
- WrapStrategy
noUnWrap
optimize
maxTimeOnTarget
Events¶
airmassWarning¶
Description: Airmass at the current target elevation exceeds the Airmass warning value.
- EFDB_Topic
MTPtg_logevent_airmassWarning
azWrapWarning¶
Description: The time to the current azimuth wrap limit for the target is less than the azimuth wrap warning value.
- EFDB_Topic
MTPtg_logevent_azWrapWarning
currentTarget¶
Description: This event is posted when a new target command (raDecTarget, azElTarget, planetTarget or ephemTarget) is accepted by the component. The target command’s parameter values will be copied to the same parameters in this event.
- EFDB_Topic
MTPtg_logevent_currentTarget
planetName¶
- IDL_Type
long
- Units
unitless
Description: Id of the planet name; mercury (1), venus (2), moon (3), mars (4), jupiter (5), saturn (6), uranus (7), neptune (8) or pluto (9)
difftrackRA¶
- IDL_Type
double
- Units
arcsec / second
Description: Target differential track rate in RA (units RAsecs/second)
difftrackDec¶
- IDL_Type
double
- Units
arcsec / second
Description: Target differential track rate in Dec (units arcsecs/second)
properMotionRA¶
- IDL_Type
double
- Units
arcsec / year
Description: Target proper motion in RA (units RAsecs/year)
properMotionDec¶
- IDL_Type
double
- Units
arcsec / year
Description: Target proper motion in Dec (units arcsecs/year)
rotPA¶
- IDL_Type
double
- Units
degree
Description: Rotator position angle in degrees(planet and ephemeris target)
rotAngle¶
- IDL_Type
double
- Units
degree
Description: Desired instrument position angle, Eastwards from North if rotStartFrame is target or azel. Rotator physical angle if rotStartFrame is fixed.
rotStartFrame¶
- IDL_Type
long
- Units
unitless
Description: Rotator co-ordinate frame for rotator start position. target = same frame as target. azel = maintain sky orientation. fixed = rotator physical angle.
rotTrackFrame¶
- IDL_Type
long
- Units
unitless
Description: Rotator co-ordinate frame for rotator tracking. target = same frame as target. azel = maintain sky orientation. fixed = rotator physical angle.
elLimitWarning¶
Description: The time before the current target reaches elevation high limit is less than the object set warning value.
- EFDB_Topic
MTPtg_logevent_elLimitWarning
focusNameInconsistentWarning¶
Description: Not used
- EFDB_Topic
MTPtg_logevent_focusNameInconsistentWarning
iers¶
Description: Current IERS data used by the component
- EFDB_Topic
MTPtg_logevent_iers
timestamp¶
- IDL_Type
double
- Units
second
Description: Timestamp (as returned by SAL’s getCurrentTime) of successful IERS update.
iersOutOfDate¶
Description: The IERS data has not been updated recently
- EFDB_Topic
MTPtg_logevent_iersOutOfDate
moonProximityWarning¶
Description: The distance between the current target position and the Moon’s position is less than the Moon proximity warning value.
- EFDB_Topic
MTPtg_logevent_moonProximityWarning
mountDataWarning¶
Description: The mount status data hasn’t been received for more than the duration specified in the configuration file.
- EFDB_Topic
MTPtg_logevent_mountDataWarning
objectSetWarning¶
Description: The time before the current target sets below the elevation lower limit is less than the object set warning value.
- EFDB_Topic
MTPtg_logevent_objectSetWarning
offsetSummary¶
Description: Target offset data.
- EFDB_Topic
MTPtg_logevent_offsetSummary
handsetCollOffsetCA¶
- IDL_Type
double
- Units
arcsec
Description: Collimation handset offset CA (arcsecs)
handsetCollOffsetCE¶
- IDL_Type
double
- Units
arcsec
Description: Collimation CE handset offset (arcsecs)
pointingOriginUserDX¶
- IDL_Type
double
- Units
mm
Description: User pointing origin offset X on the focal plane (mm)
pointingOriginUserDY¶
- IDL_Type
double
- Units
mm
Description: User pointing origin offset Y on the focal plane (mm)
pointingOriginHandsetDX¶
- IDL_Type
double
- Units
mm
Description: Handset pointing origin offset X on the focal plane (mm)
pointingOriginHandsetDY¶
- IDL_Type
double
- Units
mm
Description: Handset pointing origin offset Y on the focal plane (mm)
pointData¶
Description: Data added to pointing file by pointAddData command.
- EFDB_Topic
MTPtg_logevent_pointData
pointingFile¶
Description: Pointing file is created or closed.
- EFDB_Topic
MTPtg_logevent_pointingFile
fileIsOpen¶
- IDL_Type
boolean
- Units
unitless
Description: If true, pointing file is open. If false, pointing file is closed.
pointingModel¶
Description: Pointing model data currently loaded.
- EFDB_Topic
MTPtg_logevent_pointingModel
pointingModelTermNames¶
- IDL_Type
string
- Units
unitless
Description: Comma separated list of pointing model term names.
ptgAzCurrentWrap¶
Description: Current internally selected azimuth wrap (azimuth travel range).
- EFDB_Topic
MTPtg_logevent_ptgAzCurrentWrap
currentWrap¶
- IDL_Type
long
- Units
unitless
Description: Direction of the azimuth wrap: cw (1) or ccw (2).
ptgRotCurrentWrap¶
Description: Current internally selected rotator wrap (rotator travel range).
- EFDB_Topic
MTPtg_logevent_ptgRotCurrentWrap
currentWrap¶
- IDL_Type
long
- Units
unitless
Description: Direction of the rotator wrap: cw (1) or ccw (2).
rotWrapWarning¶
Description: The time to the current rotator wrap limit for the target is less than the rotator wrap warning value.
- EFDB_Topic
MTPtg_logevent_rotWrapWarning
sunProximityWarning¶
Description: The distance between the current target position and the Sun’s position is less than the Sun proximity warning value.
- EFDB_Topic
MTPtg_logevent_sunProximityWarning
timesOfLimits¶
Description: Times of the current target reaching limits
- EFDB_Topic
MTPtg_logevent_timesOfLimits
timeAzLim¶
- IDL_Type
double
- Units
second
Description: Time the target reaches azimuth limit. TAI seconds.
timeRotLim¶
- IDL_Type
double
- Units
second
Description: Time the target reaches rotator limit. TAI seconds.
timeElHighLimit¶
- IDL_Type
double
- Units
second
Description: Time the target reaches elevation high limit. TAI seconds.
timeElLowLimit¶
- IDL_Type
double
- Units
second
Description: Time the target reaches elevation low limit. TAI seconds.
timeUnobservable¶
- IDL_Type
double
- Units
second
Description: Time the target becomes unobservable. TAI seconds.
trackPosting¶
Description: Indicates whether mount and rotator tracking commands are being posted
- EFDB_Topic
MTPtg_logevent_trackPosting
status¶
- IDL_Type
boolean
- Units
unitless
Description: If true, PTG controller is currently posting track commands to Mount components.
validatedTarget¶
Description: Target validation result and expected axis positions. The event is posted when the received target command’s validateOnly is true.
- EFDB_Topic
MTPtg_logevent_validatedTarget
weatherDataApplied¶
Description: Latest weather data applied to kernel.
- EFDB_Topic
MTPtg_logevent_weatherDataApplied
weatherDataInvalid¶
Description: The weather data has not been updated or invalid data received.
- EFDB_Topic
MTPtg_logevent_weatherDataInvalid
authList¶
- EFDB_Topic
SALGeneric_logevent_authList
- Category
csc
authorizedUsers¶
- IDL_Type
string
- Units
unitless
Description: Comma seperated list of authorized users currently allowed to command this CSC.
nonAuthorizedCSCs¶
- IDL_Type
string
- Units
unitless
Description: Comma seperated list of CSC’s not currently allowed to command this CSC.
errorCode¶
Description: Output when a CSC goes into the Fault state as an explanation of the problem.
- EFDB_Topic
SALGeneric_logevent_errorCode
- Category
csc
errorReport¶
- IDL_Type
string
- Units
unitless
Description: An string providing detailed information about the error
traceback¶
- IDL_Type
string
- Units
unitless
Description: An optional stack trace of the error condition
heartbeat¶
- EFDB_Topic
SALGeneric_logevent_heartbeat
- Category
mandatory
logLevel¶
Description: Current logging level.
- EFDB_Topic
SALGeneric_logevent_logLevel
- Category
mandatory
level¶
- IDL_Type
int
- Units
unitless
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem¶
- IDL_Type
string
- Units
unitless
Description: If the CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to the CSC itself.
logMessage¶
Description: A log message.
- EFDB_Topic
SALGeneric_logevent_logMessage
- Category
mandatory
level¶
- IDL_Type
int
- Units
unitless
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
lineNumber¶
- IDL_Type
long
- Units
unitless
Description: Line number in the file specified by filePath.
timestamp¶
- IDL_Type
double
- Units
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
simulationMode¶
Description: Current simulation mode.
- EFDB_Topic
SALGeneric_logevent_simulationMode
- Category
csc
mode¶
- IDL_Type
int
- Units
unitless
Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.
softwareVersions¶
Description: Current versions of software in use by CSC.
- EFDB_Topic
SALGeneric_logevent_softwareVersions
- Category
mandatory
salVersion¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: This is the current version of SAL generation
xmlVersion¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: This is the current version of CSC XML
openSpliceVersion¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: This is the current version of OpenSplice
cscVersion¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: This is the top-level version of the CSC
subsystemVersions¶
- IDL_Type
string
- Units
unitless
Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within a CSC
Telemetry¶
currentTargetStatus¶
Description: Calculated demands for current target
- EFDB_Topic
MTPtg_currentTargetStatus
mountPosition¶
Description: Telemetry for mount positions in sky coordinates
- EFDB_Topic
MTPtg_mountPosition
azimuthActualPosition¶
- IDL_Type
double
- Units
deg
Description: Azimuth axis position reported by mount component.
elevationActualPosition¶
- IDL_Type
double
- Units
deg
Description: Elevation axis position reported by mount component.
rotatorActualPosition¶
- IDL_Type
double
- Units
deg
Description: Rotator axis position reported by rotator component.
ra¶
- IDL_Type
double
- Units
deg
Description: RA calculated from the azimuthActualPosition and elevationActualPosition.
declination¶
- IDL_Type
double
- Units
deg
Description: Dec calculated from the azimuthActualPosition and elevationActualPosition.
namedAzEl¶
Description: Named telescope positions specified in the configuration file
- EFDB_Topic
MTPtg_namedAzEl
names¶
- IDL_Type
string
- Units
unitless
Description: Names of the Named AzEl positions (Comma separated)
azPositions¶
- IDL_Type
string
- Units
deg
Description: Azimuth positions of the named position. (Comma separated, specify ‘n/a’ to indicate no movement.)
elPositions¶
- IDL_Type
string
- Units
deg
Description: Elevation positions of the named position. (Comma separated, specify ‘n/a’ to indicate no movement.)
rotPositions¶
- IDL_Type
string
- Units
deg
Description: Rotator positions of the named position. (Comma separated, specify ‘n/a’ to indicate no movement.)
skyEnvironment¶
Description: Information related to the Sun and the Moon
- EFDB_Topic
MTPtg_skyEnvironment
twilightEndTime¶
- IDL_Type
double
- Units
second
Description: Astronomical twilight end time. TAI seconds.
twilightBeginTime¶
- IDL_Type
double
- Units
second
Description: Astronomical twilight begin time. TAI seconds.
sunTargetDistance¶
- IDL_Type
double
- Units
deg
Description: Distance on the sky between the target and the Sun
moonTargetDistance¶
- IDL_Type
double
- Units
deg
Description: Distance on the sky between the target and the Moon