OwnTracks

https://owntracks.org/booklet/
Admin
OwnTracks is an open-source project that allows users to publish their device location to a...
Tokens:28,021
Snippets:390
Trust Score:8.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Configure Installation

Source: https://owntracks.org/booklet/guide/quicksetup

Prepare the configuration file by copying the example and editing it.

```bash
$ cp configuration.yaml.example configuration.yaml
$ nano configuration.yaml
```

--------------------------------

### Installation Output

Source: https://owntracks.org/booklet/guide/quicksetup

Example output showing the Ansible installation progress.

```text
    PLAY [OwnTracks Quick Setup] ********************************************************

    TASK [Gathering Facts] **************************************************************
    ok: [localhost]

    TASK [system: template out sys.info] ************************************************
    changed: [localhost]

    TASK [verify some requirements] *****************************************************
    ok: [localhost] => {
        "changed": false,
        "msg": "All assertions passed"
    }

    TASK [detect: acme] *****************************************************************
    ok: [localhost]

    TASK [system: install OwnTracks repository key] *************************************
    changed: [localhost]

    TASK [system: install OwnTracks repository] *****************************************
    changed: [localhost]

    TASK [system: install required packages]
    ...
```

--------------------------------

### Launch Installer

Source: https://owntracks.org/booklet/guide/quicksetup

Execute the bootstrap script to begin the installation process.

```bash
$ sudo ./bootstrap.sh
```

--------------------------------

### Clone Quicksetup Repository

Source: https://owntracks.org/booklet/guide/quicksetup

Install git and clone the quicksetup repository to the local system.

```bash
$ sudo apt install -y git    # not required on Ubuntu
$ git clone --depth=1 https://github.com/owntracks/quicksetup
$ cd quicksetup
```

--------------------------------

### Install Paho MQTT Client

Source: https://owntracks.org/booklet/tech/program

Commands to create a virtual environment and install the Paho MQTT library for Python.

```bash
$ python3 -mvenv venv
$ source venv/bin/activate
(venv) $ pip install paho-mqtt
```

--------------------------------

### Configure Encryption in Quicksetup

Source: https://owntracks.org/booklet/features/encrypt

Configuration examples for setting up encryption secrets within the Quicksetup environment.

```yaml
friends:
   - { tid: j2, username: jjolie, devicename: Phone, secret: "mysecreTpass01" }
```

```bash
$ printf "mysecreTpass01" > .jjolie.key
```

```bash
$ grep encryption /usr/local/owntracks/userdata/jjolie.otrc
"encryptionKey": "mysecreTpass01",
```

```bash
$ ocat --dump=keys
jjolie-phone mysecreTpass01
```

--------------------------------

### Example base64-encoded configuration URL

Source: https://owntracks.org/booklet/features/remoteconfig

The resulting URL string after encoding the configuration file.

```text
owntracks:///config?inline=ewogICJfdHlwZSI6ICJjb25maWd1cmF0aW9uIiwKICAiYXV0aCI6IHRydWUsCiAgInVzZXJuYW1lIjogImpqb2xpZSIsCiAgInBhc3N3b3JkIjogInMxa3IzdCIsCiAgImhvc3QiOiAibXlicm9rZXIuZXhhbXBsZS5vcmciLAogICJwb3J0IjogODg4Mwp9Cg==
```

--------------------------------

### Example MQTT Output

Source: https://owntracks.org/booklet/guide/quicksetup

Sample output format received from the MQTT broker showing location data.

```json
owntracks/jane/nokia {"_type":"location","SSID":"mywifi","alt":154,"batt":53,"conn":"w","created_at":1706856299,"lat":48.856826,"lon":2.292713,"tid":"j1","tst":1706856298,"vel":0}
```

--------------------------------

### Example Output File Content

Source: https://owntracks.org/booklet/tech/lua

The expected content of the log file after processing a location update.

```text
    written by OwnTracks Recorder version 0.3.0
    It is 17:13:33 in the year 2015 owntracks/jane/phone lat=48.858339 Avenue Anatole France, 75007 Paris, France
```

--------------------------------

