Commands
clearError
Description: Clear the Fault state, sending the controller into Offline substate PublishOnly. You must use the engineering user interface to transition from that to Offline substate Available before the CSC can control the rotator.
EFDB_Topic: | Rotator_command_clearError |
state
IDL_Type: | boolean |
Units: | unitless |
Description: state
move
Description: Move the rotator to the specified position and stop. During the move the enabled substate will be MovingPointToPoint, then it will return to Stationary.
EFDB_Topic: | Rotator_command_move |
position
IDL_Type: | double |
Units: | deg |
Description: Desired position.
stop
Description: Stop the rotator and go to enabled substate Stationary.
EFDB_Topic: | Rotator_command_stop |
state
IDL_Type: | int |
Units: | unitless |
Description: Not used.
track
Description: Specify desired rotator position and velocity “slewing or tracking” mode, which is started with the trackStart command and concluded with the stop command.
EFDB_Topic: | Rotator_command_track |
angle
IDL_Type: | double |
Units: | deg |
Description: Desired position at the time specified by “tai”.
velocity
IDL_Type: | double |
Units: | deg/second |
Description: Desired velocity at the time specified by “tai”.
tai
IDL_Type: | double |
Units: | second |
Description: TAI time of the “position” and “velocity” fields.
trackStart
Description: Enter slewing/tracking mode (enabled substate SlewingOrTracking): follow a path specified by repeated track commands. Issue the stop command when you are done tracking.
EFDB_Topic: | Rotator_command_trackStart |
state
IDL_Type: | boolean |
Units: | unitless |
Description: state
abort
EFDB_Topic: | SALGeneric_command_abort |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
disable
Description: Transition from state Enabled to Disabled.
EFDB_Topic: | SALGeneric_command_disable |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
enable
Description: Transition from state Disabled to Enabled.
EFDB_Topic: | SALGeneric_command_enable |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
enterControl
Description: Transition from state Offline to Standby. Only “externally commandable” CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.
EFDB_Topic: | SALGeneric_command_enterControl |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
exitControl
Description: Transition from state Standby to Offline. For CSCs that are not “externally commandable” this makes the CSC quit.
EFDB_Topic: | SALGeneric_command_exitControl |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
setAuthList
EFDB_Topic: | SALGeneric_command_setAuthList |
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 |
level
IDL_Type: | int |
Units: | unitless |
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
setValue
EFDB_Topic: | SALGeneric_command_setValue |
parametersAndValues
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: List of parameters and their values as a Json string
standby
Description: Transition from state Offline, Disabled or Fault to Standby.
EFDB_Topic: | SALGeneric_command_standby |
value
IDL_Type: | boolean |
Units: | unitless |
Description: Not used
start
Description: Transition from state Standby to Disable, in a specified configuration.
EFDB_Topic: | SALGeneric_command_start |
settingsToApply
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: Name of the selected settings set
Events
commandableByDDS
Description: Can the CSC can control the rotator?
EFDB_Topic: | Rotator_logevent_commandableByDDS |
state
IDL_Type: | boolean |
Units: | unitless |
Description: If true the CSC can control the rotator; else the Engineering User Interface has control.
configuration
Description: Rotator configuration.
EFDB_Topic: | Rotator_logevent_configuration |
positionAngleUpperLimit
IDL_Type: | double |
Units: | deg |
Description: Position difference between the commanded position and the actual position that triggers system to switch between slew mode and track mode. Positive range limit (must be less than +90)
velocityLimit
IDL_Type: | double |
Units: | deg/s |
Description: Velocity limit
accelerationLimit
IDL_Type: | double |
Units: | deg/s2 |
Description: Acceleration limit
positionErrorThreshold
IDL_Type: | double |
Units: | deg |
Description: Position error threshold
positionAngleLowerLimit
IDL_Type: | double |
Units: | deg |
Description: Position difference between the commanded position and the actual position that triggers system to switch between slew mode and track mode. Negative range limit (must be greater than -90)
followingErrorThreshold
IDL_Type: | double |
Units: | deg |
Description: Deviation between commanded position and actual rotator position that triggers following error event/fault
trackingSuccessPositionThreshold
IDL_Type: | double |
Units: | deg |
Description: RMS deviation over 150ms interval between position command and actual rotator position for triggering tracking and tracklost events
trackingLostTimeout
Description: Duration between receiving slewing and tracking commands over DDS before tracklost event/fault is declared
connected
Description: State of TCP/IP connection to the low level controller.
EFDB_Topic: | Rotator_logevent_connected |
command
IDL_Type: | boolean |
Units: | unitless |
Description: Is the command socket connected (true=yes, false=no)?
telemetry
IDL_Type: | boolean |
Units: | unitless |
Description: Is the telemetry/config socket connected (true=yes, false=no)?
controllerState
Description: State reported by the low level controller. All values except applicationStatus are 1 greater than those reported by the controller for temporary and historical reasons.
EFDB_Topic: | Rotator_logevent_controllerState |
controllerState
IDL_Type: | long |
Units: | unitless |
Description: Basic state. A ControllerState enumeration value. The state names and meanings are the same as standard CSC summaryState, but the numeric values are ordered differently. We report the controller state in addition to summaryState because we need to report a summaryState even when the controller is not connected, and to aid diagnostics, e.g. in case the controller reports an unrecognized state.
offlineSubstate
IDL_Type: | long |
Units: | unitless |
Description: Substate in OFFLINE mode. An OfflineSubstate enumeration value.
enabledSubstate
IDL_Type: | long |
Units: | unitless |
Description: Substate in ENABLED mode. An EnabledSubstate enumeration value.
applicationStatus
IDL_Type: | long |
Units: | unitless |
Description: Application state. A bitmask of ApplicationStatus enumeration values.
inPosition
Description: Event to indicate rotator is in position or not
EFDB_Topic: | Rotator_logevent_inPosition |
inPosition
IDL_Type: | boolean |
Units: | unitless |
Description: Rotator in position
interlock
Description: Rotator interlock: This event is generated when safety interlock is engaged or disengaged
EFDB_Topic: | Rotator_logevent_interlock |
detail
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: detail
target
Description: Commanded target position, velocity and time.
EFDB_Topic: | Rotator_logevent_target |
position
IDL_Type: | double |
Units: | deg |
Description: Target position at the time specified by “tai”.
velocity
IDL_Type: | double |
Units: | deg/second |
Description: Target velocity at the time specified by “tai”.
tai
IDL_Type: | double |
Units: | second |
Description: TAI time of the “position” and “velocity” fields.
tracking
Description: Specify whether the rotator is tracking.
EFDB_Topic: | Rotator_logevent_tracking |
tracking
IDL_Type: | boolean |
Units: | unitless |
Description: Is the rotator tracking? True whenever 3 consecutive 50 ms track commands have been applied.
lost
IDL_Type: | boolean |
Units: | unitless |
Description: Did tracking fail? True if system tracks into a limit or we do not receive a new track command within 150ms (three iterations) following the last track command.
appliedSettingsMatchStart
EFDB_Topic: | SALGeneric_logevent_appliedSettingsMatchStart |
appliedSettingsMatchStartIsTrue
IDL_Type: | boolean |
Units: | unitless |
Description: True when the configuration matches the start conditions
authList
EFDB_Topic: | SALGeneric_logevent_authList |
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 |
errorCode
IDL_Type: | long |
Units: | unitless |
Description: A numeric error code
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 |
heartbeat
IDL_Type: | boolean |
Units: | unitless |
Description: Beats the drum.
logLevel
Description: Current logging level.
EFDB_Topic: | SALGeneric_logevent_logLevel |
level
IDL_Type: | int |
Units: | unitless |
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
logMessage
Description: A log message.
EFDB_Topic: | SALGeneric_logevent_logMessage |
name
IDL_Type: | string |
Units: | unitless |
Description: Log name.
level
IDL_Type: | int |
Units: | unitless |
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
message
IDL_Type: | string |
Units: | unitless |
Description: Log message.
traceback
IDL_Type: | string |
Units: | unitless |
Description: Exception traceback; “” if not an exception.
filePath
IDL_Type: | string |
Units: | unitless |
Description: Path to source file.
functionName
IDL_Type: | string |
Units: | unitless |
Description: Function or method name.
lineNumber
IDL_Type: | long |
Units: | unitless |
Description: Line number in the file specified by filePath.
process
IDL_Type: | long |
Units: | unitless |
Description: Process ID.
settingVersions
Description: Information about settings which can be specified in the start command.
EFDB_Topic: | SALGeneric_logevent_settingVersions |
recommendedSettingsVersion
IDL_Type: | string |
Units: | unitless |
Description: List of comma seperated recomended versions of settings sets
recommendedSettingsLabels
IDL_Type: | string |
Units: | unitless |
Description: List of comma seperated names of settings sets
settingsUrl
IDL_Type: | string |
Units: | unitless |
Description: The URL where the settings sets definitions can be found
settingsApplied
Description: Base settings applied.
EFDB_Topic: | SALGeneric_logevent_settingsApplied |
settingsVersion
IDL_Type: | string |
IDL_Size: | 256 |
Units: | unitless |
Description: The SHA or name corresponding to the published configuration
otherSettingsEvents
IDL_Type: | string |
Units: | unitless |
Description: A comma delimited list of other specific CSC configuration events. This may be blank if no other CSC specific events are necessary
simulationMode
Description: Current simulation mode.
EFDB_Topic: | SALGeneric_logevent_simulationMode |
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 |
salVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the current version of SAL generation
xmlVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the current version of CSC XML
openSpliceVersion
IDL_Type: | string |
IDL_Size: | 16 |
Units: | unitless |
Description: This is the current version of OpenSplice
cscVersion
IDL_Type: | string |
IDL_Size: | 16 |
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
summaryState
Description: Current summary state of the CSC
EFDB_Topic: | SALGeneric_logevent_summaryState |
summaryState
IDL_Type: | long |
Units: | unitless |
Description: High level state machine state identifier