commit 265686693c07218038ebe0db4e3b7ffa9f0f78c7 Author: Marko Oldenburg Date: Mon Apr 25 11:49:56 2022 +0200 replace type with placeType diff --git a/98_GEOFANCY.pm b/98_GEOFANCY.pm new file mode 100644 index 0000000..7c01cea --- /dev/null +++ b/98_GEOFANCY.pm @@ -0,0 +1,892 @@ +############################################################################### +# $Id$ +package main; +use strict; +use warnings; +use Data::Dumper; +use Time::Local; +use UConv; + +use HttpUtils; +use FHEM::Meta; + +# initialize ################################################################## +sub GEOFANCY_Initialize($) { + my ($hash) = @_; + $hash->{DefFn} = "GEOFANCY_Define"; + $hash->{UndefFn} = "GEOFANCY_Undefine"; + $hash->{SetFn} = "GEOFANCY_Set"; + $hash->{AttrList} = "devAlias disable:0,1 " . $readingFnAttributes; + + return FHEM::Meta::InitMod( __FILE__, $hash ); +} + +# regular Fn ################################################################## +sub GEOFANCY_Define($$) { + my ( $hash, $def ) = @_; + my @a = split( "[ \t]+", $def, 5 ); + + return "Usage: define GEOFANCY " + if ( int(@a) != 3 ); + my $name = $a[0]; + my $infix = $a[2]; + + # Initialize the device + return $@ unless ( FHEM::Meta::SetInternals($hash) ); + + $hash->{fhem}{infix} = $infix; + + GEOFANCY_addExtension( $name, "GEOFANCY_CGI", $infix ); + + readingsBeginUpdate($hash); + readingsBulkUpdate( $hash, "state", "initialized" ); + readingsEndUpdate( $hash, 1 ); + return undef; +} + +sub GEOFANCY_Undefine($$) { + my ( $hash, $name ) = @_; + GEOFANCY_removeExtension( $hash->{fhem}{infix} ); + return undef; +} + +sub GEOFANCY_Set($@) { + my ( $hash, @a ) = @_; + my $name = $hash->{NAME}; + my $state = $hash->{STATE}; + + Log3 $name, 5, "GEOFANCY $name: called function GEOFANCY_Set()"; + + return "No Argument given" if ( !defined( $a[1] ) ); + + my $usage = "Unknown argument " . $a[1] . ", choose one of clear:readings"; + + # clear + if ( $a[1] eq "clear" ) { + Log3 $name, 2, "GEOFANCY set $name " . $a[1]; + + if ( $a[2] ) { + + # readings + if ( $a[2] eq "readings" ) { + delete $hash->{READINGS}; + readingsBeginUpdate($hash); + readingsBulkUpdate( $hash, "state", "clearedReadings" ); + readingsEndUpdate( $hash, 1 ); + } + + } + + else { + return "No Argument given, choose one of readings "; + } + } + + # return usage hint + else { + return $usage; + } + + return undef; +} + +# module Fn #################################################################### +sub GEOFANCY_CGI() { + +# Locative.app (https://itunes.apple.com/us/app/locative/id725198453?mt=8) +# /$infix?device=UUIDdev&id=UUIDloc&latitude=xx.x&longitude=xx.x&trigger=(enter|exit) +# +# Geofency.app (https://itunes.apple.com/us/app/geofency-time-tracking-automatic/id615538630?mt=8) +# /$infix?id=UUIDloc&name=locName&entry=(1|0)&date=DATE&latitude=xx.x&longitude=xx.x&device=UUIDdev +# +# SMART Geofences.app (https://www.microsoft.com/en-us/store/apps/smart-geofences/9nblggh4rk3k) +# /$infix?device=UUIDdev&name=UUIDloc&latitude=xx.x&longitude=xx.x&placeType=(Entered|Leaving)&date=DATE +# + my ($request) = @_; + + my $hash; + my $name = ""; + my $link = ""; + my $URI = ""; + my $device = ""; + my $deviceAlias = "-"; + my $id = ""; + my $lat = ""; + my $long = ""; + my $posLat = ""; + my $posLong = ""; + my $posBeaconUUID = ""; + my $posTravDist = ""; + my $address = "-"; + my $posAddress = "-"; + my $entry = ""; + my $msg = ""; + my $date = ""; + my $time = ""; + my $locName = ""; + my $radius = 0; + my $posDistLoc = ""; + my $posDistHome = ""; + my $locTravDist = ""; + my $motion = ""; + my $wifiSSID = ""; + my $wifiBSSID = ""; + + # data received + if ( $request =~ m,^(\/[^/]+?)(?:\&|\?|\/\?|\/)(.*)?$, ) { + $link = $1; + $URI = $2; + + # get device name + $name = $data{FWEXT}{$link}{deviceName} if ( $data{FWEXT}{$link} ); + + # return error if no such device + return ( "text/plain; charset=utf-8", + "NOK No GEOFANCY device for webhook $link" ) + unless ($name); + + # return error if no such device + return ( "text/plain; charset=utf-8", "NOK disabled" ) + if ( IsDisabled($name) ); + + # extract values from URI + my $webArgs; + foreach my $pv ( split( "&", $URI ) ) { + next if ( $pv eq "" ); + $pv =~ s/\+/ /g; + $pv =~ s/%([\dA-F][\dA-F])/chr(hex($1))/ige; + my ( $p, $v ) = split( "=", $pv, 2 ); + + $webArgs->{$p} = trim($v); + } + + # validate id + # does not exist in "SMART Geofences.app" + return ( "text/plain; charset=utf-8", + "NOK Expected value for 'id' cannot be empty" ) + if ( ( !defined( $webArgs->{id} ) || $webArgs->{id} eq "" ) + && !defined( $webArgs->{placeType} ) ); + + return ( "text/plain; charset=utf-8", + "NOK No whitespace allowed in id '" . $webArgs->{id} . "'" ) + if ( defined( $webArgs->{id} ) && $webArgs->{id} =~ m/(?:\s)/ ); + + # validate locName + return ( "text/plain; charset=utf-8", + "NOK No whitespace allowed in id '" . $webArgs->{locName} . "'" ) + if ( defined( $webArgs->{locName} ) + && $webArgs->{locName} =~ m/(?:\s)/ ); + + # require entry or trigger + return ( "text/plain; charset=utf-8", + "NOK Neither 'entry' nor 'trigger' nor 'placeType' was specified" ) + if ( !defined( $webArgs->{entry} ) + && !defined( $webArgs->{trigger} ) + && !defined( $webArgs->{placeType} ) ); + + # validate entry + return ( "text/plain; charset=utf-8", + "NOK Expected value for 'entry' cannot be empty" ) + if ( defined( $webArgs->{entry} ) && $webArgs->{entry} eq "" ); + + return ( "text/plain; charset=utf-8", + "NOK Value for 'entry' can only be: 1 0" ) + if ( defined( $webArgs->{entry} ) + && $webArgs->{entry} ne 0 + && $webArgs->{entry} ne 1 ); + + # validate trigger + return ( "text/plain; charset=utf-8", + "NOK Expected value for 'trigger' cannot be empty" ) + if ( defined( $webArgs->{trigger} ) && $webArgs->{trigger} eq "" ); + + return ( "text/plain; charset=utf-8", + "NOK Value for 'trigger' can only be: enter|test exit" ) + if ( defined( $webArgs->{trigger} ) + && $webArgs->{trigger} ne "enter" + && $webArgs->{trigger} ne "test" + && $webArgs->{trigger} ne "exit" ); + + # validate placeType + return ( "text/plain; charset=utf-8", + "NOK Expected value for 'placeType' cannot be empty" ) + if ( defined( $webArgs->{placeType} ) && $webArgs->{placeType} eq "" ); + + return ( "text/plain; charset=utf-8", + "NOK Value for 'placeType' can only be: Entered Leaving" ) + if ( defined( $webArgs->{placeType} ) + && lc( $webArgs->{placeType} ) ne "entered" + && lc( $webArgs->{placeType} ) ne "leaving" ); + + # validate date + return ( + "text/plain; charset=utf-8", + "NOK Specified date '" + . $webArgs->{date} . "'" + . " does not match ISO8601 UTC format (1970-01-01T00:00:00Z)" + ) + if ( defined( $webArgs->{date} ) + && $webArgs->{date} !~ +m/(19|20)\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]\.?[0-9]*)Z/ + ); + + # validate timestamp + return ( + "text/plain; charset=utf-8", + "NOK Specified timestamp '" + . $webArgs->{timestamp} . "'" + . " does not seem to be a valid Unix timestamp" + ) + if ( + defined( $webArgs->{timestamp} ) + && ( $webArgs->{timestamp} !~ m/^\d+(\.\d+)?$/ + || $webArgs->{timestamp} > time() + 300 ) + ); + + # validate locName + return ( "text/plain; charset=utf-8", + "NOK No whitespace allowed in id '" . $webArgs->{locName} . "'" ) + if ( defined( $webArgs->{locName} ) + && $webArgs->{locName} =~ m/(?:\s)/ ); + + # validate LAT + return ( + "text/plain; charset=utf-8", + "NOK Specified latitude '" + . $webArgs->{latitude} + . "' has unexpected format" + ) + if ( + defined $webArgs->{latitude} + && ( $webArgs->{latitude} !~ m/^-?\d+(\.\d+)?$/ + || $webArgs->{latitude} < -90 + || $webArgs->{latitude} > 90 ) + ); + + # validate LONG + return ( + "text/plain; charset=utf-8", + "NOK Specified longitude '" + . $webArgs->{longitude} + . "' has unexpected format" + ) + if ( + defined $webArgs->{longitude} + && ( $webArgs->{longitude} !~ m/^-?\d+(\.\d+)?$/ + || $webArgs->{longitude} < -180 + || $webArgs->{longitude} > 180 ) + ); + + # validate posLAT + return ( + "text/plain; charset=utf-8", + "NOK Specified latitude '" + . $webArgs->{currentLatitude} + . "' has unexpected format" + ) + if ( + defined $webArgs->{currentLatitude} + && ( $webArgs->{currentLatitude} !~ m/^-?\d+(\.\d+)?$/ + || $webArgs->{currentLatitude} < -90 + || $webArgs->{currentLatitude} > 90 ) + ); + + # validate posLONG + return ( + "text/plain; charset=utf-8", + "NOK Specified longitude '" + . $webArgs->{currentLongitude} + . "' has unexpected format" + ) + if ( + defined $webArgs->{currentLongitude} + && ( $webArgs->{currentLongitude} !~ m/^-?\d+(\.\d+)?$/ + || $webArgs->{currentLongitude} < -180 + || $webArgs->{currentLongitude} > 180 ) + ); + + # validate device + return ( "text/plain; charset=utf-8", + "NOK Expected value for 'device' cannot be empty" ) + if ( !defined( $webArgs->{device} ) || $webArgs->{device} eq "" ); + + return ( + "text/plain; charset=utf-8", + "NOK No whitespace allowed in device '" . $webArgs->{device} . "'" + ) + if ( defined( $webArgs->{device} ) + && $webArgs->{device} =~ m/(?:\s)/ ); + + # validate motion + if ( defined( $webArgs->{motion} ) ) { + my @motions = ( + "unknown", "stationary", "walking", "running", + "automotive", "cycling" + ); + my $motionLc = lc( $webArgs->{motion} ); + return ( "text/plain; charset=utf-8", + "NOK Unknown motion placeType '" . $webArgs->{motion} . "'" ) + if ( !grep( /^$motionLc$/, @motions ) ); + } + + # Locative.app + if ( defined $webArgs->{trigger} ) { + Log3 $name, 5, "GEOFANCY $name: detected data format: Locative.app"; + $id = $webArgs->{id}; + $entry = $webArgs->{trigger}; + $lat = $webArgs->{latitude}; + $long = $webArgs->{longitude}; + $device = $webArgs->{device}; + $posLat = $lat; + $posLong = $long; + + if ( defined( $webArgs->{timestamp} ) ) { + my ( $sec, $min, $hour, $d, $m, $y ) = + localtime( $webArgs->{timestamp} ); + $date = timelocal( $sec, $min, $hour, $d, $m, $y ); + } + } + + # Geofency.app + elsif ( defined $webArgs->{entry} ) { + Log3 $name, 5, "GEOFANCY $name: detected data format: Geofency.app"; + $id = $webArgs->{id}; + $locName = $webArgs->{name}; + $entry = $webArgs->{entry}; + $date = GEOFANCY_ISO8601UTCtoLocal( $webArgs->{date} ); + $lat = $webArgs->{latitude}; + $long = $webArgs->{longitude}; + $radius = $webArgs->{radius} + if ( defined( $webArgs->{radius} ) ); + $address = $webArgs->{address} + if ( defined( $webArgs->{address} ) ); + $device = $webArgs->{device}; + $motion = $webArgs->{motion} + if ( defined( $webArgs->{motion} ) ); + $wifiSSID = $webArgs->{wifiSSID} + if ( defined( $webArgs->{wifiSSID} ) ); + $wifiBSSID = $webArgs->{wifiBSSID} + if ( defined( $webArgs->{wifiBSSID} ) ); + $posBeaconUUID = $webArgs->{beaconUUID} + if ( defined( $webArgs->{beaconUUID} ) ); + + if ( + !defined( $webArgs->{currentLatitude} ) + || !defined( $webArgs->{currentLongitude} ) + || ( $webArgs->{currentLatitude} == 0 + && $webArgs->{currentLongitude} == 0 ) + ) + { + $posLat = $webArgs->{latitude}; + $posLong = $webArgs->{longitude}; + $posAddress = $address; + } + else { + $posLat = $webArgs->{currentLatitude}; + $posLong = $webArgs->{currentLongitude}; + $posAddress = $address if ( $posBeaconUUID ne "" ); + } + } + + # SMART Geofences.app + elsif ( defined $webArgs->{placeType} ) { + Log3 $name, 5, + "GEOFANCY $name: detected data format: SMART Geofences.app"; + $id = $webArgs->{name}; + $locName = $webArgs->{name}; + $entry = $webArgs->{placeType}; + $date = GEOFANCY_ISO8601UTCtoLocal( $webArgs->{date} ); + $lat = $webArgs->{latitude}; + $long = $webArgs->{longitude}; + $address = $webArgs->{address} + if ( defined( $webArgs->{address} ) ); + $device = $webArgs->{device}; + $posLat = $lat; + $posLong = $long; + $posAddress = $address; + } + else { + return "fatal error"; + } + } + + # no data received + else { + Log3 undef, 5, "GEOFANCY: No data received"; + + return ( "text/plain; charset=utf-8", "NOK No data received" ); + } + + # return error if unknown trigger + return ( "text/plain; charset=utf-8", "$entry NOK" ) + if ( lc($entry) ne "enter" + && lc($entry) ne "1" + && lc($entry) ne "exit" + && lc($entry) ne "0" + && lc($entry) ne "test" + && lc($entry) ne "entered" + && lc($entry) ne "leaving" ); + + $hash = $defs{$name}; + + # update ROOMMATE devices associated with this device UUID + my $matchingResident = 0; + delete $hash->{ROOMMATES}; + foreach my $gdev ( devspec2array("rr_geofenceUUIDs=.+") ) { + next unless ( IsDevice( $gdev, "ROOMMATE" ) ); + Log3 $name, 5, "GEOFANCY $name: Checking rr_geofenceUUIDs for $gdev"; + my $geofenceUUIDs = AttrVal( $gdev, "rr_geofenceUUIDs", undef ); + + $hash->{ROOMMATES} .= ",$gdev" if $hash->{ROOMMATES}; + $hash->{ROOMMATES} = $gdev if !$hash->{ROOMMATES}; + + my @UUIDs = split( ',', $geofenceUUIDs ); + if (@UUIDs) { + foreach (@UUIDs) { + if ( $_ eq $device ) { + Log3 $name, 4, + "GEOFANCY $name: " + . "Found matching UUID at ROOMMATE device $gdev"; + $deviceAlias = $gdev; + $matchingResident = 1; + last; + } + } + } + } + + # update GUEST devices associated with this device UUID + delete $hash->{GUESTS}; + foreach my $gdev ( devspec2array("rg_geofenceUUIDs=.+") ) { + next unless ( IsDevice( $gdev, "GUEST" ) ); + Log3 $name, 5, "GEOFANCY $name: Checking rg_geofenceUUIDs for $gdev"; + my $geofenceUUIDs = AttrVal( $gdev, "rg_geofenceUUIDs", undef ); + + $hash->{GUESTS} .= ",$gdev" if $hash->{GUESTS}; + $hash->{GUESTS} = $gdev if !$hash->{GUESTS}; + + my @UUIDs = split( ',', $geofenceUUIDs ); + if (@UUIDs) { + foreach (@UUIDs) { + if ( $_ eq $device ) { + Log3 $name, 4, + "GEOFANCY $name: " + . "Found matching UUID at GUESTS device $gdev"; + $deviceAlias = $gdev; + $matchingResident = 1; + last; + } + } + } + } + + # Device alias handling + # + delete $hash->{helper}{device_aliases} + if $hash->{helper}{device_aliases}; + delete $hash->{helper}{device_names} + if $hash->{helper}{device_names}; + + my @devices = split( ' ', AttrVal( $name, "devAlias", "" ) ); + foreach (@devices) { + my @device = split( ':', $_ ); + $hash->{helper}{device_aliases}{ $device[0] } = + $device[1]; + $hash->{helper}{device_names}{ $device[1] } = + $device[0]; + } + + $deviceAlias = $hash->{helper}{device_aliases}{$device} + if ( $hash->{helper}{device_aliases}{$device} + && $matchingResident == 0 ); + + Log3 $name, 4, +"GEOFANCY $name: id=$id name=$locName trig=$entry date=$date lat=$lat long=$long posLat=$posLat posLong=$posLong address:$address dev=$device devAlias=$deviceAlias motion=$motion wifiSSID=$wifiSSID wifiBSSID=$wifiBSSID"; + + Log3 $name, 3, +"GEOFANCY $name: Unknown device UUID $device: Set attribute devAlias for $name or assign $device to any ROOMMATE or GUEST device using attribute r*_geofenceUUIDs" + if ( $deviceAlias eq "-" ); + + # distance between home and position + my $homeLat = AttrVal( "global", "latitude", undef ); + my $homeLong = AttrVal( "global", "longitude", undef ); + if ( $homeLat && $homeLong ) { + if ( $posLat ne "" && $posLong ne "" ) { + $posDistHome = + UConv::distance( $posLat, $posLong, $homeLat, $homeLong, 2 ); + } + elsif ( $lat ne "" && $long ne "" ) { + $posDistHome = + UConv::distance( $lat, $long, $homeLat, $homeLong, 2 ); + } + } + + # distance between location and position + if ( $lat ne "" && $long ne "" && $posLat ne "" && $posLong ne "" ) { + $posDistLoc = UConv::distance( $posLat, $posLong, $lat, $long, 2 ); + } + + # travelled distance for location + if ( $lat ne "" && $long ne "" ) { + my $locLatVal = ReadingsVal( $name, "currLocLat_" . $deviceAlias, "-" ); + $locLatVal = ReadingsVal( $name, "lastLocLat_" . $deviceAlias, "-" ) + if ( $locLatVal eq "-" ); + my $locLongVal = + ReadingsVal( $name, "currLocLong_" . $deviceAlias, "-" ); + $locLongVal = ReadingsVal( $name, "lastLocLong_" . $deviceAlias, "-" ) + if ( $locLongVal eq "-" ); + + if ( $locLatVal ne "-" && $locLongVal ne "-" ) { + $locTravDist = + UConv::distance( $lat, $long, $locLatVal, $locLongVal, 2 ); + } + } + + # travelled distance for position + if ( $posLat ne "" && $posLong ne "" ) { + my $currPosLatVal = + ReadingsVal( $name, "currPosLat_" . $deviceAlias, "" ); + my $currPosLongVal = + ReadingsVal( $name, "currPosLong_" . $deviceAlias, "" ); + + if ( $currPosLatVal ne "" && $currPosLongVal ne "" ) { + $posTravDist = UConv::distance( $posLat, $posLong, $currPosLatVal, + $currPosLongVal, 2 ); + } + } + + readingsBeginUpdate($hash); + + # use date for readings + if ( $date ne "" ) { + $hash->{".updateTime"} = $date; + $hash->{".updateTimestamp"} = FmtDateTime( $hash->{".updateTime"} ); + $time = $hash->{".updateTimestamp"}; + } + + # use local FHEM time + else { + $time = TimeNow(); + } + + # General readings + readingsBulkUpdate( $hash, "state", +"id:$id trig:$entry date:$date lat:$lat long:$long dev:$device devAlias=$deviceAlias" + ); + readingsBulkUpdate( $hash, "lastDeviceUUID", $device ); + readingsBulkUpdate( $hash, "lastDevice", $deviceAlias ); + + if ( $deviceAlias ne "-" ) { + + $id = $locName if ( defined($locName) && $locName ne "" ); + + readingsBulkUpdate( $hash, "lastArr", $deviceAlias . " " . $id ) + if ( lc($entry) eq "enter" + || lc($entry) eq "1" + || lc($entry) eq "entered" ); + readingsBulkUpdate( $hash, "lastDep", $deviceAlias . " " . $id ) + if ( lc($entry) eq "exit" + || lc($entry) eq "0" + || lc($entry) eq "leaving" ); + + my $currReading; + my $lastReading; + my $currVal; + + # backup last known position + $currReading = "currPosTime_" . $deviceAlias; + $currVal = ReadingsVal( $name, $currReading, undef ); + readingsBulkUpdate( $hash, "lastPosArr_" . $deviceAlias, $currVal ); + if ($currVal) { + readingsBulkUpdate( $hash, "lastPosDep_" . $deviceAlias, $time ); + readingsBulkUpdate( + $hash, + "lastPosDur_" . $deviceAlias, + UConv::duration( $time, $currVal, "sec" ) + ); + + } + + foreach ( + 'PosSSID', 'PosBSSID', 'PosMotion', 'PosLat', + 'PosLong', 'PosAddr', 'PosBeaconUUID', 'PosDistHome', + 'PosDistLoc', 'PosTravDist', 'LocTravDist', 'LocRadius' + ) + { + $currReading = "curr" . $_ . "_" . $deviceAlias; + $lastReading = "last" . $_ . "_" . $deviceAlias; + $currVal = ReadingsVal( $name, $currReading, undef ); + readingsBulkUpdate( $hash, $lastReading, $currVal ) + if ( defined($currVal) ); + } + + readingsBulkUpdate( $hash, "currPosSSID_" . $deviceAlias, $wifiSSID ); + readingsBulkUpdate( $hash, "currPosBSSID_" . $deviceAlias, $wifiBSSID ); + readingsBulkUpdate( $hash, "currPosMotion_" . $deviceAlias, $motion ); + readingsBulkUpdate( $hash, "currPosBeaconUUID_" . $deviceAlias, + $posBeaconUUID ); + readingsBulkUpdate( $hash, "currPosLat_" . $deviceAlias, $posLat ); + readingsBulkUpdate( $hash, "currPosLong_" . $deviceAlias, $posLong ); + readingsBulkUpdate( $hash, "currPosAddr_" . $deviceAlias, $posAddress ); + readingsBulkUpdate( $hash, "currPosTime_" . $deviceAlias, $time ); + readingsBulkUpdate( $hash, "currPosDistHome_" . $deviceAlias, + $posDistHome ); + readingsBulkUpdate( $hash, "currPosDistLoc_" . $deviceAlias, + $posDistLoc ); + readingsBulkUpdate( $hash, "currLocTravDist_" . $deviceAlias, + $locTravDist ); + readingsBulkUpdate( $hash, "currPosTravDist_" . $deviceAlias, + $posTravDist ); + + readingsBulkUpdate( $hash, "currLocRadius_" . $deviceAlias, $radius ); + + if ( lc($entry) eq "enter" + || lc($entry) eq "1" + || lc($entry) eq "entered" + || lc($entry) eq "test" ) + { + Log3 $name, 4, "GEOFANCY $name: $deviceAlias arrived at $id"; + readingsBulkUpdate( $hash, $deviceAlias, "arrived " . $id ); + readingsBulkUpdate( $hash, "currLoc_" . $deviceAlias, $id ); + readingsBulkUpdate( $hash, "currLocLat_" . $deviceAlias, $lat ); + readingsBulkUpdate( $hash, "currLocLong_" . $deviceAlias, $long ); + readingsBulkUpdate( $hash, "currLocAddr_" . $deviceAlias, + $address ); + readingsBulkUpdate( $hash, "currLocTime_" . $deviceAlias, $time ); + } + elsif (lc($entry) eq "exit" + || lc($entry) eq "0" + || lc($entry) eq "leaving" ) + { + Log3 $name, 4, + "GEOFANCY $name: $deviceAlias left $id and is in transit"; + + # backup last known location if not "underway" + $currReading = "currLocTime_" . $deviceAlias; + $currVal = ReadingsVal( $name, $currReading, undef ); + if ( $currVal && $currVal ne "underway" ) { + readingsBulkUpdate( $hash, "lastLocArr_" . $deviceAlias, + $currVal ); + readingsBulkUpdate( $hash, "lastLocDep_" . $deviceAlias, + $time ); + readingsBulkUpdate( + $hash, + "lastLocDur_" . $deviceAlias, + UConv::duration( $time, $currVal, "sec" ) + ); + + foreach ( 'Loc', 'LocLat', 'LocLong', 'LocAddr' ) { + $currReading = "curr" . $_ . "_" . $deviceAlias; + $lastReading = "last" . $_ . "_" . $deviceAlias; + $currVal = ReadingsVal( $name, $currReading, "" ); + $currVal = ReadingsVal( $name, $lastReading, "" ) + if ( $currVal eq "-" || $currVal eq "" ); + readingsBulkUpdate( $hash, $lastReading, $currVal ); + } + } + + readingsBulkUpdate( $hash, $deviceAlias, "left " . $id ); + readingsBulkUpdate( $hash, "currLoc_" . $deviceAlias, "underway" ); + readingsBulkUpdate( $hash, "currLocLat_" . $deviceAlias, "-" ); + readingsBulkUpdate( $hash, "currLocLong_" . $deviceAlias, "-" ); + readingsBulkUpdate( $hash, "currLocAddr_" . $deviceAlias, "-" ); + readingsBulkUpdate( $hash, "currLocTime_" . $deviceAlias, $time ); + } + } + + readingsEndUpdate( $hash, 1 ); + + # trigger update of resident device readings + if ( $matchingResident == 1 ) { + my $trigger = 0; + $trigger = 1 + if ( lc($entry) eq "enter" + || lc($entry) eq "1" + || lc($entry) eq "entered" + || lc($entry) eq "test" ); + $locName = $id if ( $locName eq "" ); + + RESIDENTStk_SetLocation( + $deviceAlias, $locName, $trigger, $id, + $time, $lat, $long, $address, + $device, $radius, $posLat, $posLong, + $posAddress, $posBeaconUUID, $posDistHome, $posDistLoc, + $motion, $wifiSSID, $wifiBSSID + ) if ( IsDevice( $deviceAlias, "ROOMMATE|GUEST" ) ); + } + + $msg = lc($entry) . " OK"; + $msg .= "\ndevice=$device id=$id lat=$lat long=$long trig=lc($entry)" + if ( lc($entry) eq "test" ); + + return ( "text/plain; charset=utf-8", $msg ); +} + +sub GEOFANCY_addExtension($$$) { + my ( $name, $func, $link ) = @_; + + my $url = "/$link"; + Log3 $name, 2, "Registering GEOFANCY $name for URL $url..."; + $data{FWEXT}{$url}{deviceName} = $name; + $data{FWEXT}{$url}{FUNC} = $func; + $data{FWEXT}{$url}{LINK} = $link; +} + +sub GEOFANCY_removeExtension($) { + my ($link) = @_; + + my $url = "/$link"; + my $name = $data{FWEXT}{$url}{deviceName}; + Log3 $name, 2, "Unregistering GEOFANCY $name for URL $url..."; + delete $data{FWEXT}{$url}; +} + +sub GEOFANCY_ISO8601UTCtoLocal ($) { + my ($datetime) = @_; + $datetime =~ s/T/ /g if ( defined( $datetime && $datetime ne "" ) ); + $datetime =~ s/Z//g if ( defined( $datetime && $datetime ne "" ) ); + + my ( + $date, $time, $y, $m, $d, $hour, + $min, $sec, $hours, $minutes, $seconds, $timestamp + ); + + ( $date, $time ) = split( ' ', $datetime ); + ( $y, $m, $d ) = split( '-', $date ); + ( $hour, $min, $sec ) = split( ':', $time ); + $m -= 01; + $timestamp = timegm( $sec, $min, $hour, $d, $m, $y ); + ( $sec, $min, $hour, $d, $m, $y ) = localtime($timestamp); + $timestamp = timelocal( $sec, $min, $hour, $d, $m, $y ); + + return $timestamp; +} + +1; + +=pod +=item helper +=item summary Geofencing for specific iOS, Android or Windows 10 apps +=item summary_DE Geofencing für spezielle iOS, Android und Windows 10 Apps +=begin html + +

