FHEM

Description

fhem is used to automate some common tasks in the household like switching lamps/shutters/heating/etc. and to log events like temperature/humidity/power consumption.

The program runs as a server, you can control it via telnet, command line program or TCP/IP directly, like the supplied web frontends do.

Currently implemented features:

• Via the FHZ module (with access to one or more FHZ1000/FHZ1300 device):
  • reading and sending FS20 events (on/off/dimming, timer commands)
  • support of FS20 address features function group, local and global master
  • reading and changing FHT80b parameters (temp, actuator, etc).
    The FHT8b seems to work too. Note: the FHT8 wont work.
    Internal software buffer to prevent lost commands.
  • reading HMS data (HMS100-T,-TF,-WD,-MG,-TFK,-CO,-FIT and RM100-2)
  • reading KS300 data
  Note: The FHZ1350 WLAN is probably not working due to a prorietary encryption.
• Via the CM11 module (with access to a X10 computer interface):
  • reading all X10 events
  • sending X10 events (on/off/dimming)
  • timed on/off switching support
• Via the CUL module (see www.busware.de ) access to the following protocols:
  
  • FS20 (Receive/Send, all devices)
  • EM (EM1000EM/EM1000GZ/EM1000WZ)
  • FHT (Receive/Send)
  • HMS (Receive)
  • S300 (KS300, S300TH, S555TH, etc)
• reading WS300 data, and up to 9 attached devices
• reading EM1000WZ/EM1000EM/EM1000GZ data via an attached EM1010PC
• reading attached SCIVT devices
• reading attached M232 devices
• reading attached WS2000/WS25000 devices, also via raw network converters(xport)
• extract sensor data from IPWE networked weather data receiver
• logging events to files or databases, with regexp filters
• notifying external programs or internal modules when receiving certain events
• timed commands (e.g. switching a lamp on from sunset till midnight)
• watchdog (e.g. trigger if the HMS100-FIT is inactive for HH:MM:SS)
• modular architecture, easy to add your special device
• different web frontends, choose your favorite


See HOWTO.html, commandref.html and faq.html for more documentation, and contrib/README for other extensions.

Links:

Homepage: http://www.koeniglich.de/fhem/fhem.html
Download: http://www.koeniglich.de/fhem/fhem-=VERS=.tar.gz
FAQ: http://www.koeniglich.de/fhem/faq.html
Google-Group: http://groups.google.com/group/fhem-users
Martins Web frontend (webpgm3): http://www.martin-haas.de/fhz
Another Martins Web frontend (myHCE): http://www.fischer-net.de/projekte/haustechnik/myhce.html
Frontend for the iPhone: http://www.gschaden.com/wp/2009/01/18/fhem-iphone-gateway/
CVS@berlios: http://developer.berlios.de/projects/fhem
LinViex (home automation frontend): http://sourceforge.net/projects/linviex
Protocol descriptions and other useful stuff: http://fhz4linux.info/
CUL: Hardware shop, firmware homepage, CUL fans google group

Device/OS Specific installation guides:

• Linux driver installation: http://www.koeniglich.de/fhem/linux.html
• Windows driver installation: http://fhz4linux.info/tiki-index.php?page=Driver%20installation
  (use "Solution B", only COM1..COM9 is supported)
• Instructions for Nas/Routers (NSLU2): http://www.martin-haas.de/fhz/nslu2fhz
• Instructions for the Fritz!Box: http://www.koeniglich.de/fhem/fritzbox.html
• Instructions for the Allnet all6250: http://wiki.dungeon.de/all6250_opennas_mit_fhem
Commercial products:
• Integration of FHZ and NAS running FHEM. Using an enhanced transmitter to achieve more distant transmission. Full integrated solution for Home-Control and beyond (other service like UPS management, etc. are also available).
  http://www.dhs-computertechnik.de/

Installation

Perl modules