### Configure Mosquitto for TLS

Source: https://owntracks.org/booklet/features/tls

Example configuration for mosquitto.conf to enable TLS using specific certificate and key files.

```text
listener 8883
cafile ca-bundle.crt
certfile server.crt
keyfile server.key
```

--------------------------------

### Publishing a Card via MQTT

Source: https://owntracks.org/booklet/features/card

Example of generating a card using a script and publishing it to an MQTT broker as a retained message.

```bash
./github2card.py defunkt > my-card.json
mosquitto_pub -t owntracks/jjolie/phone/info -f my-card.json -r -q 2
```

--------------------------------

### Example MQTT Topic for Jane

Source: https://owntracks.org/booklet/features/friends

The topic path used by the user 'jjolie' with device '4s' to publish location data.

```text
owntracks/jjolie/4s
```

--------------------------------

### MySQL Locations Table Structure

Source: https://owntracks.org/booklet/tech/http

Example output showing the structure and content of the locations database table.

```sql
mysql> select * from locations;
+---------------------+------+-----------+----------+
| dt                  | tid  | lat       | lon      |
+---------------------+------+-----------+----------+
| 2016-02-20 09:16:05 | JJ   | 48.858330 | 2.295130 |
| 2016-02-20 09:19:49 | JJ   | 48.860430 | 2.294010 |
+---------------------+------+-----------+----------+

```

--------------------------------

### Automate report via cron

Source: https://owntracks.org/booklet/features/pedometer

Example cron entry to pipe the generated report payload to the MQTT broker.

```bash
50 22 * * * /usr/local/bin/reportsteps | mosquitto_pub -q 2 -t owntracks/jpm/5s/cmd -l
```

--------------------------------

### Example Lua Script for File Logging

Source: https://owntracks.org/booklet/tech/lua

A basic implementation of the required Lua lifecycle functions to log location data to a file.

```lua
    local file

    function otr_init()
        otr.log("example.lua starting; writing to /tmp/lua.out")
        file = io.open("/tmp/lua.out", "a")
        file:write("written by OwnTracks Recorder version " .. otr.version .. "\n")
    end

    function otr_hook(topic, _type, data)
        local timestr = otr.strftime("It is %T in the year %Y", 0)
        print("L: " .. topic .. " -> " .. _type)
        file:write(timestr .. " " .. topic .. " lat=" .. data['lat'] .. data['addr'] .. "\n")
    end

    function otr_exit()
    end
```

--------------------------------

### Example Location Output

Source: https://owntracks.org/booklet/tech/program

Sample output format for location reports showing tracker ID and coordinates.

```text
TID = n4 is currently at 51.0343863, 9.4763712
TID = jane is currently at 48.856826, 2.292713
```

--------------------------------

### Example MQTT Topic for John

Source: https://owntracks.org/booklet/features/friends

The topic path used by the user 'john' with device 'nex4' to publish location data.

```text
owntracks/john/nex4
```

--------------------------------

### iBeacon configuration URI example

Source: https://owntracks.org/booklet/tech/qr

A standard URI string used to configure an iBeacon within the OwnTracks application.

```text
owntracks:///beacon?rid=ac3def&name=MyBeacon&uuid=12345678-1234-1234-1234-123456789A&major=2&minor=1
```

--------------------------------

### View PEM-encoded certificate content

Source: https://owntracks.org/booklet/features/tls

Example of a raw PEM-encoded certificate file structure.

```text
-----BEGIN CERTIFICATE-----
MIIDGTCCAoKgAwIBAgIJAODXne2yV51zMA0GCSqGSIb3DQEBBQUAMGcxCzAJBgNV
BAYTAkRFMQwwCgYDVQQIEwNOUlcxETAPBgNVBAcTCElyZ2VuZHdvMRYwFAYDVQQK
...
pjGM/XgBs62UhqXnoHrHh/AHIiHieuNFwOhUg0fD/vQ5O6UZkJTWY5LLmEyPN5sS
cPZ5pT/WCvGuIOgNdy1VyWJrrlAjeQlbK+GDcNc=
-----END CERTIFICATE-----
```

