SimTX API/Packets/WeatherMapRequest: Difference between revisions

Latest revision as of 17:19, 24 October 2026

API overviewQuick startHandshakeFramingAll messagesData typesStationsAccount serviceLimits and errorsv24 reference

WeatherMapRequest
Frame	`ClientFrame`, field 33
Member	`weather_map`
Direction	Client → server
Session	Control
Roles	`ROLE_CONTROL`.
Permission	None
Answered by	WeatherMapResponse
Answers
Defined in	`control.proto`

WeatherMapRequest asks for a raster of the simulated tropospheric weather over an area. Tropospheric conditions, especially ducting, rain and cloud, affect VHF, UHF and microwave propagation.

Definition[edit | edit source]

message WeatherMapRequest {
  int64 request_id = 1;
  double center_latitude_deg = 2;
  double center_longitude_deg = 3;
  double latitude_span_deg = 4;
  double longitude_span_deg = 5;
  int32 width = 6;
  int32 height = 7;
  string type = 8;             // weather type (string enum, common.proto)
}

Fields[edit | edit source]

#	Field	Type	Description
1	`request_id`	`int64`	Nonzero; echoed in the WeatherMapResponse.
2	`center_latitude_deg`	`double`	Centre latitude, −90 to 90.
3	`center_longitude_deg`	`double`	Centre longitude, −180 to 180.
4	`latitude_span_deg`	`double`	Height of the area in degrees, greater than 0 and at most 180.
5	`longitude_span_deg`	`double`	Width of the area in degrees, greater than 0 and at most 360.
6	`width`	`int32`	Raster columns, 2 to 128.
7	`height`	`int32`	Raster rows, 2 to 64.
8	`type`	`string`	Weather type to map.

Map types[edit | edit source]

`type`	Quantity	Unit
`DUCT_STRENGTH`	Strength of the strongest tropospheric duct (drop in modified refractivity); 0 where there is none	M-units
`RAIN_RATE`	Rain rate	mm/h
`CLOUD_WATER`	Cloud liquid water content	g/m³
`SURFACE_TEMPERATURE`	Air temperature at the surface	°C
`LIGHTNING_RATE`	Lightning flash rate	flashes/min

Behaviour[edit | edit source]

Heavy request. Values outside the ranges in the field table are refused with Error INVALID_REQUEST.

See also[edit | edit source]

WeatherMapResponse

SimTX API reference (protocol v25)
Start	OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service	OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol	Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations	StationsSatellitesTracking and pointing
Connection	ClientHelloPingServerHelloPongErrorBanner
Session	AntennaPointingUpdateSessionStatus
Receiver	ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter	TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control	ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog	CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation	KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive	Protocol v24 reference

@@ Line 1: / Line 1: @@
-#REDIRECT [[SimTX API v24/Packets/WeatherMapRequest]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = WeatherMapRequest
+| frame = ClientFrame
+| field = 33
+| member = weather_map
+| direction = c2s
+| session = [[SimTX API/Control session|Control]]
+| roles = <code>ROLE_CONTROL</code>.
+| permission = None
+| reply = [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]]
+| group = control
+| file = control.proto
+}}
+'''WeatherMapRequest''' asks for a raster of the simulated tropospheric weather over an area. Tropospheric conditions, especially ducting, rain and cloud, affect VHF, UHF and microwave propagation.
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message WeatherMapRequest {
+  int64 request_id = 1;
+  double center_latitude_deg = 2;
+  double center_longitude_deg = 3;
+  double latitude_span_deg = 4;
+  double longitude_span_deg = 5;
+  int32 width = 6;
+  int32 height = 7;
+  string type = 8;             // weather type (string enum, common.proto)
+}
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]].
+|-
+| 2 || <code>center_latitude_deg</code> || <code>double</code> || Centre latitude, −90 to 90.
+|-
+| 3 || <code>center_longitude_deg</code> || <code>double</code> || Centre longitude, −180 to 180.
+|-
+| 4 || <code>latitude_span_deg</code> || <code>double</code> || Height of the area in degrees, greater than 0 and at most 180.
+|-
+| 5 || <code>longitude_span_deg</code> || <code>double</code> || Width of the area in degrees, greater than 0 and at most 360.
+|-
+| 6 || <code>width</code> || <code>int32</code> || Raster columns, 2 to 128.
+|-
+| 7 || <code>height</code> || <code>int32</code> || Raster rows, 2 to 64.
+|-
+| 8 || <code>type</code> || <code>string</code> || [[SimTX API/Data types#Weather type|Weather type]] to map.
+|}
+== Map types ==
+{| class="wikitable"
+! <code>type</code> !! Quantity !! Unit
+|-
+| <code>DUCT_STRENGTH</code> || Strength of the strongest tropospheric duct (drop in modified refractivity); 0 where there is none || M-units
+|-
+| <code>RAIN_RATE</code> || Rain rate || mm/h
+|-
+| <code>CLOUD_WATER</code> || Cloud liquid water content || g/m³
+|-
+| <code>SURFACE_TEMPERATURE</code> || Air temperature at the surface || °C
+|-
+| <code>LIGHTNING_RATE</code> || Lightning flash rate || flashes/min
+|}
+== Behaviour ==
+Heavy request. Values outside the ranges in the field table are refused with [[SimTX API/Packets/Error|Error]] <code>INVALID_REQUEST</code>.
+== See also ==
+* [[SimTX API/Packets/WeatherMapResponse|WeatherMapResponse]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]