SimTX API v24/Packets/CoverageMapRequest

CoverageMapRequest

Frame	{{{frame}}}, field {{{field}}}
Member	{{{member}}}
Direction	Client → server
Session	Control
Roles
Permission	None
Answered by	CoverageMapResponse
Answers
Defined in

CoverageMapRequest asks the server to predict where a hypothetical transmitter could be heard. The server computes the received power at a grid of points covering the whole globe and returns it in a CoverageMapResponse. The official transmitter uses it for its coverage heat map.

Layout

Field	Type	Description
packetId	u8	Always 24.
requestId	i64	Chosen by the client and echoed in the response.
location	GeoPoint	Transmitter position.
antenna	AntennaConfig	Transmitting antenna. wireLengthMeters × frequencyHz / c may not exceed 40 wavelengths.
modulation	UTF	A Modulation name.
frequencyHz	f32	Greater than 0 and at most 3 GHz.
powerWatts	f32	Greater than 0 and at most 109.
bandwidthHz	f32	Greater than 0 and at most 2,400,000.
width	i32	Raster columns, 4–54.
height	i32	Raster rows, 2–27.

Behaviour

• Coverage prediction is optional and disabled by default. A server without it answers every request with available = false and the message Server propagation heatmaps are disabled.
• Predictions are expensive. The server runs one at a time and keeps at most one more waiting; further requests are answered Coverage prediction server is busy.
• A new request from the same session cancels that session's previous one. The cancelled request normally gets no response, so match responses by requestId.
• It is a heavy request for rate limiting. No permission is needed.
• Invalid values close the connection.