package stellarstation.api.v1.monitoring

Get desktop application:
View/edit binary Protocol Buffers messages

The current state of the ground station's antenna during the operation of a pass. Next ID: 4

Used in: GroundStationState

• optional AntennaState.Angle azimuth = 1

  The current state of the antenna's azimuth (horizontal angle).

• optional AntennaState.Angle elevation = 2

  The current state of the antenna's elevation (vertical angle).

• antenna.AntennaPolarization polarization = 3

  The current polarization of the antenna.

The state of an antenna angle.

Used in: AntennaState

• double command = 1

  The angle that was specified for the antenna. When the antenna is functioning properly, there should be nearly no difference between this and `measured`.

• double measured = 2

  The actual angle physically measured from the antenna. When the antenna is functioning properly, there should be nearly no difference between this and `command`.

A current status of convolutional coding.

Used in: ReceiverState

• UNLOCKED = 0

  Not locked on.

• I_LOCKED = 1

  Locked onto the in-phase signal.

• Q_LOCKED = 2

  Locked onto the quadrature signal.

• LOCKED = 3

  Locked onto both in-phase and quadrature signal.

The current configuration of a ground station. This is controlled by the parameters of a pass, based on the configuration of the satellite it will communicate with. When debugging issues with a pass, it is good to first confirm that the actual reported configuration matches the expected settings. Status: ALPHA This API is under development and may not work correctly or be changed in backwards incompatible ways in the future.

Used in: PlanMonitoringEvent

• optional TransmitterConfiguration transmitter = 1

  The current configuration of the transmitter in use by the ground station. This configuration should match the parameters of the executing plan. When debugging issues with data transmission (e.g., no response from satellite), it can be useful to confirm these values match the expected configuration of the transmitter.

