Metainformationen zur Seite

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
plugins:owntracks:start [2022/09/16 15:30] – [Setup for MQTT Interface] Michael Schlenstedtplugins:owntracks:start [2024/03/20 17:26] (aktuell) – Struct-Daten geändert Michael Schlenstedt
Zeile 1: Zeile 1:
-====== Owntracks  ======+====== Owntracks ======
  
 ===== Basic Info Owntracks ===== ===== Basic Info Owntracks =====
  
-OwnTracks is an Open Source project which provides an iOS and an Android app with which your smartphone records its current location. Whether you want your young child to know where you currently are, or you want to keep track of where you spent your last vacation, or you and a group of friends want to see each other on a map, OwnTracks does that. It consists of an app which runs on your smart phone, and which periodically, publishes a small chunk of data which other OwnTracks users you authorize may see. It also support beacon tracking 8iOS devices only) and bring other added value to Miniserver. Uisng Owntracks you can set-up an presence detection as well as other stuff.+OwnTracks is an Open Source project which provides an iOS and an Android app with which your smartphone records its current location. Whether you want your young child to know where you currently are, or you want to keep track of where you spent your last vacation, or you and a group of friends want to see each other on a map, OwnTracks does that. It consists of an app which runs on your smart phone, and which periodically, publishes a small chunk of data which other OwnTracks users you authorize may see. It also support ibeacon tracking on iOS devices only) and bring other added value to Miniserver. Using Owntracks you can set-up an presence detection as well as other stuff.
  
 Download the Apps: Download the Apps:
Zeile 16: Zeile 16:
 There is a Booklet covering tons of details how to set-up the App, your loacations and how owntracks works. Personally i can't support how to use/set-up the App in your environment. There is a Booklet covering tons of details how to set-up the App, your loacations and how owntracks works. Personally i can't support how to use/set-up the App in your environment.
  
-  * Owntracks documentation: https://owntracks.org/booklet/+  * Owntracks documentation: [[https://owntracks.org/booklet/]]
  
 ===== Requirements ===== ===== Requirements =====
  
-  - DnyDNS or static or local IP-Address (DynDNS recommended for security reasons) available This may change in the future to use TLS.+  - DnyDNS or static or local IP-Address (DynDNS recommended for security reasons) available This may change in the future to use to TLS.
   - configure Portwording rule for TCP-Port 1883 to xxxx(x) in your Router   - configure Portwording rule for TCP-Port 1883 to xxxx(x) in your Router
   - installed MQTT Plugin   - installed MQTT Plugin
Zeile 29: Zeile 29:
 open Plugin post installation and you have all Info required. In addition there is a tab to get the command recognition to be used for Loxone, as well as a direct link to MQTT. In case you have **weather4lox** Plugin installed your location data will be parsed in, if not a **google map** tab appears to identify your location data. open Plugin post installation and you have all Info required. In addition there is a tab to get the command recognition to be used for Loxone, as well as a direct link to MQTT. In case you have **weather4lox** Plugin installed your location data will be parsed in, if not a **google map** tab appears to identify your location data.
  
-{{plugins:owntracks:1228538762.png?h=400}}+{{plugins:owntracks:1228538762.png?400}}
  
 After saving your config create a user specific App configuration file and pass it to corresponding User. Once User has completed the set-up on his Smartphone you should see incoming traffic either in Plugin Monitor or in MQTT Plugin  After saving your config create a user specific App configuration file and pass it to corresponding User. Once User has completed the set-up on his Smartphone you should see incoming traffic either in Plugin Monitor or in MQTT Plugin 
Zeile 37: Zeile 37:
 for setting up Owntracks you need to have a LoxBerry with appropriate Plugin installed. How to do that and do how-to do the basic configuration please visit the support Wiki page here: [[plugins:mqtt_gateway:start|MQTT Gateway]] There are detailed instructions how to do. for setting up Owntracks you need to have a LoxBerry with appropriate Plugin installed. How to do that and do how-to do the basic configuration please visit the support Wiki page here: [[plugins:mqtt_gateway:start|MQTT Gateway]] There are detailed instructions how to do.
  
