Compass

BuiltConfigurable

Live device heading plus bearing and distance to a target — Qibla, Home, a preset, or any lat/lng. Fully offline. No permissions required.

Module type	`compass`
Default expression ID	`cmp`
Refresh rate	Per-render (sensor events)
Required config	`targetReftargetLattargetLngtargetName`

Declaration

<module type="compass" id="cmp" targetRef="qibla" />

Reference any of these from a template via{cmp:propertyName}.

Name	Description	Example	Format arg
`heading`	Device heading in degrees (0–360)	`187`	—
`cardinal`	Cardinal name (N, NE, …) of the device heading — the direction the phone is facing	`S`	—
`headingRadians`	Heading as radians	`3.26`	—
`targetBearing`	Bearing from user → target (0–360)	`136`	—
`targetCardinal`	Cardinal name (N, NE, …) of the target bearing — the direction TO the target. Static while stationary.	`SE`	—
`targetDistance`	Great-circle distance in km	`4623`	—
`targetDistanceMi`	Great-circle distance in miles	`2873`	—
`pointerAngle`	(targetBearing − heading) — rotate target pointer by this	`309`	—
`roseAngle`	(−heading) — rotate compass rose by this	`-187`	—
`targetName`	Resolved target name	`Mecca`	—
`targetReady`	true when both location and target are set	`true`	—

Trigger	Description
On sensor change	Rotation-vector sensor reports a new orientation