Skip to end of metadata
Go to start of metadata
Autor
Logo

Status

STABLE

Versionv1.0.0
Min. LB Version

LB 1.0

Downloadhttps://github.com/Liver64/LoxBerry-Owntracks/archive/v1.0.0.zip
ZweckOwntracks Geo Location for LoxBerry supporting Smartphone Apps for iOS as well as Android. Prerequisite is the MQTT Plugin to pass data to Loxone Miniserver
LanguagesEN, DE
Diskussionhttps://www.loxforum.com/forum/projektforen/loxberry/plugins/188828-loyberry-owntracks
 Version History...

Version 1.0.0

  • initial Version

Version 0.X

  • ....

Content



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.

Download the Apps:

The App's are sending data whether using MQTT or HTTP to the receiver. The Plugin is designed to work only using MQTT mode. In addition the MQTT LoxBerry Pluginis required to be installed to get the data finally into Loxone.

Basically you use the App's to trigger an "enter/leave" event, as many of those GeoLocation Apps can. In addition to that Owntracks deliver quit a lot more of data which could be usefull for your Smart Home like. Batteriestatus of each device, ground speed in case you have an "enter" event and theoratically you can track all your (and other) movements during the day.

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.

Requirements

  1. DnyDNS or static or local IP-Address (DynDNS recommended for security reasons) available This may change in the future to use TLS.
  2. configure Portwording rule for TCP-Port 1883 to xxxx(x) in your Router
  3. installed MQTT Plugin
  4. installed Smartphone App

Configuration

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.

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 

Basic Setup of MQTT Plugin

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: MQTT Gateway There are detailed instructions how to do.

I will focus on adding the owntracks required settings.

Please select the type of data transmission to Miniserver. You can use either HTTP or UDP, How it looks like then in MS you can find under (link to MS)

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

The Owntrack specific settings Topic and necessary conversions will be added from the Owntracks Plugin

Setup Owntracks in iOS

Setup for MQTT Interface

  1. open App configuration file (press button at the top right corner) 
  2. select Owntracks to be installed
  3. Owntracks confirmation
  4. your location
  5. check settings and connect status
  6. check imported settings
  7. test data transfer by clicking on Publish waypoints


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

Setup for HTTP Interface

Currently the HTTP Interface is not supported, it requires a script for further processing.


Setup Owntracks in Android

Due to missing hardware i can't support Android devices

(to be added by User)

philox will provide this within the next few days


Set-up Owntracks in Loxone

Mode "Set virtual inputs via HTTP Webservices (recommended)"

(to be added by User)

Mode "Send data via UDP"

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)

adding virtual UDP input command and the comand recognition:


the basic command recogniation is always "owntracks/loxberry/<DeviceID>/" followed by the type of data you would like to have.

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) 

Data Types

OwnTracks publishes its message payloads in JSON format. The different payload types are identified by a _type element. Depending on the app platform, different payload types are supported.

_typeiOSAndroid
beaconYN
cardYY
cmdYY
configuration

Y

Y
encryptedYY
locationYY
lwtYY
stepsYN
transitionYY
waypointYY
waypointsYY


Data

following data could be used for entry/leave events:

commanddescriptionMQTT conversion requiredunitAppleAndroid
cogCourse over ground
degreeX
battDevice battery level
percentXX
lonlongitude
metersXX
accAccuracy of the reported location in meters without unit
metersXX
pbarometric pressure
kPaX
velvelocity
km/hX
vacvertical accuracy of the alt element
metersX
latlatitude
metersXX
tp ping issued randomly by background taskYes
XX

c circular region enter/leave eventYes
XX

b beacon region enter/leave eventYes
X

r response to a reportLocation cmd messageYes
XX

u manual publish requested by the userYes
XX

t timer based publish in move moveYes
X

v updated by Settings/Privacy/Locations Services/System Services/Frequent Locations monitoring

X
connInternet connectivity status (route to host) when the message is created




w phone is connected to a WiFi connectionYes
XX

o phone is offlineYes
XX

m mobile dataYes
XX
tstUNIX epoch timestamp in seconds of the location fix
epochXX
altAltitude measured above sea level
metersXX
tidTracker ID used to display the initials of a user
stringXX
enterenter/leave regionYesstringXX



Tracking/Monitoring

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). 



Roadmap

  • add-on for Live Tracking of Geo Locations → done

FAQ

https://www.loxforum.com/forum/projektforen/loxberry/plugins/188828-loyberry-owntracks