package stellarstation.api.v1.radio

Get desktop application:
View/edit binary Protocol Buffers messages

ASM+Golay mode for GOM Space AX100 radio. https://gomspace.com/UserFiles/Subsystems/datasheet/gs-ds-nanocom-ax100-33.pdf

Used in: CommunicationProtocol

• optional SynchronizationParams synchronization_params = 1

  Synchronization word parameters. If unset, the default synchronization word defined by the AX100 will be used.

• bool enable_ccsds_scramble = 2

  Whether to enable CCSDS scrambling.

• bool enable_reed_solomon = 3

  Whether to enable Reed Solomon error correction.

• bool enable_crc_check = 4

  Whether to enable CRC checking.

PACKET communication based on AX.25. https://www.sigidwiki.com/wiki/PACKET.

Used in: CommunicationProtocol

• bool g3ruh = 1

  Whether or not G3RUH scrambling is used.

• string destination_callsign = 2

  Destination callsign.

• uint32 destination_ssid = 3

  Destination SSID.

• string source_callsign = 4

  Source callsign.

• uint32 source_ssid = 5

  Source SSID.

Framing for satellites that don't conform to a particular standard. Usually, only a synchronization word and expected frame length can be set.

Used in: CommunicationProtocol

• optional SynchronizationParams synchronization_params = 1

  Synchronization word parameters. If unset, synchronization is disabled.

• uint32 frame_length_bytes = 2

  Frame length, in bytes.

• LineCoding line_coding = 3

  Line coding used.

CCSDS-specific convolutional coding parameters. Code rate (r): 1/2 Constraint length (K): 7 Connection vectors: G1 = 1111001 G2 = 1011011

Used in: CCSDSTransferFrame

• CCSDSConvolutionalCodingParams.PolynomialInversion polynomial_inversion = 1

• CCSDSConvolutionalCodingParams.Puncturing puncturing = 2

  Optional puncturing for convolutional code.

Polynomial inversion.

Used in: CCSDSConvolutionalCodingParams

• G1_G2 = 0

  CCSDS transfer frame with normal phase rotation.

• G1_G2_INVERTED = 1

  CCSDS transfer frame with inverted phase rotation.

• G2_INVERTED_G1 = 2

  G2-inverted G1.

• G2_G1 = 3

  G2-G1.

Enum describing different rates for puncturing.

Used in: CCSDSConvolutionalCodingParams

• OFF = 0

  No puncturing.

• PUNCTURE_2_3 = 1

  Puncturing rate 2/3.

• PUNCTURE_3_4 = 2

  Puncturing rate 3/4.

• PUNCTURE_4_5 = 3

  Puncturing rate 4/5.

• PUNCTURE_5_6 = 4

  Puncturing rate 5/6.

• PUNCTURE_6_7 = 5

  Puncturing rate 6/7.

• PUNCTURE_7_8 = 6

  Puncturing rate 7/8.

CCSDS-specific Reed-Solomon parameters.

Used in: CCSDSTransferFrame

• CCSDSReedSolomonParams.BlockLengthType block_length_type = 1

  Block length type for RS code.

Enum defining RS Code block length.

Used in: CCSDSReedSolomonParams

• RS_223_255 = 0

  (255, 223, 16) RS code.

• RS_239_255 = 1

  (255, 239, 8) RS code.

CCSDS-specific scrambling parameters. Additive scrambler with pseudo-random sequence generated by the polynomial: h(x) = x^8 + x^7 + x^5 + x^3 + 1

Used in: CCSDSTransferFrame

(message has no fields)

https://public.ccsds.org/Pubs/131x0b3e1.pdf CCSDS transfer frames allow for a few common variations satellites use such as setting a custom synchronization word, inverting the convolutional coding polynomials, etc. The sequence of error-correcting codes will be applied as they are defined in the CCSDS standard.

Used in: CommunicationProtocol