--------------------------------

### Example JSON Payload

Source: https://owntracks.org/booklet/tech/lua

A sample JSON payload representing a location update processed by the Recorder.

```json
    {"batt":-1,"lon":2.29513,"lat":48.85833,"t":"u","tst":1441984413,"_type":"location","tid":"JJ"}
```

--------------------------------

### Transition Event JSON Payload

Source: https://owntracks.org/booklet/features/waypoints

Example of a JSON payload published by the device when entering a configured region.

```json
{
      "_type": "transition",
      "desc": "My favorite coffee shop (Delaville)",
      "event": "enter",
      "lat": 48.87069,
      "lon": 2.34916,
      "rid": "f7676c",
      "tid": "j1",
      "tst": 1707057574,
      "wtst": 1610104395
}
```

--------------------------------

### Define Friends in YAML

Source: https://owntracks.org/booklet/features/qs-config

Examples of defining friends in the configuration.yaml file using inline or block-style YAML syntax.

```yaml
          friends:
            - { tid: JJ, username: jane,   devicename: nokia }
```

```yaml
          friends:
            - tid: JJ
              username: jane
              devicename: nokia
```

```yaml
          friends:
            - tid: JJ
              username: jane
              devicename: nokia
            - tid: m1
              username: another
              ...
```

--------------------------------

### OwnTracks Client URL

Source: https://owntracks.org/booklet/features/traccar

Example URL format for connecting an OwnTracks client to a Traccar server.

```text
http://traccar.example.net:5144
```

--------------------------------

### Configure iBeacon Monitoring

Source: https://owntracks.org/booklet/features/beacons

Examples of configuring general beacon monitoring and specific beacon targeting using UUID, major, and minor identifiers.

```text
Name  myBeacons
UUID  CA271EAE-5FA8-4E80-8F08-2A302A95A959
Major 0
Minor 0

Name  mySpecificBeacon
UUID  CA271EAE-5FA8-4E80-8F08-2A302A95A959
Major 1
Minor 33000
```

--------------------------------

### Interpret Mosquitto log output

Source: https://owntracks.org/booklet/guide/broker

Example of a successful OwnTracks location publish event as recorded in the Mosquitto log file.

```text
mosquitto[1366]: Received PUBLISH from jane-5s-m-o (d0, q2, r1, m7, 'owntracks/jane/5s', ... (159 bytes))
mosquitto[1366]: Sending PUBREC to jane-5s-m-o (Mid: 7)
mosquitto[1366]: Received PUBREL from jane-5s-m-o (Mid: 7)
mosquitto[1366]: Sending PUBCOMP to jane-5s-m-o (Mid: 7)
```

--------------------------------

### Traccar API Response

Source: https://owntracks.org/booklet/features/traccar

Example of a position query result from the Traccar API.

```json
[
  {
    "id": 475,
    "attributes": {
      "t": "u",
      "battery": 41,
      "tid": "JJ",
      "ip": "127.0.0.1",
      "distance": 0,
      "totalDistance": 0
    },
    "deviceId": 4,
    "type": null,
    "protocol": "owntracks",
    "serverTime": "2017-06-15T06:37:32.000+0000",
    "deviceTime": "2017-06-15T06:37:31.000+0000",
    "fixTime": "2017-06-15T06:37:31.000+0000",
    "outdated": false,
    "valid": true,
    "latitude": 48.85833,
    "longitude": 2.29513,
    "altitude": 167,
    "speed": 1.18575,
    "course": 271,
    "address": "9 Avenue Anatole France, Paris, Île-de-France, FR",
    "accuracy": 5,
    "network": null
  }
]
```

--------------------------------

### Sample .otrc configuration file

Source: https://owntracks.org/booklet/features/remoteconfig

A JSON-formatted configuration file used to set initial device parameters.

```json
{
  "_type": "configuration",
  "auth": true,
  "username": "jjolie",
  "password": "s1kr3t",
  "host": "mybroker.example.org",
  "port": 8883
}
```

--------------------------------

### Verify DNS configuration

Source: https://owntracks.org/booklet/guide/quicksetup

