FHEM

News (as of =DATE=, Version =VERS=)

• feature: added ELV IPWE-Support via 88_IPWE.pm (thomas 18.05.08)
• feature: added windows COM-Port support to FHZ, EM,WS2000,WS300 (thomas 12.05.08)
• feature: added ReadyFn to have an alternate methode to check if data available(thomas 11.05.08)
• feature: added ws2000 support via 87_WS2000.pm(thomas 10.05.08)
• feature: added archivedir/archivecmd to the the main logfile
• feature: 99_Sunrise_EL.pm (does not need any Date modules)
• bugfix: seldom xmllist error resulting in corrupt xml (Martin/Peter, 4.9)
• bugfix: FHT mode holiday_short added (9.9, Dirk)
• bugfix: Modifying a device from its own trigger crashes (Klaus, 10.9)
• feature: webpgm2 output reformatted
• feature: webpgm2 displaying multiple plots
• feature: FHT lime-protection code discovered by Dirk (7.10)
• feature: softwarebuffer for FHT devices (Dirk 17.10)
• feature: FHT low temperatur warning and offset (Dirk 17.10)
• change: change FHT state into warnings (Dirk 17.10)
  NOTE: you'll get an undefined type state & undefined type unknown_85 message after upgrade, this will disappear at the second start.
• feature: Softwarebuffer code simplified (Rudi 22.11)
• bugfix: bug #12327 doppeltes my
• bugfix: set STATE from trigger
• bugfix: readings state vs STATE problem (xmllist/trigger)
• change: SUNRISE doc changed (99_SUNRISE.pm -> 99_SUNRISE_EL.pm)
• feature: support for the M232 ELV device (Boris, 25.11)
• feature: alternativ Quad-based numbers for the FS20 (Matthias, 24.11)
• feature: dummy type added (contrib/99_dummy.pm)
• feature: added database logging facility (93_DbLog.pm) (Boris, 29.12)
• feature: support for %NAME, %EVENT, %TYPE parameters in notify definition (Boris, 29.12)
• bugfix: 62_EMEM.pm: energy_total_kWh renamed to energy_kWh_w, energy_kWh added (Boris, 6.1)

Description

This program makes the FHZ1000/FHZ1300/WS300 and other USB devices sold by ELV, Conrad and others useable with Linux. In fact, there is nothing Linux special in it, you should be able to use it on other platforms as long as you can access the hardware as a serial device.
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 and RM100-2)
  • reading KS300 data
  Note:The FHZ1350 WLAN is probably not working due to a prorietary encryption.
• reading WS300 data, and up to 9 attached devices
• reading EM1000WZ/EM1000EM 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
• 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)
• modular architecture
• Two different web frontends, choose your favorite


See commandref.html for a detailed command description and faq.html for the F.A.Q.

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/FHZ1000-users-on-unix
Martins Web frontend (webpgm3): http://www.martin-haas.de/fhz
Another Martins Web frontend (myHCE): http://www.fischer-net.de/projekte/haustechnik/myhce.html
CVS@berlios: http://developer.berlios.de/projects/fhem
LinViex (home automation frontend): http://sourceforge.net/projects/linviex

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
  (best:use "Solution B";change only the value PID to the FDTI default. Your supplied software will not harm.)
  At this time, we only support virtual com port on windows. Only COM1..COM9 are known to work ->COM10 will result in a "unknown Device" error.
• 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

Related projects:

http://fhz4linux.info/

Installation

Linux driver

See http://www.koeniglich.de/fhem/linux.html
For kernels older then 2.6.x apply the patch from the doc directory to your kernel, recompile it and reboot or load/reload the ftdi_sio module.

Perl modules

You need perl >=5.8, on Unix with the Device::SerialPort ( http://search.cpan.org/dist/Device-SerialPort/), on Windows Win32::SerialPort (best along ActiveState ActivePerl installation on Windows) module. All other needed modules were present in my installation. 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

• Copy the file fhem.pl into your path (e.g. /usr/local/bin), and the FHEM directory e.g. to /usr/local/lib.
• Copy additional modules from the contrib directory (like 99_SUNRISE_EL.pm)
• Make sure that you can access the serial USB device (e.g. /dev/tts/USB0).
• Create a configuration file (see the examples directory and docs/commandref.html), change at least the modpath (/usr/local/lib) and define FHZ FHZ (/dev/tts/USB0) parameters.
• Start the server with fhem.pl <configfile>

Server installation on Windows

• be sure you have perl.exe in your path (%PATH%)
• unpack distribution in a directory of your choice
• Copy additional modules from the contrib directory (like 99_SUNRISE_EL.pm)
• 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), change at least the modpath (your_install_dir) and define FHZ FHZ (COM10) parameters.
• 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 web server and the fhem server must be on the same host
• 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 realising a primitive HTTP server -> You do not even need apache if security (password/HTTPS) is not a concern. It has support for grouping devices into rooms, manipulating devices, direct fhem commands, diplaying logfiles as text or (if gnuplot is installed) as graphs.
Screenshots: one, two.

For installation see the webpgm/pgm2/README file.


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 can be found on Martins page: http://www.martin-haas.de/fhz


• Install PHP 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!
• Edit index.php (/home/httpd/html/pgm3/index.php), and check the required settings section
• If you want to have access to the FHT temperature logs, then:
  • Make sure gnuplot is installed
  • check the showgnuplot section in index.php
  • For each FHT device copy the file docs/gnuplot/gnuplot.wz to gnuplot.fhtdevicename (to the /home/httpd/html/pgm3 directory) and replace fht.log in this file with the absolute name of the current logfile.
• Call <your-site>/pgm3/index.php

Web frontend 4 (webfrontend/pgm4, the template)

This frontend is PHP based and was contributed by Stefan Mayer. It won't work for you without modification, it is meant as a template or as an example. See the screenshot. To install:
• Copy the directory webfrontend/pgm4 to your html directory.
• Install/enable PHP (see the description for frontend3)
• Call the program with http://webserver/pgm4/fs20.php
Now you can go on, and modify it to suit your needs :-)

License:

Copyright:

• Rudolf Koenig (r dot koenig at koeniglich dot de)
• Raoul Matthiessen (webfrontends/pgm1)
• Martin Haas (webfrontends/pgm3)
License: GPL (v2)

Misc:

Thanks for Tosti for inspiration and numerous other people for help.