2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-01-31 06:39:11 +00:00
fhem-mirror/fhem/docs/fhem.html

356 lines
13 KiB
HTML
Raw Normal View History

<!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>
<link rel="stylesheet" type="text/css" href="../www/pgm2/style.css" />
<meta name="viewport" content="initial-scale=1.0,user-scalable=1">
<meta http-equiv="Content-type" content="text/html;charset=ISO-8859-1"/>
<link rel="shortcut icon" href="favicon.ico"/>
</head>
<body>
<div id="menuScrollArea">
<div id="logo"></div>
<div id="menu">
Version: <b>EN</b>&nbsp;<a href="fhem_DE.html">DE</a>
<table><tr><td> <!-- Playing with the width -->
<table class="room">
<tr><td></td></tr>
<tr><td><b>Content:</b></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Description">Description</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Features">Features</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Protocols">Protocols</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Screenshots">Screenshots</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Documentation">Documentation</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Download">Download</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Installation">Installation</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#Links">Links</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="#License">License</a></td></tr>
<tr><td></td></tr>
<tr><td><hr/></td></tr>
<tr><td><b>FHEM Links:</b></td></tr>
<tr><td></td></tr>
<tr><td><a href="https://forum.fhem.de" target="_blank">Forum</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="https://svn.fhem.de/" target="_blank">SVN</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="https://wiki.fhem.de" target="_blank">Wiki</a></td></tr>
<tr><td></td></tr>
<tr><td><a href="https://verein.fhem.de" target="_blank">FHEM e.V.</a></td></tr>
<tr><td></td></tr>
<tr><td></td></tr>
</table>
</td></tr></table>
<img id="cloudfree" src="cloudfree.png"/>
</div>
</div>
<div id="right">
<a name="Description"></a>
<h3>Description</h3>
<ul>
FHEM (TM) is a GPL'd perl server for house automation. It 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.<br><br>
The program runs as a server, you can control it via web or smartphone
frontends, telnet or TCP/IP directly.<br><br>
In order to use FHEM you'll need a 24/7 server (NAS, RPi, PC, MacMini,
etc) with a perl interpreter and some attached hardware like the
CUL-, EnOcean-, Z-Wave-USB-Stick, etc. to access the actors and sensors.
<br><br>
It is pronounced without the h, like in feminine.</ul>
<a name="Features"></a>
<h3>Features</h3>
<ul>
<li>support for a lot of protocols used in house automation, audio/video
devices, weather services, online calendars and more.
</li>
<div class="dist"></div>
<li>autocreating devices/logs when receiving data from a new device:
start FHEM and watch how the plots of your sensors are appearing
automatically.</li>
<div class="dist"></div>
<li>logging events to files or a database, with regexp filters</li>
<div class="dist"></div>
<li>notifying external programs or scripts when receiving certain
events</li>
<div class="dist"></div>
<li>timed commands (e.g. switching a lamp on from sunset till midnight)
</li>
<div class="dist"></div>
<li>lot of interfaces: simple text, JSON, XML, each of them over plain
TCP/IP, SSL or HTTP.
<div class="dist"></div>
<li>modular architecture with currently over 430 modules, easy to add
your special device</li>
<div class="dist"></div>
<li>lot of frontends, choose your favorite</li>
<div class="dist"></div>
</ul>
<a name="Protocols"></a>
<h3>Supported protocols (small excerpt)</h3>
<ul>
<li>eQ3 spezific: HomeMatic, MAX!, FS20, EM1000, FHT80b, HMS, S300,
ESA2000</li>
<div class="dist"></div>
<li>KNX, ZWave, EnOcean, Philipps HUE, FRITZ!Dect, Intertechno, HomeEasy,
X10</li>
<div class="dist"></div>
<li>1Wire, Firmata, webio, panStamp, LIRC, JeeLink, RFXCOM/RFXTRX, Wireless M-Bus</li>
<div class="dist"></div>
<li>Davis VantagePro2, Oregon Scientific, Allnet</li>
<div class="dist"></div>
<li>TVs from LG, Panasonic, Philips, Samsung, Sony</li>
<div class="dist"></div>
<li>Devices from Bose, Sonos, Squeezebox</li>
<div class="dist"></div>
<li>Amplifier from Denon, Onkyo, Pioneer, YAMAHA</li>
<div class="dist"></div>
<li>iTunes/AppleTV, Enigma2, XBMC/Kodi, MediaPortal, Plex</li>
<div class="dist"></div>
<li>Alexa, HomeKit, HomeBridge, MQTT (internal or external server)</li>
<div class="dist"></div>
<br>
A complete list of all FHEM-modules with a detailed description can be
found in the <a href="commandref.html">commandref</a> document.
</ul>
<a name="Screenshots"></a>
<h3>Frontend Screenshots</h3>
<ul>
<li>Builtin web frontend:
overview on the
<a href="pgm2-1.png">Desktop</a> or on the
<a href="pgm2-3.png">Smartphones</a>,
<a href="pgm2-2.png">SVG-plots</a>.</li>
<div class="dist"></div>
<li>The FHEM FLOORPLAN module:
<a href="tirreG.jpg">Example1</a>,
<a href="Benji.png">Example2</a>,
<a href="forum_22336.jpg">LCars</a>.</li>
<div class="dist"></div>
<li>The <a href="InfoPanel.png">InfoPanel</a> module
</li><div class="dist"></div>
<li>FHEM Tablet UI</a>: <a href="TabletUI_1.png">Example1</a>,
<a href="TabletUI_2.png">Example2</a>
</li><div class="dist"></div>
<li>smartVISU: <a href="SmartVisu.png">Example</a>
</li><div class="dist"></div>
<li><a href="https://wiki.fhem.de/wiki/Neues_Charting_Frontend">
Charting Frontend</a> and
<a href="https://forum.fhem.de/index.php/topic,12629.0.html">YAF</a>
(Yet Another Frontend).
</li><div class="dist"></div>
<li>iPhone Frontends:
<a href="itms://itunes.apple.com/us/app/fhemobile/id389951065?mt=8">
Fhemobile</a> (native app),
<a href="http://www.dhs-computertechnik.de/support-iphone.html">
dhs-computertechnik</a> or
<a href="http://code.google.com/p/phyfhem/">phyfhem</a></li>
<div class="dist"></div>
<li>Android Frontends:
<a href="http://andFHEM.klass.li">andFHEM</a> (natives App),
<a href="https://forum.fhem.de/index.php/topic,10628.0.html">
Fullscreen Browser App</a>,
<a href="https://forum.fhem.de/index.php/topic,12624.0.html">ORCA addition</a>
</li>
<div class="dist"></div>
</ul>
<a name="Documentation"></a>
<h3>Documentation</h3>
<ul>
<div class="dist"><a href="commandref.html">commandref.html</a>
contains a detailed description of all features/modules.</div>
<div class="dist"></div>
<div class="dist">Our wiki at <a
href="https://wiki.fhem.de">https://wiki.fhem.de</a></div>
<div class="dist"></div>
<div class="dist">Forum: <a href="https://forum.fhem.de">
https://forum.fhem.de</a><br>Although most entries are in german here,
don't be afraid to ask something in english.</div>
<div class="dist"></div>
<div class="dist">short course in FHEM (no hardware needed): <a
href="https://wiki.fhem.de/wiki/First_steps_in_FHEM">
First steps in FHEM</a></div>
<div class="dist"></div>
<div class="dist"><a href="https://wiki.fhem.de/wiki/Quick-Start/en">
Quick-Start</a> for a short installation/configuration.</div>
<div class="dist"></div>
<div class="dist"><a href="Heimautomatisierung-mit-fhem.pdf">
Heimautomatisierung-mit-FHEM.pdf</a> (Feb. 2014, pdf, german)</div>
<div class="dist"></div>
<div class="dist"><a href="https://www.hanser-fachbuch.de/fachbuch/artikel/9783446458734">
Smart Home mit FHEM</a> (Oct. 2019, german)</div>
<div class="dist"></div>
</ul>
<a name="Download"></a>
<h3>Download</h3>
<ul>
Last released version: (as of 2024-01-28):
<a href="https://fhem.de/fhem-6.3.tar.gz">fhem-6.3.tar.gz</a>,
<a href="https://fhem.de/fhem-6.3.zip">fhem-6.3.zip</a>,
<a href="https://fhem.de/fhem-6.3.deb">fhem-6.3.deb</a>,
<br>
See the <a href="CHANGED">CHANGED</a> file for the change history or the
<a href="SVNLOG">svn log</a> for a more detailed log.<br><br>
<b>Note</b>: the FHEM development is a continuous one, and a release is
only a starting point for the update process.<br>
Use the <a href="commandref.html#update">update</a> command to get the
most recent version, especially if you want to report issues in the
forum.<br>
Nightly versions:
<a href="https://debian.fhem.de/">debian.fhem.de</a>
<br><br>
Please use <a href="commandref.html#fheminfo">fheminfo</a> command to
automatically generate <a href="/stats/statistics.html">this</a>
statistics as we'd like to know which FHEM modules are in use.
</ul>
<a name="Installation"></a>
<h3>Installation</h3>
<ul>
<h4>Debian/Ubuntu/Raspbian</h4>
<ul>
<li>Install <a href="https://fhem.de/fhem-6.3.deb">this</a> package.
For a better integration check out <a
href="https://debian.fhem.de/">debian.fhem.de</a>
</ul>
<h4>Unix / OSX</h4>
<ul>
<li>Make sure you have perl. Most certainly you will need the
Device::SerialPort perl module, install it with "sudo cpan
Device::SerialPort" or "apt-get install libdevice-serialport-perl".
</li>
<li>Download the <a href="https://fhem.de/fhem-6.3.tar.gz">
.tar.gz</a> package, unpack it, and change to the unpacked directory.
<li>start FHEM directly from this directory (perl fhem.pl fhem.cfg).
</ul>
<h4>Windows</h4>
<ul>
<li>See the <a href="https://wiki.fhem.de/wiki/FHEM_Installation_Windows/en">
FHEM Installation Windows</a> for a detailed description.</li>
<li>If you are using cygwin for your perl installation you can
follow the guidelines for Unix.</li>
</ul>
<h4>Fritz!BOX</h4>
<ul>
As of Fritz!OS 6.20 AVM decided to remove all possibilities to start
"foreign" programs automatically after a reboot, that is why I advise
against deploying FHEM on the Fritz!BOX, see also <a
href="https://forum.fhem.de/index.php?topic=25066.0">this</a> discussion
(in german). If you still insist:
<li>On the FB7390 or FB7490 install <a
href="https://fhem.de/fhem-5.7-fb7390.image">this</a> image. Note: it
is needed <i>additionally</i> to the OS image from AVM.<br>
<li>On the FB7270 unpack <a
href="https://fhem.de/fhem-5.7-fb7270.zip">this</a> zip file to a
USB-Disk, attach the disk to the FritzBox, log in, and start FHEM from
there.
</ul>
<br><br>
After the installation follow the
<a href="https://wiki.fhem.de/wiki/Quick-Start/en">Quick-Start</a> for
adding devices or try out the demo configuration by starting fhem with:<br>
<ul><code>
perl fhem.pl fhem.cfg.demo
</code></ul>
</ul>
<a name="Links"></a>
<h3>Links</h3>
<ul>
Forum: <a href="https://forum.fhem.de">
https://forum.fhem.de</a><br>
Development source: <a href="https://svn.fhem.de">
https://svn.fhem.de</a><br>
Wiki: <a href="https://wiki.fhem.de">
https://wiki.fhem.de</a><br>
FHEM e.V. (registered non-profit association): <a href="https://verein.fhem.de">
https://verein.fhem.de</a><br>
The purpose of the association is the promotion of science, research and teaching as well as education on the topics of free and open source software and open standards with special consideration of FHEM.<br>
<br><br>
CUL/CUNO/COC/EUL/TUL-Firmware Homepage: <a href="http://culfw.de/culfw.html">
http://culfw.de</a>
</ul>
</ul>
<a name="License"></a>
<h3>License:</h3>
<ul>
Copyright:<br>
<ul>
<li>Rudolf Koenig (rudolf dot koenig at fhem dot de. Note: I <b>do
not</b> provide fhem-support via private mail, use the
<a href="https://forum.fhem.de">forum</a> instead)</li>
<li><a href="MAINTAINER.txt">Numerous other people with their FHEM modules</a></li>
</ul>
License: GPL (v2)<br>
</ul>
<footer><center><a href="Impressum.html">Impressum / Datenschutz</a></center></footer>
<br>
</body>
</html>