Test that the chosen domain resolves to the VPS IP address using ping.

```bash
$ ping owntracks.example
...

```

--------------------------------

### HTTP Request Headers for Identification

Source: https://owntracks.org/booklet/tech/http

Example of the Content-Type and custom identification headers sent by OwnTracks apps.

```http
Content-Type: application/json
X-Limit-U: jjolie
X-Limit-D: myphone

```

--------------------------------

### Assimilate Legacy MQTTitude Topics

Source: https://owntracks.org/booklet/guide/bridge

Bridge configuration to map legacy MQTTitude topics into the current OwnTracks structure.

```text
topic # in 2 owntracks/ mqttitude/
```

--------------------------------

### Generate Client Certificate

Source: https://owntracks.org/booklet/features/tlscert

Use the generate-CA.sh script to create a client key and certificate pair.

```bash
./generate-CA.sh client jjolie
```

--------------------------------

### Subscribe to MQTT topics

Source: https://owntracks.org/booklet/guide/quicksetup

View all incoming MQTT payloads by subscribing to all topics.

```bash
$ mosquitto_sub -v -t '#'
```

--------------------------------

### Waypoint Definition JSON Payload

Source: https://owntracks.org/booklet/features/waypoints

Example of a JSON payload published to the /waypoint topic when a region is defined or updated.

```json
{
    "_type": "waypoint",
    "desc": "My favorite coffee shop (Delaville)",
    "lat": 48.87069,
    "lon": 2.34916,
    "rad": "50",
    "tst": "1385997757",
    "rid": "f7676c",
    "wtst": 1610104395
}
```

--------------------------------

### Display system information

Source: https://owntracks.org/booklet/guide/quicksetup

Output the contents of the sys.info file generated during the bootstrap process.

```bash
    $ cat sys.info
    Last bootstrap: 2024-02-08T13:18:43Z

    Ansible version: 2.14.3
    OS distro: Debian / 12 4
    OS distribution: bookworm
```

--------------------------------

### Verify Operating System

Source: https://owntracks.org/booklet/guide/quicksetup

Check the current operating system version to ensure compatibility.

```bash
$ hostnamectl
...
Operating System: Debian GNU/Linux 12 (bookworm)
...
```

--------------------------------

### Configure Topic Base Settings

Source: https://owntracks.org/booklet/guide/topics

Required configuration keys for modifying the default MQTT topic root and subscription path.

```text
pubTopicBase
subTopic
```

--------------------------------

### HTTP POST Payloads

Source: https://owntracks.org/booklet/features/traccar

Examples of JSON payloads sent from OwnTracks to Traccar, using either tid or topic as the identifier.

```json
  {"lon":2.29513,"lat":48.85833,"_type":"location","tst":1497476456, "tid":"JJ"}

  {"lon":2.29513,"lat":48.85833,"_type":"location","topic":"owntracks/jane/phone", "tid": "JJ"}
```

--------------------------------

### Define Waypoints for Users

Source: https://owntracks.org/booklet/features/qs-config

Configure initial geofence waypoints using JSON or YAML files in the waypoints/ directory.

```json
  [
    {
      "_type": "waypoint",
      "tst": 1361636517,
      "rid": "blauw-utrecht-nl",
      "desc": "Restaurant Blauw",
      "rad": 50,
      "lat": 52.08782,
      "lon": 5.119438
    }
  ]
```

```yaml
  - _type: waypoint
    desc: "Delaville Café"
    rid: delaville-cafe
    tst: 1708879121
    rad: 70
    lat: 48.870737
    lon: 2.3491583
```

--------------------------------

### _type=cmd

Source: https://owntracks.org/booklet/tech/json

Describes the command actions that can be sent to devices.

```APIDOC
## _type=cmd

### Description
Commands sent to a device to trigger specific actions.

### Actions
- **reportLocation**: Triggers a location report.
- **reportSteps**: Triggers a steps report (optional 'from' and 'to' timestamps).
- **dump**: Triggers a configuration message publish.
- **status**: Triggers a status message publish.
- **waypoints**: Triggers a waypoints message publish.
- **clearWaypoints**: Deletes all waypoints/regions.
- **setConfiguration**: Imports and activates new configuration values.
- **setWaypoints**: Imports and activates new waypoints.
```

