Jump to content

SimTX API v24/Packets/CoverageMapResponse

From SimTX Wiki
This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
CoverageMapResponse
Packet ID 27(0x1B)
Direction Server → client
Session Control
Body size Variable
Permission None
Answered by
Answers CoverageMapRequest

CoverageMapResponse returns the predicted received power of a CoverageMapRequest as a global raster, or explains why no prediction is available.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 27.
requestId i64 The request this answers.
available bool False if no prediction was made. The raster is then empty.
message UTF On success: Server propagation prediction. Otherwise the reason.
simTimeEpochMillis i64 Simulated time the prediction is for, Unix milliseconds. 0 when unavailable.
width i32 Raster columns.
height i32 Raster rows.
valueCount i32 Number of values: width × height, or 0 when unavailable.
receivedPowerDbm valueCount × f32 Predicted received power in dBm, row by row.

Raster layout[edit | edit source]

The raster covers the whole globe. Values are stored row-major (index = row × width + column). Row 0 is the northernmost; columns run west to east starting at 180° W. Each value is taken at the centre of its cell:

latitude  =   90 − (row    + 0.5) × 180 / height
longitude = −180 + (column + 0.5) × 360 / width

Each value is the power that a standard receiving antenna (an end-fed half-wave wire at ground level) would see from the requested transmitter, at the simulation's current time, ionospheric state included. Points with no usable path are reported as −200 dBm. Every value is finite.

Unavailable responses[edit | edit source]

Message Meaning
Server propagation heatmaps are disabled The server does not offer coverage prediction.
Coverage prediction server is busy Another prediction is running and one is waiting. Try again in a few seconds.
Coverage prediction failed; try again The computation failed.
SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference