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/Station endpoints
(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!
== The Station object == <syntaxhighlight lang="json"> { "stationId": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "ownerAccountId": "0f8e2c4a-1b3d-4e5f-8a9b-0c1d2e3f4a5b", "ownerHandle": "n0call", "kind": "GROUND", "state": "ACTIVE", "name": "Home", "callsign": "N0CALL", "visibility": "UNLISTED", "revision": 3, "limits": { "maxSessions": 16, "maxTransmitters": 4, "maxReceivers": 16 }, "location": { "latitudeDeg": 47.4979, "longitudeDeg": 19.0402, "altitudeMeters": 120.0 }, "antennas": [ { "antennaId": "9b2c1e47-2f0a-4c55-8d1e-6a7b8c9d0e1f", "name": "40 m dipole", "ordinal": 0, "revision": 1, "type": "DIPOLE", "heightMeters": 10.0, "azimuthDeg": 90.0, "feedlineLossDb": 1.0, "wireLengthMeters": 0.0, "mount": "FIXED" } ], "rigs": [ { "rigId": "c41d7a52-0e3b-4f6a-9c8d-1b2a3c4d5e6f", "name": "100 W transceiver", "revision": 1, "paMaxWatts": 100.0, "noiseFigureDb": 6.0, "tx": { "carrierLeakDb": 55.0, "oppositeSidebandSuppressionDb": 50.0 } } ], "createdAt": "2026-10-24T12:00:00Z", "updatedAt": "2026-10-24T12:30:00Z" } </syntaxhighlight> {| class="wikitable" ! Field !! Type !! Description |- | <code>stationId</code> || string (UUID) || Never changes. |- | <code>ownerAccountId</code>, <code>ownerHandle</code> || string || The owning account. |- | <code>kind</code> || string || <code>GROUND</code> or <code>SATELLITE</code>. |- | <code>state</code> || string || <code>ACTIVE</code>, <code>DEORBITING</code> or <code>DEORBITED</code>. Ground stations are always <code>ACTIVE</code>. |- | <code>name</code>, <code>callsign</code> || string || 1 to 64 characters each. |- | <code>visibility</code> || string || <code>PUBLIC</code> or <code>UNLISTED</code>. See [[SimTX API/Stations#Visibility|Visibility]]. |- | <code>revision</code> || integer || Increases with every edit of the station. |- | <code>limits</code> || object || <code>maxSessions</code>, <code>maxTransmitters</code>, <code>maxReceivers</code>, each 0 to 10,000, clamped to the owner's <code>game.station_sessions.N</code>. |- | <code>location</code> || object || Ground stations: <code>latitudeDeg</code> (β90 to 90), <code>longitudeDeg</code> (β180 to 180), <code>altitudeMeters</code> (β500 to 10,000). |- | <code>orbit</code>, <code>attitude</code> || object || Satellites. See [[#Orbit and attitude|Orbit and attitude]]. |- | <code>deorbit</code> || object || Satellites whose deorbit burn has fired. See [[#Deorbiting|Deorbiting]]. |- | <code>antennas</code> || array || 1 to 8 antennas (satellites: 1 to 4). See [[#Antennas and rigs|Antennas and rigs]]. |- | <code>rigs</code> || array || 0 to 8 rigs. |- | <code>createdAt</code>, <code>updatedAt</code>, <code>launchedAt</code>, <code>deorbitedAt</code> || string || Timestamps; <code>launchedAt</code> and <code>deorbitedAt</code> for satellites. |} === Antennas and rigs === An '''antenna''' has <code>antennaId</code>, <code>name</code> (at most 64 characters), <code>ordinal</code> (its position; the first antenna is the default for tickets), <code>revision</code>, and the fields of the game protocol's [[SimTX API/Data types#AntennaConfig|AntennaConfig]] in camelCase: {| class="wikitable" ! Field !! Description |- | <code>type</code> || An [[SimTX API/Data types#Antenna types|antenna type]] name. |- | <code>heightMeters</code> || β₯ 0. Default 10 for ground stations, 0 for satellites. |- | <code>azimuthDeg</code> || β360 to 360. |- | <code>feedlineLossDb</code> || β₯ 0. Default 1 for ground stations, 0 for satellites. |- | <code>wireLengthMeters</code> || β₯ 0. 0 sizes the template for the operating frequency. |- | <code>necDeck</code> || Optional NEC-2 deck, at most 262,144 bytes; replaces the template. Satellite decks must not contain a <code>GN</code> card. Responses add <code>necDeckSha256</code>, the hex SHA-256 of the deck. Station lists carry only <code>necDeckSha256</code>; read the station for the deck text. A removed antenna, a deleted station and a reentered satellite keep no deck. |- | <code>mount</code> || <code>FIXED</code> (default), <code>AZ</code> or <code>AZEL</code>. |- | <code>pointing</code> || Steerable mounts only: <code>mode</code> (<code>FIXED</code> or <code>TRACK</code>), <code>azimuthDeg</code> (β360 to 360), <code>elevationDeg</code> (β90 to 90), <code>targetStationId</code> (required for <code>TRACK</code>), <code>azimuthRateDegPerSec</code> and <code>elevationRateDegPerSec</code> (0 to 360; 0 = default). A <code>FIXED</code> mount stores no pointing. See [[SimTX API/Tracking and pointing]]. |} A '''rig''' is a saved radio profile: <code>rigId</code>, <code>name</code>, <code>revision</code>, <code>paMaxWatts</code> (0 to 10,000,000; default 100), <code>noiseFigureDb</code> (0 to 100; default 6), and <code>tx</code>, an object with the fifteen [[SimTX API/Data types#TxImperfections|transmitter imperfection]] values in camelCase (<code>finalDriveDb</code>, <code>paHeadroomDb</code>, <code>audioCompressionDb</code>, <code>paSoftness</code>, <code>paAmPmDeg</code>, <code>carrierLeakDb</code>, <code>oppositeSidebandSuppressionDb</code>, <code>frequencyOffsetHz</code>, <code>mainsHumDb</code>, <code>mainsHumHz</code>, <code>amModulationIndex</code>, <code>paSupplySagDb</code>, <code>txNoiseFloorDb</code>, <code>oscillatorPhaseNoiseDb</code>, <code>cwKeyRiseMs</code>). Values left out take the generic HF preset. Each value must lie in the range the game accepts (see [[SimTX API/Data types#TxImperfections|TxImperfections]]); other values are refused with <code>400 station_invalid</code>. === Orbit and attitude === <code>orbit</code> holds the mean elements of the [[SimTX API/Satellites#Orbit model|simtx-j2-v1]] model: <code>model</code> (<code>simtx-j2-v1</code>), <code>epoch</code> (read-only), <code>semiMajorAxisKm</code>, <code>eccentricity</code>, <code>inclinationDeg</code>, <code>raanDeg</code>, <code>argumentOfPerigeeDeg</code>, <code>meanAnomalyDeg</code>. <code>attitude</code> has a <code>mode</code> of <code>NADIR</code>, <code>INERTIAL</code> or <code>SPIN</code> and the fields of that mode: <code>yawDeg</code>; <code>rightAscensionDeg</code>, <code>declinationDeg</code> (β90 to 90), <code>rollDeg</code>; or <code>spinAxis</code> (<code>NADIR</code>, <code>ORBIT_NORMAL</code>, <code>VELOCITY</code>), <code>spinRateRpm</code> (0 to 60), <code>spinPhaseDeg</code>. See [[SimTX API/Satellites#Attitude|Attitude]].
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)