SimTX API v24/Packets/CoverageMapResponse - Revision history

Clanker: Archive the v24 protocol reference: use the v24 templates, links and categories

2026-10-24T16:14:54Z

Archive the v24 protocol reference: use the v24 templates, links and categories

← Older revision		Revision as of 16:14, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API v24 navigation}}
	{{SimTX packet		{{SimTX packet v24
	\| name = CoverageMapResponse		\| name = CoverageMapResponse
	\| id = 27		\| id = 27
	\| hex = 0x1B		\| hex = 0x1B
	\| direction = s2c		\| direction = s2c
	\| session = [[SimTX API/Control session\|Control]]		\| session = [[SimTX API v24/Control session\|Control]]
	\| size = Variable		\| size = Variable
	\| permission = None		\| permission = None
	\| answers = [[SimTX API/Packets/CoverageMapRequest\|CoverageMapRequest]]		\| answers = [[SimTX API v24/Packets/CoverageMapRequest\|CoverageMapRequest]]
	\| group = control		\| group = control
	}}		}}
	'''CoverageMapResponse''' returns the predicted received power of a [[SimTX API/Packets/CoverageMapRequest\|CoverageMapRequest]] as a global raster, or explains why no prediction is available.		'''CoverageMapResponse''' returns the predicted received power of a [[SimTX API v24/Packets/CoverageMapRequest\|CoverageMapRequest]] as a global raster, or explains why no prediction is available.

	== Layout ==		== Layout ==
Line 57:		Line 57:
	\|}		\|}

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

Clanker: Clanker moved page SimTX API/Packets/CoverageMapResponse to SimTX API v24/Packets/CoverageMapResponse: Archive the v24 protocol reference

2026-10-24T16:14:50Z

Clanker moved page SimTX API/Packets/CoverageMapResponse to SimTX API v24/Packets/CoverageMapResponse: Archive the v24 protocol reference

← Older revision	Revision as of 16:14, 24 October 2026
(No difference)

Clanker: SimTX API documentation

2026-10-24T10:01:22Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = CoverageMapResponse
| id = 27
| hex = 0x1B
| direction = s2c
| session = [[SimTX API/Control session|Control]]
| size = Variable
| permission = None
| answers = [[SimTX API/Packets/CoverageMapRequest|CoverageMapRequest]]
| group = control
}}
'''CoverageMapResponse''' returns the predicted received power of a [[SimTX API/Packets/CoverageMapRequest|CoverageMapRequest]] as a global raster, or explains why no prediction is available.

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

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

<syntaxhighlight lang="text">
latitude = 90 − (row + 0.5) × 180 / height
longitude = −180 + (column + 0.5) × 360 / width
</syntaxhighlight>

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 ==
{| class="wikitable"
! 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 navbox}}
[[Category:SimTX API]]