--------------------------------

### Generate iBeacon QR code with qrencode

Source: https://owntracks.org/booklet/tech/qr

Uses the qrencode command-line tool to create a PNG image containing an OwnTracks iBeacon configuration URI.

```bash
qrencode -l H -v 10 -d 300 -o mybeacon.png 'owntracks:///beacon?rid=ac3def&name=MyBeacon&uuid=12345678-1234-1234-1234-123456789A&major=2&minor=1'
```

--------------------------------

### Extended HTTP Payload

Source: https://owntracks.org/booklet/features/traccar

Example of a full JSON payload from an OwnTracks app containing additional attributes like battery and speed.

```json
{
  "cog": 271,
  "batt": 41,
  "lon": 2.29513,
  "acc": 5,
  "vel": 61,
  "vac": 21,
  "lat": 48.85833,
  "t": "u",
  "tst": 1497508651,
  "alt": 167,
  "_type": "location",
  "topic": "owntracks/jane/iphone",
  "p": 71,
  "tid": "JJ"
}
```

--------------------------------

### Subscribe to MQTT topics with mosquitto_sub

Source: https://owntracks.org/booklet/guide/clients

Basic command-line invocation to connect to a broker and subscribe to OwnTracks location topics.

```bash
mosquitto_sub -h localhost -p 1883 -v -t 'owntracks/#'
```

--------------------------------

### Create PKCS#12 Container

Source: https://owntracks.org/booklet/features/tlscert

Package the client certificate and key into a password-protected PKCS#12 file for secure transport to mobile devices.

```bash
openssl pkcs12 \
  -legacy \
  -export \
  -in jjolie.crt \
  -inkey jjolie.key \
  -name "Jane's certificate/key" \
  -out jjolie.p12
```

--------------------------------

### Subscribe to MQTT Broker

Source: https://owntracks.org/booklet/guide/quicksetup

Use this command to monitor incoming location data from the MQTT broker without needing manual authentication.

```bash
$ mosquitto_sub -v -t 'owntracks/#'
```

--------------------------------

### HTML configuration link template

Source: https://owntracks.org/booklet/features/remoteconfig

An HTML snippet showing how to embed the configuration URL in a link.

```html
<html><body><p>
<a href="@@">Click to configure OwnTracks</a>
</p></body></html>
```

--------------------------------

### Configure OpenHAB MQTT broker

Source: https://owntracks.org/booklet/features/pedometer

Configuration settings for the MQTT broker in OpenHAB.

```text
mqtt-retain.url=tcp://192.168.1.1:1884
mqtt-retain.qos=2
```

--------------------------------

### Configure TLS in mosquitto.conf

Source: https://owntracks.org/booklet/features/tls

Basic configuration settings required to enable TLS on a Mosquitto MQTT broker.

```text
listener 8883
cafile .............
certfile .............
keyfile .............
```

--------------------------------

### Publishing Waypoints via MQTT

Source: https://owntracks.org/booklet/features/waypoints

Command to publish a JSON waypoint file to the device command topic using mosquitto_pub.

```bash
$ jq -c . wp.json |
      mosquitto_pub -u username -P 'password' -t owntracks/jane/nokia/cmd -q 1 -l
```

--------------------------------

### Publish to MQTT as _lr user

Source: https://owntracks.org/booklet/features/qs-extra

Uses the randomly generated password stored in the .lr.pw file to authenticate the _lr user for MQTT publishing.

```bash
$ mosquitto_pub -u _lr -P "$(cat /usr/local/owntracks/userdata/.lr.pw)" ...
```

--------------------------------

### POST /request (Create Tour)

Source: https://owntracks.org/booklet/features/tours

Creates a new time-limited tour view for location sharing.