-I will focus on adding the owntracks required settings. +The Plugin installation contains automatically the subscriptions and conversionsso no need to take action on MQTT
- +
-Please select the type of data transmission to Miniserver. You can use either HTTP or UDPHow it looks like then in MS you can find under (link to MS) +
- +
-{{plugins:owntracks:1228538291.png?h=250}} +
- +
-next step is switch on both "**Data transformations**" in order to get the data for command recognition into MS. If you don't set both you won't be able to get data, also the conversions won't work +
- +
-{{plugins:owntracks:1228538292.png?w=500}} +
- +
-The Owntrack specific settings Topic and necessary conversions will be added from the Owntracks Plugin+
  
 ===== Setup Owntracks in iOS ===== ===== Setup Owntracks in iOS =====
Zeile 61: Zeile 51:
   - test data transfer by clicking on **Publish waypoints**\\   - test data transfer by clicking on **Publish waypoints**\\
  
-{{plugins:owntracks:1228538731.png?h=200}}{{plugins:owntracks:1228538732.png?h=200}}{{plugins:owntracks:1228538728.png?h=200}}{{plugins:owntracks:1228538729.jpg?h=200}}{{plugins:owntracks:1228538730.png?h=200}}{{plugins:owntracks:1228538148.png?h=200}}+{{plugins:owntracks:1228538731.png?200}}{{plugins:owntracks:1228538732.png?200}}{{plugins:owntracks:1228538728.png?200}}{{plugins:owntracks:1228538729.jpg?200}}{{plugins:owntracks:1228538730.png?200}}{{plugins:owntracks:1228538148.png?200}}
  
 Now you should open Owntracks Plugin and check either in "**Monitor / Command Recognition**" tab or in your MQTT Plugin and there "**Incoming overview**" or "**Logfiles**" if you have received data Now you should open Owntracks Plugin and check either in "**Monitor / Command Recognition**" tab or in your MQTT Plugin and there "**Incoming overview**" or "**Logfiles**" if you have received data
Zeile 87: Zeile 77:
 if you have selected "**Send data via UDP**" you have to add a virtual UDP input to your config and enter the MQTT Plugin Port (default is **11883**) if you have selected "**Send data via UDP**" you have to add a virtual UDP input to your config and enter the MQTT Plugin Port (default is **11883**)
  
-{{plugins:owntracks:1228538304.png?h=250}}+{{plugins:owntracks:1228538304.png?250}}
  
 adding virtual UDP input command and the comand recognition: adding virtual UDP input command and the comand recognition:
  
-{{plugins:owntracks:1228538306.png?h=400}}+{{plugins:owntracks:1228538306.png?400}}
  
 the basic command recogniation is always "owntracks/loxberry/**<DeviceID>**/" followed by the type of data you would like to have. the basic command recogniation is always "owntracks/loxberry/**<DeviceID>**/" followed by the type of data you would like to have.
Zeile 97: Zeile 87:
 ===== Differences between iOS/Android ===== ===== Differences between iOS/Android =====
  
-Depending on used Hardware and Interface there are differences in the data layout/set which been send to Loxone. Those can be found here https://owntracks.org/booklet/tech/json/ very detailed splitted by message payloads (Types) +Depending on used Hardware and Interface there are differences in the data layout/set which been send to Loxone. Those can be found here [[https://owntracks.org/booklet/tech/json/]] very detailed splitted by message payloads (Types) 
  
 ==== Data Types ==== ==== Data Types ====