• optional SynchronizationParams synchronization_params = 1

  Synchronization word parameters. If unset, synchronization will be enabled using the default CCSDS transfer frame standard synchronization word as in 9.3.5 (Page 9-3) in the specification.

• optional CCSDSConvolutionalCodingParams convolutional_coding_params = 2

  Convolutional coding parameters. If unset, convolutional coding is disabled.

• optional CCSDSScramblingParams scrambling_params = 3

  Scrambling parameters. If unset, scrambling is disabled.

• optional CCSDSReedSolomonParams reed_solomon_params = 4

  Reed-Solomon parameters. If unset, Reed-Solomon is disabled.

• uint32 frame_length_bytes = 5

  Frame length, in bytes.

• LineCoding line_coding = 6

  Line coding used.

A communication protocol used with a radio device. These must contain all the parameters needed to configure the device for use either in transmission or reception.

Used in: RadioDeviceConfiguration

• oneof Framing

  • AX25 ax25 = 1

    AX.25 protocol settings.

  • CCSDSTransferFrame ccsds = 2

    CCSDS transfer frame settings.

  • Bitstream bitstream = 3

    Bitstream framing settings.

  • ASMGolay asm_golay = 4

    AX 100 ASM + Golay mode.

Parameters for convolutional coding applied to a bitstream. https://en.wikipedia.org/wiki/Convolutional_code

• uint32 k = 1

  The constraint length, `k`, of the code.

• uint32 inverse_rate = 2

  The inverse of the rate of coding, e.g., if rate is `1 / r`, `inverse_rate` is `r`.

• repeated bytes polynomial = 3

  The polynomials used for coding. Must have `r` number of elements, where the most significant `k` bits of each element will be used as the polynomial for that index.

Line coding applied during modulation. Line coding is the technique for modeling binary 0 and 1 within a modulated waveform.

Used in: monitoring.ReceiverConfiguration, monitoring.TransmitterConfiguration, Bitstream, CCSDSTransferFrame

• NRZ_L = 0

  Non-return-to-zero level. https://en.wikipedia.org/wiki/Non-return-to-zero

• NRZ_M = 1

  Non-return-to-zero mark (i.e., differential encoding). https://en.wikipedia.org/wiki/Non-return-to-zero

• NRZ_S = 2

  Non-return-to-zero space (i.e., non-differential-encoding). https://en.wikipedia.org/wiki/Non-return-to-zero

• DNRZ = 3

  Differential non-return-to-zero. https://en.wikipedia.org/wiki/Return-to-zero

• BP_L = 4

  Bipolar return-to-zero level. https://en.wikipedia.org/wiki/Bipolar_encoding

• BP_M = 5

  Bipolar return-to-zero mark (i.e., differential encoding). https://en.wikipedia.org/wiki/Bipolar_encoding

• BP_S = 6

  Bipolar return-to-zero space (i.e., non-differential encoding). https://en.wikipedia.org/wiki/Bipolar_encoding

Type of modulation. Modulation is the process of converting binary data (0's and 1's) to an analog wave for use in radio communication. Next ID: 27.

Used in: ReceiverConfigurationRequest, TransmitterConfigurationRequest, monitoring.ReceiverConfiguration, monitoring.TransmitterConfiguration, RadioDeviceConfiguration

• DISABLED = 0

  Indicates modulation is disabled and raw I/Q is being used.

• FSK = 1

  Frequency Shift Keying. https://en.wikipedia.org/wiki/Frequency-shift_keying

• AFSK = 2

  Audio Frequency Shift Keying. https://en.wikipedia.org/wiki/Frequency-shift_keying#Audio_FSK

• BPSK = 3

  Binary Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying#Binary_phase-shift_keying_(BPSK)

• MFSK = 4

  Multiple Frequency Shift Keying. https://en.wikipedia.org/wiki/Multiple_frequency-shift_keying

• QPSK = 5

  Quadrature Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying#Quadrature_phase-shift_keying_(QPSK)

• PSK8 = 6

  8-Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying

• PSK16 = 7

  16-Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying

• PSK32 = 8

  32-Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying

• PSK64 = 9

  64-Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying

• PSK128 = 10

  128-Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying

• PSK256 = 11

  256-Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying

• OQPSK = 12

  Offset Quadrature Phase Shift Keying. https://en.wikipedia.org/wiki/Phase-shift_keying#Offset_QPSK_(OQPSK)

• QAM8 = 13

  8-Phase Amplitude Modulation. https://en.wikipedia.org/wiki/Quadrature_amplitude_modulation

• QAM16 = 14

  16-Phase Amplitude Modulation. https://en.wikipedia.org/wiki/Quadrature_amplitude_modulation

• QAM32 = 15

  32-Phase Amplitude Modulation. https://en.wikipedia.org/wiki/Quadrature_amplitude_modulation

• QAM64 = 16

  64-Phase Amplitude Modulation. https://en.wikipedia.org/wiki/Quadrature_amplitude_modulation

• QAM128 = 17

  128-Phase Amplitude Modulation. https://en.wikipedia.org/wiki/Quadrature_amplitude_modulation

• QAM256 = 18

  256-Phase Amplitude Modulation. https://en.wikipedia.org/wiki/Quadrature_amplitude_modulation

• MSK = 19

  Minimum Shift Keying. https://en.wikipedia.org/wiki/Minimum-shift_keying

• GMSK = 20

  Gaussian Minimum Shift Keying. https://en.wikipedia.org/wiki/Minimum-shift_keying#Gaussian_minimum-shift_keying

• AM = 21

  Amplitude modulation (generic)

• FM = 22

  Frequency modulation (generic)

• PM = 23

  Phase modulation (generic)

• PCM_PSK_PM = 24

  PCM/PSK/PM as specified by CCSDS. https://public.ccsds.org/Pubs/401x0b29.pdf

• PCM_PM_BI_PHASE_L = 25

  PCM/PM/bi-phase-L as specified by CCSDS. https://public.ccsds.org/Pubs/401x0b29.pdf

• APSK16 = 26

  16-Amplitude Phase Shift Keying. https://en.wikipedia.org/wiki/Amplitude_and_phase-shift_keying

A radio device for RF communication. Usually, a satellite will have one or more radio devices for communicating with the ground and a ground station will have one or more radio devices for communicating with the satellite. Such devices may not actually correspond to actual hardware devices, i.e., in the case of Software Defined Radio (SDR).

Used in: ChannelSet, groundstation.Plan

• uint64 center_frequency_hz = 1

  The center frequency of the device, in Hz.

• Modulation modulation = 2

  The type of modulation used by this radio device.

• uint64 bitrate = 3

  The bitrate used during modulation.

• optional CommunicationProtocol protocol = 4

  The protocol used by this device when doing RF communication. If unset, the device is only demodulating / modulating without applying any higher-level communication protocol.

• antenna.AntennaPolarization polarization = 5

  The polarization of the antenna. Status: ALPHA This API is under development and may not work correctly or be changed in backwards incompatible ways in the future.

Parameters for scrambling applied to a bitstream.

• ScramblingParams.Type type = 1

  The type of scrambling.

• uint32 num_bits = 2

  The length of the shift register, in bits.

• bytes mask = 3

  The polynomial mask for the shift register. The most significant `num_bits` bits of `mask` will be used.

• bytes seed = 4

  The initial contents of the shift register. The most significant `num_bits` bits of `mask` will be used.

A type of scrambling.

Used in: ScramblingParams

• ADDITIVE = 0

  Additive scrambling.

• MULTIPLICATIVE = 1

  Multiplicative scrambling.

Parameters for frame synchronization.

Used in: ASMGolay, Bitstream, CCSDSTransferFrame

• bytes synchronization_word = 1

  The actual bytes of the synchronization word. Least significant bit aligned E.g. 15-bit sync word of 0x7fff should be represented as 0111 1111 1111 1111 or [0x7f, 0xff]

• uint32 length_bits = 2

  The length in bits of the synchronization word.