• optional ReceiverConfiguration receiver = 2

  The current configuration of the receiver in use by the ground station. This configuration should match the parameters of the executing plan. When debugging issues with data reception (e.g., can't decode signal), it can be useful to confirm these values match the expected configuration of the receiver.

• optional antenna.AntennaConfiguration antenna = 3

  The current configuration of the antenna used by the ground station. These are the physical parameters of an antenna and in practice should never change, even across passes. But natural events such as earthquakes can cause small changes in these values. When debugging issues with tracking a satellite (e.g., getting no signal at all), it can be useful to confirm these values match the expected configuration of the antenna.

• optional PlanConfiguration plan = 4

  The current configuration of the plan being executed by the ground station.

Events generated by a ground station during the operation of a pass. Status: ALPHA This API is under development and may not work correctly or be changed in backwards incompatible ways in the future.

Used in: PlanMonitoringEvent

• optional PlanLifecycleEvent plan = 4

  An event related to the plan being executed.

The current state of a ground station during the operation of a pass. State that can be monitored will vary by the specifications of the ground station that executes the pass. Any information that cannot be monitored for the current ground station will not be filled.

Used in: PlanMonitoringEvent

• optional TransmitterState transmitter = 1

  The current state of the transmitter in use during a pass. When debugging issues with data transmission (e.g., no response from a satellite), it can be good to verify the metrics for the transmitter are within expected or acceptable values.

• optional ReceiverState receiver = 2

  The current state of the receiver in use during a pass. When debugging issues with data reception (e.g., can't decode signal), it can be good to verify the metrics for the receiver are within expected or acceptable values.

• optional AntennaState antenna = 3

  The current state of the antenna being used for the pass. When debugging issues with tracking a satellite (e.g., getting no signal at all), it can be useful to ensure the physically measured values are within expected or acceptable values.

The configuration of the currently executing plan.

Used in: GroundStationConfiguration

• optional orbit.Tle tle = 1

  The TLE for the satellite in this plan.

An event that describes the status of the plan being executed by the ground station.

Used in: GroundStationEvent

• PlanLifecycleEvent.Status status = 1

  The status of the plan.

• oneof Details

  • PlanLifecycleEvent.FailureDetails failure = 2

    The details about the cause of a failure if status is FAILED.

If a plan fails, this message describes the cause of the failure.

Used in: PlanLifecycleEvent

• FailureDetails.Cause cause = 1

  The cause of the failure.

A description of the cause of the failure.

Used in: FailureDetails

• UNKNOWN = 0

A description of the plan status.

Used in: PlanLifecycleEvent

• UNKNOWN = 0

• PREPARING = 1

  Plan preparation has started. This status is sent when the ground station starts preparing for plan execution.

• EXECUTING = 2

  Plan execution has started. This status is sent when passing the AOS time of the plan.

• COMPLETED = 3

  Plan execution is complete. This status is sent when the ground station has finished executing the plan and uploading all data.

• FAILED = 4

  Plan execution failed. This status is sent when the plan cannot be completed for some reason.

The current configuration of a receiver. A receiver takes a waveform from a satellite and applies signal processing to produce a bitstream.

Used in: GroundStationConfiguration

• radio.Modulation modulation = 1

  The modulation type of the receiver.

• uint64 bandwidth_hz = 2

  The bandwidth, in Hz.

• uint64 sampling_frequency_hz = 3

  The sampling frequency.

• uint64 bitrate = 4

  The bitrate of the receiver.

• radio.LineCoding line_coding = 5

  The line coding of the receiver.

• optional common.Bits synchronization_word = 6

  The frame synchronization word being used. Unset if frame synchronization is disabled.

• bool is_convolutional_code_descrambling = 7

  Whether convolutional code descrambling is enabled.

• bool is_convolutional_code_decoding = 8

  Whether convolutional code decoding is enabled.

• bool is_convolutional_code_inverted = 9

  Whether convolutional codes are inverted. No meaning if `is_convolutional_code_decoding` is not enabled.

• bool is_reed_solomon_enabled = 10

  Whether reed solomon coding is being used.

• uint32 frame_size = 11

  The size of a frame, in bits.

• bool is_frame_checking_enabled = 12

  Whether frame checking is enabled.

The current state of the ground station's receiver during the operation of a pass. Next ID: 12

Used in: GroundStationState

• uint64 center_frequency_hz = 1

  The current center frequency of the receiver, taking into account e.g., Doppler correction.

• double carrier_level_dbm = 2

  The current level of the carrier signal, in dBm (decibal-milliwatts).

• bool is_phase_locked = 3

  Whether the receiver is phase-locked onto a signal.

• bool is_bit_synchronizer_locked = 4

  Whether the bit synchronizer is locked onto a signal.

• double normalized_snr = 5

  The signal-to-noise ratio per bit, e.g., Eb/N0. https://en.wikipedia.org/wiki/Eb/N0

• bool is_frame_synchronizer_locked = 6

  Whether the frame synchronizer is locked onto a signal.

• ConvolutionalCodingStatus convolutional_coding_status = 7

  The current status of convolutional coding.

• double convolutional_coding_bit_error_rate = 8

  The bit error rate of convolutional coding.

• optional ReedSolomonStatus reed_solomon_status = 9

  The status of Reed-Solomon coding.

• optional google.protobuf.FloatValue bitrate = 10

  The current bitrate of the receiver

• optional google.protobuf.FloatValue carrier_offset = 11

  Offset from the expected carrier frequency.

The status of Reed-Solomon coding. Next ID: 5

Used in: ReceiverState

• ReedSolomonStatus.Status status = 1

  Current status of Reed-Solomon coding.

• uint32 num_corrected_signals = 2

  The number of Reed-Solomon corrected signals. Only set is `status` == `OK`.

• optional google.protobuf.Int64Value num_good_frames = 3

  Number of good transfer frames.

• optional google.protobuf.Int64Value num_bad_frames = 4

  Number of bad transfer frames

Used in: ReedSolomonStatus

• OK = 0

  Indicates Reed-Solomon coding is functioning.

• INTERLEAVE_ERROR = 1

  Indicates Reed-Solomon coding encountered an interleave error.

• CORRECTION_CAPACITY_EXCEEDED = 2

  Indicates Reed-Solomon coding exceeded its correction capacity.

The current configuration of a transmitter. A transmitter takes a bitstream and applies signal processing to create the final waveform sent to a satellite.

Used in: GroundStationConfiguration

• radio.Modulation modulation = 1

  The modulation type of the transmitter.

• bool is_carrier_enabled = 2

  Whether the carrier is enabled.

• uint64 bitrate = 3

  The bitrate of the transmitter.

• radio.LineCoding line_coding = 4

  The line coding of the transmitter.

• uint64 filter_bandwidth_hz = 5

  The bandwidth of the filter.

• uint64 sampling_frequency_hz = 6

  The sampling frequency.

The current state of the ground station's transmitter during the operation of a pass. Next ID: 9

Used in: GroundStationState

• uint64 center_frequency_hz = 1

  The current center frequency of the transmitter, taking into account e.g., Doppler correction.

• double carrier_level_dbm = 2

  The current level of the carrier signal, in dBm (decibal-milliwatts).

• optional google.protobuf.BoolValue is_modulation_enabled = 3

  Whether modulation is enabled.

• optional google.protobuf.BoolValue is_carrier_enabled = 4

  Whether the carrier is enabled.

• optional google.protobuf.BoolValue is_if_sweep_enabled = 5

  Whether IF sweeping is enabled.

• optional google.protobuf.BoolValue is_idle_pattern_enabled = 6

  Whether transmitting idle pattern is enabled.

• optional google.protobuf.FloatValue bitrate = 7

  The current bitrate of the transmitter

• optional google.protobuf.FloatValue carrier_offset = 8

  Offset from the expected carrier frequency.