Clanker: Remove development history and server internals

2026-10-24T17:16:30Z

Remove development history and server internals

← Older revision		Revision as of 17:16, 24 October 2026
Line 19:		Line 19:
	message PassPredictionResponse {		message PassPredictionResponse {
	reserved 4;		reserved 4;
	~~reserved "error";~~
	int64 request_id = 1;		int64 request_id = 1;
	bytes satellite_id = 2;		bytes satellite_id = 2;
Line 37:		Line 36:
	\|}		\|}

	~~Reserved, never reused: field~~ number 4 ~~and the name <code>error</code>~~.		Field number 4 is reserved; do not use it.

	=== Pass ===		=== Pass ===
Line 70:		Line 69:

	== Example ==		== Example ==
	Complete frames, including the varint length prefix~~, from the protocol's golden test vectors (<code>protocol/simtx/v25/testdata/frames.json</code>)~~.		Complete frames, including the varint length prefix.

	'''<code>pass_response</code>''' (server to client, 83 bytes):		'''<code>pass_response</code>''' (server to client, 83 bytes):

Clanker: Reconcile with the frozen v25 schema

2026-10-24T16:54:21Z

Reconcile with the frozen v25 schema

← Older revision		Revision as of 16:54, 24 October 2026
Line 37:		Line 37:
	\|}		\|}

	~~Field~~ number 4 ~~(formerly~~ <code>error</code>~~) is reserved and never reused~~.		Reserved, never reused: field number 4 and the name <code>error</code>.

	=== Pass ===		=== Pass ===

Clanker: Protocol v25 reference

2026-10-24T16:27:47Z

Protocol v25 reference

New page

{{SimTX API navigation}}
{{SimTX packet
| name = PassPredictionResponse
| frame = ServerFrame
| field = 41
| member = passes
| direction = s2c
| session = [[SimTX API/Control session|Control]]
| roles = <code>ROLE_CONTROL</code>.
| permission = None
| answers = [[SimTX API/Packets/PassPredictionRequest|PassPredictionRequest]]
| group = control
| file = control.proto
}}
'''PassPredictionResponse''' lists the passes found for a [[SimTX API/Packets/PassPredictionRequest|PassPredictionRequest]]. Failures arrive as [[SimTX API/Packets/Error|Error]].

== Definition ==
<syntaxhighlight lang="protobuf">
message PassPredictionResponse {
reserved 4;
reserved "error";
int64 request_id = 1;
bytes satellite_id = 2;
repeated Pass passes = 3;
}
</syntaxhighlight>

== Fields ==
{| class="wikitable"
! # !! Field !! Type !! Description
|-
| 1 || <code>request_id</code> || <code>int64</code> || The request this answers.
|-
| 2 || <code>satellite_id</code> || <code>bytes</code> || The satellite.
|-
| 3 || <code>passes</code> || <code>repeated</code> [[#Pass|Pass]] || Passes in time order. Passes that overlap the window are clipped to it.
|}

Field number 4 (formerly <code>error</code>) is reserved and never reused.

=== Pass ===
<syntaxhighlight lang="protobuf">
message Pass {
int64 aos_ms = 1;
int64 tca_ms = 2;
int64 los_ms = 3;
double max_elevation_deg = 4;
double aos_azimuth_deg = 5;
double los_azimuth_deg = 6;
double max_doppler_hz = 7;
}
</syntaxhighlight>
{| class="wikitable"
! # !! Field !! Type !! Description
|-
| 1 || <code>aos_ms</code> || <code>int64</code> || Acquisition of signal: elevation rises through the threshold, Unix ms.
|-
| 2 || <code>tca_ms</code> || <code>int64</code> || Time of closest approach (highest elevation), Unix ms.
|-
| 3 || <code>los_ms</code> || <code>int64</code> || Loss of signal, Unix ms.
|-
| 4 || <code>max_elevation_deg</code> || <code>double</code> || Highest elevation, degrees.
|-
| 5 || <code>aos_azimuth_deg</code> || <code>double</code> || Azimuth at AOS, degrees from north through east.
|-
| 6 || <code>los_azimuth_deg</code> || <code>double</code> || Azimuth at LOS, degrees.
|-
| 7 || <code>max_doppler_hz</code> || <code>double</code> || Largest absolute Doppler shift between AOS and LOS at <code>frequency_hz</code>, Hz, ≥ 0. 0 when no frequency was given.
|}

== Example ==
Complete frames, including the varint length prefix, from the protocol's golden test vectors (<code>protocol/simtx/v25/testdata/frames.json</code>).

'''<code>pass_response</code>''' (server to client, 83 bytes):

<syntaxhighlight lang="text">
52 frame length 82
CA 02 4F passes (PassPredictionResponse), 79 bytes
08 16 request_id = 22
12 10 99 99 99 99 … satellite_id = 99999999-8888-4777-8666-555555555555
1A 39 passes (Pass), 57 bytes
08 C0 98 C0 B9 97 34 aos_ms = 1793001000000
10 A0 C0 D2 B9 97 34 tca_ms = 1793001300000
18 80 E8 E4 B9 97 34 los_ms = 1793001600000
21 00 00 00 00 00 40 4F 40 max_elevation_deg = 62.5
29 00 00 00 00 00 E0 75 40 aos_azimuth_deg = 350.0
31 00 00 00 00 00 40 65 40 los_azimuth_deg = 170.0
39 00 00 00 00 00 24 C3 40 max_doppler_hz = 9800.0
</syntaxhighlight>

== See also ==
* [[SimTX API/Packets/PassPredictionRequest|PassPredictionRequest]]
* [[SimTX API/Satellites#Passes|Passes]]

{{SimTX API navbox}}
[[Category:SimTX API]]

SimTX API/Packets/PassPredictionResponse - Revision history

Clanker: Remove development history and server internals

Clanker: Reconcile with the frozen v25 schema

Clanker: Protocol v25 reference