2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-01-31 12:49:34 +00:00
fhem-mirror/fhem/docs/fhem.html
rudolfkoenig d2fc6430a9 http://www.dhs-computertechnik.de/
git-svn-id: https://svn.fhem.de/fhem/trunk@263 2b470e98-0d58-463d-a4d8-8e2adae1ed80
2008-11-05 13:49:08 +00:00

249 lines
9.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Home of FHEM</title>
</head>
<body style="background-color: white">
<h1>FHEM</h1>
GPL'd server to access devices like FHZ1000/FHZ1300,EM1010PC,WS300,SCIVT,X10.
Formerly known as fhz1000.pl
<br/><br/>
Current Version: (as of =DATE=) is <a
href="http://www.koeniglich.de/fhem/fhem-=VERS=.tar.gz">=VERS=</a>
See the <a href="CHANGED">CHANGED</a> file for current changes, or the <a
href="#webfrontends"/>webfrontends</a> section for screenshots.
<h2>Description</h2>
<ul>
This program makes the FHZ1000/FHZ1300/WS300 and other USB devices sold by ELV,
Conrad and others as well as X10 devices sold by Marmitek, Powerhouse and
others useable with Linux. In fact, there is nothing Linux special
in it, there are reports from OS X and Windows. You should be able to use it on
other platforms as long as you can access the hardware as a serial device.<br>
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.<br> <br>
Currently implemented features:<br>
<ul>
<li>Via the FHZ module (with access to one or more FHZ1000/FHZ1300 device):
<ul>
<li>reading and sending FS20 events (on/off/dimming, timer
commands)</li>
<li>support of FS20 address features function group, local and global
master</li>
<li>reading and changing FHT80b parameters (temp, actuator, etc).<br>
The FHT8b seems to work too. Note: the FHT8 wont work.<br>
Internal software buffer to prevent lost commands.</li>
<li>reading HMS data (HMS100-T,-TF,-WD,-MG,-TFK,-CO,-FIT and RM100-2)</li>
<li>reading KS300 data</li>
</ul>
Note: The FHZ1350 WLAN is probably not working due to a prorietary
encryption.
</li>
<li>Via the CM11 module (with access to a X10 computer interface):
<ul>
<li>reading all X10 events</li>
<li>sending X10 events (on/off/dimming)</li>
<li>on/off switching suppport</li>
</ul>
</li>
<li>reading WS300 data, and up to 9 attached devices</li>
<li>reading EM1000WZ/EM1000EM/EM1000GZ data via an attached EM1010PC</li>
<li>reading attached SCIVT devices</li>
<li>reading attached M232 devices</li>
<li>reading attached WS2000/WS25000 devices, also via raw network
converters(xport)</li>
<li>extract sensor data from IPWE networked weather data receiver</li>
<li>logging events to files or databases, with regexp filters</li>
<li>notifying external programs or internal modules when receiving certain
events</li>
<li>timed commands (e.g. switching a lamp on from sunset till midnight)</li>
<li>watchdog (e.g. trigger if the HMS100-FIT is inactive for HH:MM:SS)</li>
<li>modular architecture, easy to add your special device</li>
<li>different web frontends, choose your favorite</li>
<br>
</ul>
See <a href="HOWTO.html">HOWTO.html</a>, <a href="commandref.html">commandref.html</a>
and <a href="faq.html">faq.html</a> for more documentation.
</ul>
<h2>Links:</h2>
<ul>
Homepage: <a href="http://www.koeniglich.de/fhem/fhem.html">
http://www.koeniglich.de/fhem/fhem.html</a><br>
Download: <a href="http://www.koeniglich.de/fhem/fhem-=VERS=.tar.gz">
http://www.koeniglich.de/fhem/fhem-=VERS=.tar.gz</a><br>
FAQ: <a href="http://www.koeniglich.de/fhem/faq.html">
http://www.koeniglich.de/fhem/faq.html</a><br>
Google-Group: <a href="http://groups.google.com/group/FHZ1000-users-on-unix">
http://groups.google.com/group/FHZ1000-users-on-unix</a><br>
Martins Web frontend (webpgm3): <a href="http://www.martin-haas.de/fhz">
http://www.martin-haas.de/fhz</a><br>
Another Martins Web frontend (myHCE): <a href="http://www.fischer-net.de/projekte/haustechnik/myhce.html">http://www.fischer-net.de/projekte/haustechnik/myhce.html</a><br>
CVS@berlios: <a href="http://developer.berlios.de/projects/fhem">
http://developer.berlios.de/projects/fhem</a><br>
LinViex (home automation frontend):
<a href="http://sourceforge.net/projects/linviex">
<a href=http://shop.busware.de/product_info.php?products_id=29">CUL</CUL>
http://sourceforge.net/projects/linviex</a><br><br>
Device/OS Specific installation guides:<br>
<ul>
<li>Linux driver installation:
<a href="http://www.koeniglich.de/fhem/linux.html">
http://www.koeniglich.de/fhem/linux.html</a></li>
<li>Windows driver installation:
<a href="http://fhz4linux.info/tiki-index.php?page=Driver%20installation">
http://fhz4linux.info/tiki-index.php?page=Driver%20installation</a> <br>
(use "Solution B", only COM1..COM9 is supported)</li>
<li>Instructions for Nas/Routers (NSLU2):
<a href="http://www.martin-haas.de/fhz/nslu2fhz">
http://www.martin-haas.de/fhz/nslu2fhz</a></li>
<li>Instructions for the Fritz!Box:
<a href="fritzbox.html">
http://www.koeniglich.de/fhem/fritzbox.html</a></li>
<li>Instructions for the Allnet all6250:
<a href="http://wiki.dungeon.de/all6250_opennas_mit_fhem">
http://wiki.dungeon.de/all6250_opennas_mit_fhem</a></li>
</ul>
Commercial products:
<ul>
<li><a href="http://www.dhs-computertechnik.de/">
http://www.dhs-computertechnik.de/</a></li>
</ul>
</ul>
<h2>Related projects:</h2>
<ul>
<a href="http://fhz4linux.info/">http://fhz4linux.info/</a><br>
</ul>
<h2>Installation</h2>
<ul>
<h3>Perl modules</h3>
<ul>
You need perl &gt;=5.6, on Unix with the Device::SerialPort (<a
href="http://search.cpan.org/dist/Device-SerialPort/">
http://search.cpan.org/dist/Device-SerialPort/</a>),
on Windows Win32::SerialPort (use ActiveState's ActivePerl)
module.
If this module reports <code>Can't call method "opened" on an undefined
value...</code> when starting the server, then you either may ignore
this message, or replace the mentioned line with:<pre>
$self->{HANDLE}->close if (defined($self->{HANDLE}) &&
$self->{HANDLE}->opened);</pre>
</ul>
<h3>Server installation on Unix</h3>
<ul>
<li>Check the Makefile for the installation path, then type make install.</li>
<li>Create a configuration file (see the examples directory or
docs/commandref.html).</li>
<li>Start the server with <code>fhem.pl &lt;configfile&gt;</code></li>
</ul>
<h3>Server installation on Windows</h3>
If you are using cygwin for your perl installation you can follow the guidelines for Unix.
<ul>
<li>Be sure you have perl.exe in your path (%PATH%)</li>
<li>Make sure that you can access the serial USB device via virtual COM-Port
or via socket(e.g. <code>COMX or xport:10001</code>).</li>
<li>Create a configuration file (see the examples directory and
docs/commandref.html)</li>
<li>Start the server with <code>fhem.pl &lt;configfile&gt;</code></li>
</ul>
<a name="webfrontends"/>
<h3>General Notes for Webfrontends:</h3>
<ul>
<li>You don't have to install all of them, one is probably more than
enough :-)</li>
<li>The web server and the fhem server must be on the same host</li>
<li><b>Important:</b> Make sure you add some protection (.htaccess, etc)
else everybody will be able to set your devices</li>
<li>The list below contains the 2 actively maintained fronteds:</li>
</ul>
<h3>Web frontend 2 (webfrontend/pgm2)</h3>
<ul>
This frontend is a FHEM module implementing a HTTP server. 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. <br/>
Screenshots: <a href="pgm2-1.png">overview</a>, <a
href="pgm2-2.png">detail</a>, <a href="pgm2-3.png">SVG-plots</a>.
<br><br>
Installation: make install-pgm2 &amp;&amp; perl fhem.pl <br>
Connect to fhem via <a
href="http://localhost:8083/fhem">http://localhost:8083/fhem</a>. See the
Howto there on how to continue.
</ul>
<h3>Web frontend 3 (webfrontend/pgm3)</h3>
<ul>
This frontend is PHP based and was contributed by Martin Haas.
Look at the webfrontends/pgm3/docs for more documentation or at
<a href="pgm3-0.5.1.png">this screenshot</a>. A lot more details can be
found on Martins page: <a href="http://www.martin-haas.de/fhz">
http://www.martin-haas.de/fhz</a>
<br><br>
<ul>
<li>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.</li>
<li>Create a directory (e.g.: /home/httpd/html/pgm3) and copy all the
files from the webfrontend/pgm3 to this directory.<br>Make sure that this
directory is writeable by the webserver!</li>
<li>Edit index.php (/home/httpd/html/pgm3/index.php), and check the
required settings section</li>
<li>If you want to have access to the FHT temperature logs, then:
<ul>
<li>Make sure gnuplot is installed</li>
<li>check the showgnuplot section in index.php</li>
<li>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.</li>
</ul>
<li>Call &lt;your-site&gt;/pgm3/index.php</li>
</ul>
</ul>
<h2>License:</h2>
<ul>
Copyright:<br>
<ul>
<li>Rudolf Koenig (r dot koenig at koeniglich dot de)</li>
<li>Raoul Matthiessen (webfrontends/pgm1)</li>
<li>Martin Haas (webfrontends/pgm3)</li>
</ul>
License: GPL (v2)
</ul>
</ul>
<h2>Misc:</h2>
<ul>
Thanks for Tosti for inspiration and numerous other people for help. <br>
</ul>
</body>
</html>