You need perl >=5.6, on Unix with the Device::SerialPort ( http://search.cpan.org/dist/Device-SerialPort/), on Windows Win32::SerialPort (use ActiveState's ActivePerl) module. If this module reports Can't call method "opened" on an undefined value... when starting the server, then you either may ignore this message, or replace the mentioned line with:

    $self->{HANDLE}->close if (defined($self->{HANDLE}) &&
    	                       $self->{HANDLE}->opened);

Server installation on Unix

• Check the Makefile for the installation path, then type make install.
• Create a configuration file (see the examples directory or docs/commandref.html).
• Start the server with fhem.pl <configfile>

Server installation on Windows

If you are using cygwin for your perl installation you can follow the guidelines for Unix.
• Be sure you have perl.exe in your path (%PATH%)
• Make sure that you can access the serial USB device via virtual COM-Port or via socket(e.g. COMX or xport:10001).
• Create a configuration file (see the examples directory and docs/commandref.html)
• Start the server with fhem.pl <configfile>

General notes for webfrontends:

• You don't have to install all of them, one is probably more than enough :-)
• The numbering has historical reasons: not actively maintained versions are not described here
• Important: Make sure you add some protection (.htaccess, etc) else everybody will be able to set your devices

Web frontend 2 (webfrontend/pgm2)

This frontend is a FHEM module implementing a HTTP server, no further programs are needed. It has support for grouping devices into rooms, manipulating devices, direct fhem commands, displaying logfiles as text or plot (SVG builtin or PNG by gnuplot), navigating/zooming in the plots.
Screenshots: overview, detail, SVG-plots.

Installation: make install-pgm2 && perl fhem.pl
This will start fhem.pl with a minimalistic configuration. Connect to fhem via http://localhost:8083/fhem. See the Howto there on how to continue.

Web frontend 3 (webfrontend/pgm3)

This frontend is PHP based and was contributed by Martin Haas. Look at the webfrontends/pgm3/docs for more documentation or at this screenshot. A lot more details and screenshots can be found on Martins page: http://www.martin-haas.de/fhz


• Install PHP5 and enable it by commenting in the "LoadModule phpX_module ..." directive in httpd.conf (perhaps it is already done by your distro). Restart/reload httpd.
• Create a directory (e.g.: /home/httpd/html/pgm3) and copy all the files from the webfrontend/pgm3 to this directory.
  Make sure that this directory is writeable by the webserver!
• Make sure that php-gd is installed.
• Edit config.php (/home/httpd/html/pgm3/config.php), and check the required settings section
• If you want to have access to the FHT temperature logs, then:
  • Make sure gnuplot is installed
• Call <your-site>/pgm3/index.php



Web frontend 5 (webfrontend/pgm5)

This frontend is CGI/CSS based. It has support for rooms, and FHT/KS300 logs. This webfrontend is an update of the former know pgm2 (up to 4.2): It resides in YOUR HTTP server, and doesn't provide an own, like the FHEMWEB module does.

Why to use this:
1) If you want to stick with your Web-Servers (due to restrictions, ports or any other reason)
2) If you have a NAS (Network attached storage) and limited CPU-Power. This frontend can render the graphics in the background (in intervals) and sends only the rendered graphics to the HTML-Page.
3) If you need the FHEMRENDERER to render the images for other/own pages.

A lot more details can be found on Olaf Droegehorns page: http://www.droegehorn.de/fhz

Installation:
• Copy the file fhemweb.pl and *.css to your cgi-bin directory (/home/httpd/cgi-bin), the icons (*.gif) to your httpd icons (/home/httpd/icons), and commandref.html to the html directory (/home/httpd/html) (or also to cgi-bin directory).
  Note: The program looks for icons in the following order:
  'device-name.state', 'device-name', 'device-type.state', 'device-type'
• The *.gplot files should be reused from the built-in FHEMWEB and should reside in the installed FHEM directory. Here we don't provide specific *.gplot files as the mechanisms are exactly the same.
• If you want to have access to plotted logs, then make sure that gnuplot is installed and set the logtype for the FileLog device (see commandref.html and example/04_log). Copy the file contrib/99_weblink.pm to the installed FHEM directory.
• Copy the file pgm5/02_FHEMRENDERER.pm to the installed FHEM directory. This gives you a graphic rendering engine (gnuplot & gnuplot-scroll at the moment), which can be configured to renderer images in intervals.
• Call 'your-site'/cgi-bin/fhemweb.pl

License:

Copyright:

• Rudolf Koenig (r dot koenig at koeniglich dot de)
• Raoul Matthiessen (webfrontends/pgm1)
• Martin Haas (webfrontends/pgm3)
• Olaf Droegehorn (webfrontends/pgm5)
License: GPL (v2)
Thanks to TOSTi for inspiration and numerous other people for help.