Skip to main content
Version: 1.5.0

Data Structures

TfrsResponse

TFRS reading

Members

NameTypeDescription
ageintTime in seconds since the last reading
utc_timeintUnix epoch timestamp
ecef_pos_xintECEF X Position
ecef_pos_yintECEF Y Position
ecef_pos_zintECEF Z Position
ecef_vel_xintECEF X Velocity
ecef_vel_yintECEF Y Velocity
ecef_vel_zintECEF Z Velocity

AdcsResponse

ADCS Reading

Members

NameTypeDescription
modestringCurrent ACS mode
ageintTime in seconds since the last reading
hkAdcsHkDetailed attitude information

AdcsCommandRequest

An ADCS command to request a particular attitude.

Members

NameTypeDescription
commandstringThe command to send. Required.
aperturestringThe aperture to base the command on. Required for TRACK and NADIR commands.
targetAdcsTargetThe target to use for the command. Required for TRACK command.

AdcsCommandResponse

The response received from a ADCS command.

Members

NameTypeDescription
statusstringStatus of the request (OK or FAIL)
reasonstringReason why a request failed.
modestringUpdated current AcsMode

AdcsTarget

A target.

Members

NameTypeDescription
latnumberLatitude in degrees
lonnumberLongitude in degrees

AdcsCommandMode

A command mode to be sent to ADCS.

TypeNotes
stringSupported commands are IDLE, NADIR, and TRACK
commanddescription
IDLEDo nothing; return to the initial configuration specified on the window
NADIRpoint straight down
TRACKpoint at a specified point on the earth's surface

AcsMode

A command mode received from ADCS via feedback.

TypeNotes
stringThe expected values include NADIRPOINTYAW, LATLONTRACK, and NOOP. Other values are possible, but anything other than these indicate an ADCS control mode not relevant to payload operations.

Aperture

Aperture (imager, antenna, etc) name to use in ADCS pointing requests

TypeNotes
stringMax length = 24 characters

Refer to your ICD for valid names.

AdcsHk

Detailed ADCS reading.

Members

NameTypeDescription
control_error_angle_degnumberAbsolute control error angle
acs_mode_activestringActive ACS mode
euler_anglesAdcs_euler_tCurrent attitude in the LVLH (orbit) frame in degrees for Roll, Pitch, Yaw
control_error_qAdcs_quat_tFeedback on quaternion error
lat_degnumberSubsatellite latitude, in degrees
lon_degnumberSubsatellite longitude, in degrees
q_bo_estAdcs_quat_tEstimated spacecraft attitude quaternion in the orbit (lvlh) frame
latlontrack_latnumberLatitude used for ground target tracking
latlontrack_lonnumberLongitude used for ground target tracking
lease_activenumberFlag if a lease is currently active
eclipse_flagnumberSunlit/eclipse status of spacecraft
q_bi_estAdcs_quat_tEstimated spacecraft attitude quaternion in the inertial coordinate frame
r_eciAdcs_xyz_float_tEstimated spacecraft position in ECI frame
altitudenumberEstimated altitude of satellite in meters
latlontrack_body_vectorAdcs_xyz_float_tBody vector used to point at ground targets
omega_bo_estAdcs_xyz_float_tBody rate estimate in orbit frame
acs_mode_cmdstringCommanded ACS mode
v_eciAdcs_xyz_float_tEstimated spacecraft velocity in ECI frame
qcfAdcs_quat_tControl frame quaternion
lease_time_remainingintegerTime remaining in current ADCS lease
unix_timestampnumberUnix epoch time
omega_bi_estAdcs_xyz_float_tBody rate estimate in inertial frame
control_error_omegaAdcs_xyz_float_tFeedback on rate error
r_ecefAdcs_xyz_float_tEstimated spacecraft position in ECEF frame

Adcs_xyz_float_t

A 3-element (x, y, z) vector

Members

NameType
xnumber
ynumber
znumber

Adcs_quat_t

ADCS quaternion

Members

NameType
q1number
q2number
q3number
q4number

Adcs_euler_t

ADCS Euler angles -- roll, pitch, yaw

Members

NameType
rollnumber
pitchnumber
yawnumber