Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Clarifying notes in the settings.toml
  • Loading branch information
mrmay-dev committed Sep 10, 2023
1 parent 1e9a7c7 commit 839222b
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,18 @@ mqtt_pass = "password" # Broker password
# create users at https://console.hivemq.com

[owntracks_options]
owntracks_device = "owntracks/user" # Topic Base of your phone, used for waypoints
# The script publishes waypoints to a user's topic, which makes the tags act like they are owned
# by the user. It is possible to publish tags to other topics. Read the OwnTracks booklet
# for more: https://owntracks.org/booklet/guide/topics/
owntracks_device = "owntracks/iphone" # Topic Base of your phone, used for publishing waypoints.
owntags_base = nan # topic Base for tags. If `nan` owntracks_devce will be used.


# Each tag has its own options. When published to OwnTracks they can behave as `locations` or as `waypoints`.
# Learn about locations here: https://owntracks.org/booklet/features/location/
# Learn about waypoints here: https://owntracks.org/booklet/guide/waypoints/
# OwnTracks identifies `waypoints` by their creation timestamp. Here, you assign the timestamp manually to
# ensure it is unique.
[tag_options.prefix]
location = true # (not required) locations are seen by everyone with access to the topic (they act like users)
waypoint = false # (not required) waypoints are only seen on your phone (or device)
Expand Down

0 comments on commit 839222b

Please sign in to comment.