Editing SimTX API v24/Packets/CoverageMapRequest

{{SimTX API v24 navigation}}
{{SimTX packet v24
| name = CoverageMapRequest
| id = 24
| hex = 0x18
| direction = c2s
| session = [[SimTX API v24/Control session|Control]]
| size = Variable
| permission = None
| reply = [[SimTX API v24/Packets/CoverageMapResponse|CoverageMapResponse]]
| group = control
}}
'''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 [[SimTX API v24/Packets/CoverageMapResponse|CoverageMapResponse]]. The official transmitter uses it for its coverage heat map.

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>24</code>.
|-
| <code>requestId</code> || <code>i64</code> || Chosen by the client and echoed in the response.
|-
| <code>location</code> || [[SimTX API v24/Data types#GeoPoint|GeoPoint]] || Transmitter position.
|-
| <code>antenna</code> || [[SimTX API v24/Data types#AntennaConfig|AntennaConfig]] || Transmitting antenna. <code>wireLengthMeters × frequencyHz / c</code> may not exceed 40 wavelengths.
|-
| <code>modulation</code> || <code>UTF</code> || A [[SimTX API v24/Data types#Modulation|Modulation]] name.
|-
| <code>frequencyHz</code> || <code>f32</code> || Greater than 0 and at most 3 GHz.
|-
| <code>powerWatts</code> || <code>f32</code> || Greater than 0 and at most 10<sup>9</sup>.
|-
| <code>bandwidthHz</code> || <code>f32</code> || Greater than 0 and at most 2,400,000.
|-
| <code>width</code> || <code>i32</code> || Raster columns, 4–54.
|-
| <code>height</code> || <code>i32</code> || Raster rows, 2–27.
|}

== Behaviour ==
* Coverage prediction is optional and '''disabled by default'''. A server without it answers every request with <code>available = false</code> 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 <code>requestId</code>.
* It is a heavy request for [[SimTX API v24/Control session#Rate limits|rate limiting]]. No permission is needed.
* Invalid values close the connection.

{{SimTX API v24 navbox}}
[[Category:SimTX API v24]]