Waypoints#
If you've configured a geo-fence, a location
message will
contain the elements:
rad
ius (if its value is greater than 0): unit: metersdesc
ription with the name you set for the waypointevent
with a value of"enter"
or"leave"
, depending on whether the device is entering or leaving a configured region, respectively.
If you set up a waypoint, the app publishes that waypoint (without the retain flag,
irrespective of your general preference) to the base topic with /waypoint
tacked onto the topic (e.g. owntracks/<user>/<device>/waypoint
) with the
payload for _type=waypoint
as specified in the JSON page.
When you set up a waypoint (with a desc
ription and a rad
ius), this
waypoint is published to the broker with the current time stamp. If you update
the waypoint definition on the device at a later stage, the waypoint is
re-published, with the original timestamp, but with possibly new
desc
ription and/or rad
ius. To be precise, the tst
timestamp is used as an
identifier of the waypoint even if it is later modified on the device.
Subscribers to the broker (our apps and any other program) can avoid getting
waypoints by subscribing to, say, owntracks/+/+
; also broker ACLs can
prohibit access to owntracks/+/+/waypoint
for particular users if so desired.
Conversely, all messages published by the apps (location
and waypoint
) are
available with a subscription to owntracks/#
.
The OwnTracks apps may keep track of waypoints, e.g. for displaying to users.