FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-01-31 12:49:34 +00:00
Code Issues Releases Wiki Activity
8410288c1e
fhem-mirror/fhem/docs/fhem.html

262 lines
11 KiB
HTML
Raw Normal View History

- Softwarebuffer for FHT devices with queuing unsent commands and repeating commands by transmission failure - FHT low temperatur warning and setting for lowtemp-offset - Change naming for state into warnings git-svn-id: https://svn.fhem.de/fhem/trunk@101 2b470e98-0d58-463d-a4d8-8e2adae1ed80
2007-10-19 09:29:00 +00:00
<!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.
Formerly known as fhz1000.pl
<h2>News (as of =DATE=, Version =VERS=)</h2>
<ul>
<li> doc: linux.html (private udev-rules, not 50-..., ATTRS)
<li> bugfix: setting devices with "-" in their name did not work
<li> doc: fhem.pl and commandref.html (notifyon -> notify, correction
of examples)
<li> feature: modify command added
<li> feature: The "-" in the name is not allowed any more
<li> bugfix: disabled notify causes "uninitialized value" (STefan, 1.5)
<li> bugfix: deleted FS20 items are still logging (zombie) (Gerhard, 16.5)
<li> bugfix: added FS20S8, removed stty_parmrk (Martin, 24.5)
<li> feature: added archivedir/archivecmd to the FileLog
<li> feature: added EM1010PC/EM1000WZ/EM1000EM support
<li> bugfix: undefined messages for unknown HMS devs (Peter, 8.6)
<li> bugfix: em1010 and %oldvalue bugs (Peter, 9.6)
<li> bugfix: SCIVT solar controller (peterp, 1.7)
<li> bugfix: WS300 loglevel change (from 2 to 5 or device specific loglevel)
<li> feature: First steps for a Fritz!Box port. See the fritzbox.html
<li>feature: FHT lime-protection code discovered by Dirk (7.10)
<li>feature: Softwarebuffer for FHT devices with queuing unsent commands and repeating commands by transmission failure (Dirk 17.10)
<li> feature: FHT low temperatur warning and setting for lowtemp-offset (Dirk 17.10)
<li>change: Change naming for state into warnings (Dirk 17.10)
</ul>
</ul>
<h2>Description</h2>
<ul>
This program makes the FHZ1000/FHZ1300/WS300 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.<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)<br>
<li>support of FS20 address features function group, local and global master
<li>reading and changing FHT80b parameters (temp, actuator, etc).<br>
The FHT8b seems to work too. <b>Note:</b> the FHT8 wont work.<br />
For FHT8b devices, FHEM have an internal software buffer for sending commands step by step. This buffer should prevent lost commands. In case of transmission failures FHEM tries to resend commands. <br />
</li>
<li>reading HMS data (HMS100-T,-TF,-WD,-MG,-TFK and RM100-2)</li>
<li>reading KS300 data</li>
</ul>
</li>
<li>reading WS300 data, and up to 9 attached devices</li>
<li>reading EM1000WZ/EM1000EM data via an attached EM1010PC</li>
<li>reading an attached SCIVT device</li>
<li>logging events to files (or database), 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>modular architecture</li>
<li>a lot of web frontends, choose your favorite</li>
<br>
</ul>
See <a href="commandref.html">commandref.html</a> for a detailed command
description and <a href="faq.html">faq.html</a> for the F.A.Q.
</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>
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">
http://sourceforge.net/projects/linviex</a><br><br>
Device/OS Specific installation guides:<br>
<ul>
Linux driver installation:
<a href="http://www.koeniglich.de/fhem/linux.html">
http://www.koeniglich.de/fhem/linux.html</a><br>
Instructions for Nas/Routers (NSLU2):
<a href="http://www.martin-haas.de/fhz/nslu2fhz">
http://www.martin-haas.de/fhz/nslu2fhz</a><br>
Instructions for the Fritz!Box:
<a href="fritzbox.html">
http://www.koeniglich.de/fhem/fritzbox.html</a><br>
Instructions for the Allnet all6250:
<a href="http://wiki.dungeon.de/all6250_opennas_mit_fhem">
http://wiki.dungeon.de/all6250_opennas_mit_fhem</a><br>
</ul>
</ul>
<h2>Related projects:</h2>
<ul>
<a href="http://fhz4linux.info/">http://fhz4linux.info/</a><br>
</ul>
<h2>Installation</h2>
<ul>
<h3>Linux driver</h3>
See <a href="http://www.koeniglich.de/fhem/linux.html">
http://www.koeniglich.de/fhem/linux.html</a><br>
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.
</ul>
<h3>Perl modules</h3>
<ul>
You need perl with the Device::SerialPort (<a
href="http://search.cpan.org/dist/Device-SerialPort/">
http://search.cpan.org/dist/Device-SerialPort/</a>)
module. All other needed modules were present in my installation.
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</h3>
<ul>
<li>Copy the file <code>fhem.pl</code> into your path (e.g.
<code>/usr/local/bin</code>), and the FHEM directory e.g. to
<code>/usr/local/lib</code>. </li>
<li>Make sure that you can access the serial USB
device (e.g. <code>/dev/tts/USB0</code>).</li>
<li>Create a configuration file (see the examples directory and
docs/commandref.html), and change at least the modpath
(<code>/usr/local/lib</code>) and define FHZ FHZ (<code>/dev/tts/USB0</code>)
parameters.</li>
<li>Delete the savefile if you are upgrading from an older version.</li>
<li>Start the server with <code>fhem.pl &lt;configfile&gt;</code></li>
</ul>
<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>
</ul>
<h3>Web frontend 2 (webfrontend/pgm2, the simple one)</h3>
<ul>
This frontend is CGI/CSS based. It has support for rooms, and FHT/KS300 logs.<br>
Screenshots: <a href="pgm2-1.gif">overview</a>, <a href="pgm2-2.gif">details
</a> and KS300 temperature <a href="pgm2-3.gif">logs</a><br><br>
<ul>
<li>Copy the file fhemweb.pl and *.gplot 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).<br>
Note: The program looks for icons in the following order:
&lt;device-name&gt;.&lt;state&gt;, &lt;device-name&gt;,
&lt;device-type&gt;.&lt;state&gt;, &lt;device-type&gt;<br>
</li>
<li>Edit <code>fhemweb.pl</code>, and check the "Config" section.</li>
<li>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).
</li>
<li>Call &lt;your-site&gt;/cgi-bin/fhemweb.pl
</ul>
For special features like assigning devices to rooms see the README file.
</ul>
<h3>Web frontend 3 (webfrontend/pgm3, the professional one)</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>
<h3>Web frontend 4 (webfrontend/pgm4, the template)</h3>
<ul>
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 <a href="pgm4.gif">screenshot</a>. To install:
<ul>
<li>Copy the directory webfrontend/pgm4 to your html directory.</li>
<li>Install/enable PHP (see the description for frontend3)</li>
<li>Call the program with http://webserver/pgm4/fs20.php</li>
</ul>
Now you can go on, and modify it to suit your needs :-)
</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>
Reference in New Issue Copy Permalink