Zeile 103: Zeile 93:
 OwnTracks publishes its message payloads in [[http://www.json.org/|JSON]] format. The different payload types are identified by a ''%%_type%%'' element. Depending on the app platform, different payload types are supported. OwnTracks publishes its message payloads in [[http://www.json.org/|JSON]] format. The different payload types are identified by a ''%%_type%%'' element. Depending on the app platform, different payload types are supported.
  
-^''%%_type%%''        ^iOS^Android^ +^ ''%%_type%%''  ^ iOS ^ Android ^ 
-|''%%beacon%%''       |Y  |N      +| ''%%beacon%%''  | Y  | N  
-|''%%card%%''         |Y  |Y      +| ''%%card%%''  | Y  | Y  
-|''%%cmd%%''          |Y  |Y      +| ''%%cmd%%''  | Y  | Y  
-|''%%configuration%%''|Y  |Y      +| ''%%configuration%%'' | Y  | Y  
-|''%%encrypted%%''    |Y  |Y      +| ''%%encrypted%%''  | Y  | Y  
-|''%%location%%''     |Y  |Y      +| ''%%location%%''  | Y  | Y  
-|''%%lwt%%''          |Y  |Y      +| ''%%lwt%%''  | Y  | Y  
-|''%%steps%%''        |Y  |N      +| ''%%steps%%''  | Y  | N  
-|''%%transition%%''   |Y  |Y      +| ''%%transition%%''  | Y  | Y  
-|''%%waypoint%%''     |Y  |Y      +| ''%%waypoint%%''  | Y  | Y  
-|''%%waypoints%%''    |Y  |Y      |+| ''%%waypoints%%''  | Y  | Y  |
  
 ==== Data ==== ==== Data ====
Zeile 120: Zeile 110:
 following data could be used for entry/leave events: following data could be used for entry/leave events:
  
-^command^description                                                                                       ^MQTT conversion required^unit   ^Apple^Android^ +^ command ^ description  ^ MQTT conversion required ^ unit  ^ Apple ^ Android ^ 
-|cog    |Course over ground                                                                                                       |degree |**X**|       +| cog  | Course over ground    | degree | **X** |   
-|batt   |Device battery level                                                                                                     |percent|**X**|**X** +| batt  | Device battery level    | percent | **X** | **X**  | 
-|lon    |longitude                                                                                                                |meters |**X**|**X** +| lon  | longitude    | meters | **X** | **X**  | 
-|acc    |Accuracy of the reported location in meters without unit                                                                 |meters |**X**|**X** +| acc  | Accuracy of the reported location in meters without unit    | meters | **X** | **X**  | 
-|p      |barometric pressure                                                                                                      |kPa    |**X**|       +| p  | barometric pressure    | kPa  | **X** |   
-|vel    |velocity                                                                                                                 |km/h   |**X**|       +| vel  | velocity    | km/h  | **X** |   
-|vac    |vertical accuracy of the alt element                                                                                     |meters |**X**|       +| vac  | vertical accuracy of the alt element    | meters | **X** |   
-|lat    |latitude                                                                                                                 |meters |**X**|**X** +| lat  | latitude    | meters | **X** | **X**  | 
-|t      |**p** ping issued randomly by background task                                                     |Yes                           |**X**|**X** +| t  | **p** ping issued randomly by background task  | Yes    | **X** | **X**  | 
-      |**c** circular region enter/leave event                                                           |Yes                           |**X**|**X** +  | **c** circular region enter/leave event  | Yes    | **X** | **X**  | 
-      |**b** beacon region enter/leave event                                                             |Yes                           |**X**|       +  | **b** beacon region enter/leave event  | Yes    | **X** |   
-      |**r** response to a reportLocation cmd message                                                    |Yes                           |**X**|**X** +  | **r** response to a reportLocation cmd message  | Yes    | **X** | **X**  | 
-      |**u** manual publish requested by the user                                                        |Yes                           |**X**|**X** +  | **u** manual publish requested by the user  | Yes    | **X** | **X**  | 
-      |**t** timer based publish in move move                                                            |Yes                           |**X**|       +  | **t** timer based publish in move move  | Yes    | **X** |   
-      |**v** updated by Settings/Privacy/Locations Services/System Services/Frequent Locations monitoring|                              |**X**|       +  | **v** updated by Settings/Privacy/Locations Services/System Services/Frequent Locations monitoring |     | **X** |   
-|conn   |Internet connectivity status (route to host) when the message is created                                                                 +| conn  | Internet connectivity status (route to host) when the message is created          
-      |**w** phone is connected to a WiFi connection                                                     |Yes                           |**X**|**X** +  | **w** phone is connected to a WiFi connection  | Yes    | **X** | **X**  | 
-      |**o** phone is offline                                                                            |Yes                           |**X**|**X** +  | **o** phone is offline  | Yes    | **X** | **X**  | 
-      |**m** mobile data                                                                                 |Yes                           |**X**|**X** +  | **m** mobile data  | Yes    | **X** | **X**  | 
-|tst    |UNIX epoch timestamp in seconds of the location fix                                                                      |epoch  |**X**|**X** +| tst  | UNIX epoch timestamp in seconds of the location fix    | epoch  | **X** | **X**  | 
-|alt    |Altitude measured above sea level                                                                                        |meters |**X**|**X** +| alt  | Altitude measured above sea level    | meters | **X** | **X**  | 
-|tid    |Tracker ID used to display the initials of a user                                                                        |string |**X**|**X** +| tid  | Tracker ID used to display the initials of a user    | string | **X** | **X**  | 
-|enter  |enter/leave region                                                                                |Yes                     |string |**X**|**X**  |+| enter  | enter/leave region  | Yes  | string | **X** | **X**  |
  
 ===== Tracking/Monitoring ===== ===== Tracking/Monitoring =====
Zeile 149: Zeile 139:
 introducing from v0.3.0 onwards the Plugin contains a real Tracking/monitoring feature. All data from Users are captured in a database and visualized with either OpenStreetMap or Google Maps (require a Google Maps API key).  introducing from v0.3.0 onwards the Plugin contains a real Tracking/monitoring feature. All data from Users are captured in a database and visualized with either OpenStreetMap or Google Maps (require a Google Maps API key). 
  
-{{plugins:owntracks:1228539173.png?h=150}}+{{plugins:owntracks:1228539173.png?150}}
  
-{{plugins:owntracks:1228539174.png?h=150}}+{{plugins:owntracks:1228539174.png?150}}
  
-{{plugins:owntracks:1228539172.png?h=250}}+{{plugins:owntracks:1228539172.png?250}}
  
 ===== Roadmap ===== ===== Roadmap =====
Zeile 161: Zeile 151:
 ===== FAQ ===== ===== FAQ =====
  
-https://www.loxforum.com/forum/projektforen/loxberry/plugins/188828-loyberry-owntracks+[[https://www.loxforum.com/forum/projektforen/loxberry/plugins/188828-loyberry-owntracks]] 
  
 ---- struct data ---- ---- struct data ----
Zeile 167: Zeile 158:
 pluginuebersicht.logo : :plugins:owntracks:1228538097.png pluginuebersicht.logo : :plugins:owntracks:1228538097.png
 pluginuebersicht.status : STABLE pluginuebersicht.status : STABLE
-pluginuebersicht.version : 1.0.1 +pluginuebersicht.version : 1.0.3 
-pluginuebersicht.min_lb_version : 1.0 +pluginuebersicht.min_lb_version : 3.0 
-pluginuebersicht.url_release : https://github.com/Liver64/LoxBerry-Owntracks/archive/v1.0.1.zip+pluginuebersicht.url_release : https://github.com/Liver641/LoxBerry-Owntracks/archive/refs/tags/v1.0.3.zip
 pluginuebersicht.url_prerelease :  pluginuebersicht.url_prerelease : 
 pluginuebersicht.description : Owntracks Geo Location for LoxBerry supporting Smartphone Apps for iOS as well as Android. Prerequisite is the MQTT Plugin to pass data to Loxone Miniserver pluginuebersicht.description : Owntracks Geo Location for LoxBerry supporting Smartphone Apps for iOS as well as Android. Prerequisite is the MQTT Plugin to pass data to Loxone Miniserver