@@ -39,14 +50,13 @@
heating / etc. and to log events like temperature / humidity / power
consumption.
- The program runs as a server, you can control it via web-frontends,
- telnet, command line program or TCP/IP directly.
+ The program runs as a server, you can control it via web or smartphone
+ frontends, telnet or TCP/IP directly.
- In order to use fhem you'll need a 24/7 server (PC, MacMini, Fritz!Box,
- NAS, etc) with a perl interpreter and some attached hardware like the
+ In order to use fhem you'll need a 24/7 server (Fritz!Box, NAS, RPi, PC,
+ MacMini, etc) with a perl interpreter and some attached hardware like the
CUL, FHZ1300PC, etc. to access the actors and sensors. See the "Supported
- hardware" section below.
-
+ hardware" section below.
@@ -76,7 +86,7 @@
Frontend screenshots
- Builtin pgm2 / external pgm5 web frontend:
+ Builtin (default) pgm2 / external pgm5 web frontend:
overview,
the same rendered for smartphones,
detail,
@@ -84,6 +94,11 @@
dark style.
Make sure you have perl. Most certainly you will need the
+ Device::SerialPort fhem module, install it with "sudo cpan
+ Device::SerialPort" or "apt-get install libdevice-serialport-perl".
+
+
Download the
+ .tar.gz package, unpack it, and change to the unpacked directory.
+
+
Option 1: start fhem directly from this directory (perl fhem.pl fhem.cfg).
+
Option 2: Install it by checking the Makefile first then typing
+ make install.
+ Check the installed fhem.cfg and start fhem as advised.
+
Windows
@@ -376,135 +404,27 @@
follow the guidelines for Unix.
Be sure you have perl.exe in your path (%PATH%), and the module
- Win32::SerialPort is installed.
-
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>
+ Win32::SerialPort is installed.
+
Make sure that you can access your device (CUL/FHZ/etc) via virtual
+ COM-Port or via socket (e.g. COMX or xport:10001).
+
Download the
+ .tar.gz package, unpack it, and change to the unpacked directory.
+
Start the server with perl fhem.pl fhem.cfg
-
- 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, HTTP basicAuth, HTTPS and IPV6 (with the IO::Socket::SSL and
- IO::Socket:INET6 perl modules)
-
-
- Screenshots: overview, detail, SVG-plots.
-
- It installed by default, but it can be deconfigured.
+ After installation follow the HOWTO for adding devices.
-
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.
- A lot more details and screenshots
- can be found on Martins page:
- http://www.martin-haas.de/fhz
- pgm3 may run on an other machine than fhem. The Devices of 95% of the
- users are detected and configured automatically. Further 4% are
- adaptable by the function UserDef. See config.php for explanation.
-
-
- Installation:
-
-
Install PHP5, the php5-Apache-Modules, gnuplot and php5-gd. Every
- current distribution should do all the needed configuration without
- your input.
-
-
Create a directory in the Apache2 DocumentRoot
- (e.g.: /var/www/pgm3) and copy all the files from the
- webfrontend/pgm3 to this directory. Make sure that this directory
- is writeable by the webserver (e.g. User www-data.www-data)!
-
-
Call <your-site>/pgm3/index.php and follow the instructions
- on screen
Troubleshooting: right-click on the graphic then "show
- graphic".
-
-
-
-
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 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 http://www.dhs-computertechnik.de/support.html
-
-
- 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)
+
Olaf Droegehorn (webfrontends/pgm5)
+
Numerous other people with their fhem modules
License: GPL (v2)
Thanks to TOSTi for inspiration and numerous other people for help.