+ +

+

+ GEOFANCY +

+
    +
  • Provides a webhook receiver for geofencing, e.g. via the following apps:
    +
    +
    • +
  • + Geofency (iOS) +
    • +
  • + Locative (iOS) +
    • +
  • + EgiGeoZone (Android) +
    • +
  • + SMART Geofences (Windows 10, Windows 10 Mobile) +
    • +
  • +

    + Note: GEOFANCY is an extension to FHEMWEB. You need to install FHEMWEB to use GEOFANCY. +

    Define +
      + define <name> GEOFANCY <infix>
      +
      + Defines the webhook server. <infix> is the portion behind the FHEMWEB base URL (usually http://hostname:8083/fhem)
      +
      + Example: +
        + define geofancy GEOFANCY geo
        +

      + The webhook will be reachable at http://hostname:8083/fhem/geo in that case.
      +
      +
    Set +
      +
    • + clear   readings   can be used to cleanup auto-created readings from deprecated devices. +
      • +

    +
    + Attributes
    +
    +
      +
    • devAlias: Mandatory attribute to assign device name alias to an UUID in the format DEVICEUUID:Aliasname (most readings will only be created if devAlias was defined).
      + Separate using blank to rename multiple device UUIDs.
      +
      + Should you be using GEOFANCY together with ROOMMATE or GUEST you might consider using attribute r*_geofenceUUIDs directly at those devices instead. +
      • +

    +
    + Usage information / Hints on Security
    +
    +
      + Likely your FHEM installation is not reachable directly from the internet (good idea!).
      + It is recommended to have a reverse proxy like HAproxy, Pound or Varnish in front of FHEM where you can make sure access is only possible to a specific URI like /fhem/geo. Apache or Nginx might do as well. However, in case you have Apache or Nginx running already you should still consider one of the named reverse proxies in front of it for fine-grain security configuration.
      +
      + You might also want to think about protecting the access by using HTTP Basic Authentication and encryption via TLS/SSL. Using TLS offloading in the reverse proxy software is highly recommended and software like HAproxy provides high control of data flow for TLS.
      +
      + Also the definition of a dedicated FHEMWEB instance for that purpose together with allowed might help to restrict FHEM's functionality (e.g. set attributes allowedCommands and allowedDevices to ",". Note that attributes hiddengroup and hiddenroom of FHEMWEB do NOT protect from just guessing/knowing the correct URI but would help tremendously to prevent easy inspection of your FHEM setup.)
      +
      + To make that reverse proxy available from the internet, just forward the appropriate port via your internet router.
      +
      + The actual solution on how you can securely make your GEOFANCY webhook available to the internet is not part of this documentation and depends on your own skills. +

    +
    + Integration with Home Automation
    +
    +
      + You might want to have a look to the module family of ROOMMATE, GUEST and RESIDENTS for an easy processing of GEOFANCY events. +
    +
    • +
+ +=end html + +=begin html_DE + +

+ +

+

+ GEOFANCY +

+
    + Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden: +
+ + +=end html_DE + +=for :application/json;q=META.json 98_GEOFANCY.pm +{ + "author": [ + "Julian Pawlowski " + ], + "x_fhem_maintainer": [ + "loredo" + ], + "x_fhem_maintainer_github": [ + "jpawlowski" + ], + "keywords": [ + "Geofencing", + "Geofency", + "Locative", + "EgiGeoZone", + "Location", + "Presence", + "Tracking" + ] +} +=end :application/json;q=META.json + +=cut