Jump to content
Main menu
Main menu
move to sidebar
hide
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
SimTX Wiki
Search
Search
Appearance
Create account
Log in
Personal tools
Create account
Log in
Pages for logged out editors
learn more
Contributions
Talk
Editing
SimTX API/Control session
(section)
Page
Discussion
English
Read
Edit
Edit source
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
Edit source
View history
General
What links here
Related changes
Special pages
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Requests == Every request carries a nonzero <code>request_id</code> chosen by the client. The response echoes it. A request that fails is answered with [[SimTX API/Packets/Error|Error]] carrying the same <code>request_id</code> instead of its response; responses describe success only. {| class="wikitable" ! Request (C2S) !! Response (S2C) !! Heavy !! Purpose |- | [[SimTX API/Packets/ListStations|ListStations]] (30) || [[SimTX API/Packets/StationList|StationList]] (30) || Yes || Stations, satellites and live sessions on the server. |- | [[SimTX API/Packets/ServerHealthRequest|ServerHealthRequest]] (34) || [[SimTX API/Packets/ServerHealthReport|ServerHealthReport]] (34) || Yes || Load and session statistics. |- | [[SimTX API/Packets/CoverageMapRequest|CoverageMapRequest]] (35) || [[SimTX API/Packets/CoverageMapResponse|CoverageMapResponse]] (35) || Yes || Predicted received power for a hypothetical transmitter. |- | [[SimTX API/Packets/WeatherMapRequest|WeatherMapRequest]] (33) || [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]] (33) || Yes || Tropospheric weather raster. |- | [[SimTX API/Packets/EphemerisRequest|EphemerisRequest]] (40) || [[SimTX API/Packets/EphemerisResponse|EphemerisResponse]] (40) || Yes || Positions of a satellite over a time window. |- | [[SimTX API/Packets/PassPredictionRequest|PassPredictionRequest]] (41) || [[SimTX API/Packets/PassPredictionResponse|PassPredictionResponse]] (41) || Yes || Passes of a satellite over an observer. |- | [[SimTX API/Packets/StartMonitor|StartMonitor]] (31) || [[SimTX API/Packets/MonitorAck|MonitorAck]] (42), then [[SimTX API/Packets/MonitorBlock|MonitorBlock]] (31) ... [[SimTX API/Packets/MonitorEnd|MonitorEnd]] (32) || No || Stream of one's own transmitted signal. |- | [[SimTX API/Packets/StopMonitor|StopMonitor]] (32) || [[SimTX API/Packets/MonitorAck|MonitorAck]] (42) || No || Ends a monitor stream. |- | [[SimTX API/Packets/CatalogListRequest|CatalogListRequest]] (36) || [[SimTX API/Packets/CatalogList|CatalogList]] (36) || Yes || Catalog index. |- | [[SimTX API/Packets/CatalogFetch|CatalogFetch]] (37) || [[SimTX API/Packets/CatalogEntry|CatalogEntry]] (37) || Yes || One catalog entry with its files. |- | [[SimTX API/Packets/CatalogUpload|CatalogUpload]] (38) || [[SimTX API/Packets/CatalogUploadResult|CatalogUploadResult]] (38) || Yes || Publish an entry. |- | [[SimTX API/Packets/CatalogDelete|CatalogDelete]] (39) || [[SimTX API/Packets/CatalogDeleteResult|CatalogDeleteResult]] (39) || Yes || Remove an entry. |} The numbers are the frame member numbers. [[SimTX API/Packets/Ping|Ping]] is also accepted. Any other frame is answered with [[SimTX API/Packets/Error|Error]] <code>INVALID_REQUEST</code> and the connection closes. Unsolicited server frames: * [[SimTX API/Packets/Banner|Banner]] (4), when the session starts if a notice is active, and at any later time when a notice is set, changed or cleared. * [[SimTX API/Packets/MonitorBlock|MonitorBlock]] and [[SimTX API/Packets/MonitorEnd|MonitorEnd]] while a monitor runs.
Summary:
Please note that all contributions to SimTX Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
SimTX Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)