From 0eea64f2e42ef0d8363b060676a93efde2e72dd6 Mon Sep 17 00:00:00 2001 From: Jonathan Bennett Date: Sun, 11 Jun 2023 18:55:03 -0500 Subject: [PATCH] Add more Owntracks_plugin documentation --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index fcbb5af..38cbfc2 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,7 @@ The following plugins can be used in the `pipelines` section of `config.yaml`: | `decrypt_filter` | Decrypt a packet originating from MQTT | | `radio_message_plugin` | Send a packet to a specified `device` | | `nostr_plugin` | Send a NoStr event to a relay | +| `owntracks_plugin` | Send location data to MQTT server for Owntracks | ### debugger - Output the contents of a packet @@ -261,6 +262,27 @@ Placeholders can be used with the **message** value: - `{MSG}` - Packet text +### owntracks_plugin - Send location data to MQTT server for Owntracks + +- **log_level** `debug` or `info`. Default `info` +- **server_name** The mqtt server to send owntracks messages to +- **tid_table** Table of the numeric from IDs of each node, mapped to an Owntracks name and TID + + +For example: + +``` +owntracks_plugin: + server_name: external + tid_table: + "1234": ["Van", "GV"] + "-5678": ["Home", "HR"] +``` + +Placeholders can be used with the **message** value: + +- `{MSG}` - Packet text + ### radio_message_plugin - Send a packet to a radio - **log_level** `debug` or `info`. Default `info`