```APIDOC
## POST /request

### Description
Creates a new tour for a specified time range. The Recorder returns a unique URL that can be shared with others to view location data within that timeframe.

### Request Body
- **_type** (string) - Required - Must be "request"
- **request** (string) - Required - Must be "tour"
- **tour** (object) - Required - Contains label, from, and to timestamps

### Request Example
{
  "_type": "request",
  "request": "tour",
  "tour": {
    "label": "Meeting with C. in Essen",
    "from": "2022-08-01T05:35:58",
    "to": "2022-08-02T15:00:58"
  }
}

### Response
#### Success Response (200)
- **_type** (string) - Response type
- **action** (string) - Action performed
- **request** (string) - Original request type
- **status** (integer) - HTTP status code
- **tour** (object) - Tour details including uuid and url
```

--------------------------------

### Verify service status

Source: https://owntracks.org/booklet/guide/quicksetup

Check the operational status of the recorder, MQTT broker, and web server.

```bash
$ systemctl status ot-recorder
$ systemctl status mosquitto
$ systemctl status nginx
```

--------------------------------

### Republishing HTTP Posts via Lua

Source: https://owntracks.org/booklet/tech/lua

A script to republish HTTP-submitted location data to MQTT, requiring an external JSON library.

```lua
  -- requires: 
  --   a) Compile recorder with -DLUA and configure
  --   b) OTR_LUASCRIPT = ".../repub.lua"
  -- also requires Lua JSON from http://regex.info/blog/lua/json

  JSON = (loadfile "/etc/ot-recorder/JSON.lua")()

  function otr_init()
  end

  function otr_exit()
  end

  function otr_hook(topic, _type, data)
      otr.log("DEBUG_PUB:" .. topic .. " " .. JSON:encode(data))
      if(data['_http'] == true) then
          if(data['_repub'] == true) then
             return
          end
          data['_repub'] = true
          local payload = JSON:encode(data)
          otr.publish(topic, payload, 1, 1)
      end
  end
```

--------------------------------

### Monitor MQTT broker logs

Source: https://owntracks.org/booklet/guide/quicksetup

View incoming requests processed by the MQTT broker.

```bash
$ tail -f /var/log/mosquitto/mosquitto.log
```

--------------------------------

### OpenHAB item definition for steps

Source: https://owntracks.org/booklet/features/pedometer

Item configuration to parse the incoming step count JSON via JSONPATH.

```text
Number Steps_Yesterday "[%d]"  { mqtt="<[mqtt:owntracks/jj/5s/step:state:JSONPATH($.steps)]" }
```

--------------------------------

### Request step count via MQTT

Source: https://owntracks.org/booklet/features/pedometer

Use this command to trigger the OwnTracks app to report the current step count. QoS 2 is recommended to ensure delivery when the device wakes up.

```bash
mosquitto_pub -q 2 -t owntracks/jj/5s/cmd -m '{"_type" : "cmd", "action": "reportSteps"}'
```

--------------------------------

### Device Configuration JSON Structure

Source: https://owntracks.org/booklet/tech/json

The base structure for device configuration messages.

```json
{
    "_type": "configuration",
    elements
}
```

--------------------------------

### POST /request (List Tours)

Source: https://owntracks.org/booklet/features/tours

Retrieves a list of all current tours created by the user.

```APIDOC
## POST /request

### Description
Retrieves an array of existing tours and their unique URLs for the authenticated user.

### Request Body
- **_type** (string) - Required - Must be "request"
- **request** (string) - Required - Must be "tours"

### Request Example
{
  "_type": "request",
  "request": "tours"
}

### Response
#### Success Response (200)
- **tours** (array) - List of tour objects
- **ntours** (integer) - Number of tours returned
```

--------------------------------

### Request Tour Creation

Source: https://owntracks.org/booklet/tech/json

Apps can send a request to the Recorder to initiate the creation of a tour.

```APIDOC
## Request Tour Creation

### Description
Apps can request the creation of tours which elicit a `cmd` response from the Recorder.

### Request Body
- **_type** (string) - Required - Must be "request"
- **request** (string) - Required - Must be "tour"
- **tour** (object) - Required - The tour configuration object

### Request Example
{
  "_type": "request",
  "request": "tour",
  "tour": {}
}
```

--------------------------------

### Verify location data arrival

