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.