Source: https://owntracks.org/booklet/guide/quicksetup

Check the specific recorder storage file to confirm location data has been received.

```bash
$ tail /var/spool/owntracks/recorder/store/jane/nokia/YYYY-MM.rec
```

--------------------------------

### Manage Recorder Decryption Keys

Source: https://owntracks.org/booklet/features/encrypt

Commands to load, dump, or delete decryption keys for specific user-device combinations in the Recorder.

```bash
printf "jjolie-phone mysecreTpass01" | ocat --load=keys
```

```bash
ocat --dump=keys
```

```bash
printf "jjolie-phone DELETE" | ocat --load=keys
```

--------------------------------

### OpenHAB rule for daily step requests

Source: https://owntracks.org/booklet/features/pedometer

An OpenHAB rule to trigger a step report request at 23:59 daily.

```java
rule "MQTT_OWNTRACKS_STEPS"
when
    // every day at 23:59
    Time cron "0 59 23 * * ? *"
then
    val long from1 = DateTime.now().withTimeAtStartOfDay().millis / 1000
    val long to1 = (now.millis / 1000)
    publish("mqtt-retain","owntracks/jj/5s/cmd",'{"action": "reportSteps", "to": '+ to1 +', "_type": "cmd", "from": '+ from1 +'}')
end
```

--------------------------------

### Generate base64-encoded configuration URL

Source: https://owntracks.org/booklet/features/remoteconfig

Uses openssl to encode a configuration file into an owntracks:// URL scheme.

```bash
echo "owntracks:///config?inline=$(openssl enc -a -A -in j.otrc)"
```

--------------------------------

### Tour creation response

Source: https://owntracks.org/booklet/features/tours

The response from the Recorder containing the unique URL for the created tour.

```json
{
  "_type": "cmd",
  "action": "response",
  "request": "tour",
  "status": 200,
  "tour": {
       "label": "Meeting with C. in Essen",
       "from": "2022-08-01T05:35:58",
       "to": "2022-08-02T15:00:58",
       "uuid": "7fc09e95-0082-4f2e-b3ee-bd68e39a39fe",
       "url": "http://localhost:8085/view/7fc09e95-0082-4f2e-b3ee-bd68e39a39fe"
}

}
```

--------------------------------

### Configure Friend-Specific MQTT ACLs

Source: https://owntracks.org/booklet/features/qs-config

Define custom access control lists for a specific user by creating an .acl file in the acl/ directory.

```text
  $ cat acl/anouk.acl
  user anouk
  topic readwrite owntracks/anouk/#
  topic read owntracks/jane/nokia
  topic read owntracks/jane/+/event
  topic read owntracks/jane/+/info
```

--------------------------------

### Bridge Command Topics

Source: https://owntracks.org/booklet/guide/bridge

Configuration to allow sending command requests to a remote device.

```text
topic cmd out 2 owntracks/jane/nexus7/ owntracks/jane/nexus7/
```

--------------------------------

### Bridge Location and Event Topics

Source: https://owntracks.org/booklet/guide/bridge

Additional topic configurations to support transition events alongside location data.

```text
topic nexus7 in 2 owntracks/jane/ owntracks/jane/
topic event in 2 owntracks/jane/nexus7/ owntracks/jane/nexus7/
```

--------------------------------

### Inspect recorder diagnostics

Source: https://owntracks.org/booklet/guide/quicksetup

View diagnostic output from the background recorder service.

```bash
$ journalctl -u ot-recorder -f
$ tail -f /var/log/syslog | grep ot-recorder
```

--------------------------------

### Test HTTP endpoint with curl

Source: https://owntracks.org/booklet/tech/http

Uses the jo utility to construct a JSON payload and sends it to a local HTTP endpoint via curl.

```shell
#!/bin/sh

user=jane
device=phone

payload=$(jo _type=location \
   t=u \
   batt=11 \
   lat=48.856826 \
   lon=2.292713 \
   tid=JJ \
   tst=$(date +%s) \
   topic="owntracks/$user/$device")

curl --data "${payload}" http://127.0.0.1:8085/pub?u=${user}&d=${device}
```

--------------------------------

### Losant IoT Platform Connection Settings

Source: https://owntracks.org/booklet/tech/mqtt

Required configuration parameters for connecting OwnTracks to the Losant IoT Developer Platform.

```json
{
    "_type": "configuration",
    "mode":0,
    "mqttProtocolLevel": 4,
    "host":"broker.losant.com",
    "port":8883,
    "tls":true,
    "pubRetain": false,
    "pubQos": 0,
    "subQos":0,
    "cleanSession": true,
    "clientId":"CLIENT_ID",
    "auth":true,
    "username":"ACCESS_KEY",
    "password":"ACCESS_SECRET"
}
```

--------------------------------

### _type=transition

Source: https://owntracks.org/booklet/tech/json

A transition message is sent when entering or leaving a previously configured geographical region or BLE Beacon. The message contains the event details and location data.

```APIDOC
## _type=transition

### Description
A transition message is sent when entering or leaving a previously configured geographical region or BLE Beacon. MQTT transition messages are published non-retained.

### Parameters
- **wtst** (integer) - Required - Timestamp of waypoint creation (epoch).
- **lat** (float) - Optional - Latitude at which the event occurred.
- **lon** (float) - Optional - Longitude at which the event occurred.
- **tst** (integer) - Required - Timestamp at which the event occurred (epoch).
- **acc** (int) - Required - Accuracy of the geographical coordinates in meters.
- **tid** (string) - Optional - Tracker ID (required in http mode).
- **event** (string) - Required - Event that triggered the transition ('enter' or 'leave').
- **desc** (string) - Optional - Name of the waypoint.
- **t** (string) - Optional - Trigger of the event ('c' for circular region, 'b' for BLE Beacon, 'l' for location update).
- **rid** (string) - Optional - Region ID.

### Request Example
{
    "_type": "transition",
    "wtst": 1610000000,
    "tst": 1610000005,
    "acc": 10,
    "event": "enter",
    "t": "c",
    "desc": "Home"
}
```

--------------------------------

### MQTT ACL for Tour data

Source: https://owntracks.org/booklet/features/tours

Required ACL configuration to allow the Recorder to publish tour data to the broker.

```text
topic write owntracks/+/+/cmd
```

--------------------------------

### Inspect certificate details

Source: https://owntracks.org/booklet/features/tls

Human-readable output showing the internal data of an X.509 certificate.

```text
Certificate:
    Data:
        Version: 3 (0x2)
        Serial Number:
            e0:d7:9d:ed:b2:57:9d:73
        Signature Algorithm: sha1WithRSAEncryption
        Issuer: C=DE, ST=NRW, L=Irgendwo, O=MQTTitude.org/emailAddress=jjolie@example.com
        Validity
            Not Before: Aug 18 10:26:08 2013 GMT
            Not After : Aug 16 10:26:08 2023 GMT
        Subject: C=DE, ST=NRW, L=Irgendwo, O=MQTTitude.org/emailAddress=jjolie@example.com
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
            RSA Public Key: (1024 bit)
                Modulus (1024 bit):
                    00:bd:70:b0:49:d4:17:c9:17:33:4d:74:fc:61:25:
                    ...
                Exponent: 65537 (0x10001)
        X509v3 extensions:
            X509v3 Subject Key Identifier: 
                4C:89:83:F0:33:AD:2B:D7:FD:DE:1D:6D:8D:00:52:C1:1C:75:B1:85
            X509v3 Authority Key Identifier: 
                keyid:4C:89:83:F0:33:AD:2B:D7:FD:DE:1D:6D:8D:00:52:C1:1C:75:B1:85
                DirName:/C=DE/ST=NRW/L=Irgendwo/O=MQTTitude.org/emailAddress=jjolie@example.com
                serial:E0:D7:9D:ED:B2:57:9D:73

            X509v3 Basic Constraints: 
                CA:TRUE
    Signature Algorithm: sha1WithRSAEncryption
        74:12:f8:d0:51:3a:c6:f8:62:75:61:d1:56:2f:bf:e3:64:3c:
        ...
```
Tokens:
Raw