diff --git a/docs/HOWTO.html b/docs/HOWTO.html
index 35fe895d3..e714efaf0 100644
--- a/docs/HOWTO.html
+++ b/docs/HOWTO.html
@@ -36,15 +36,22 @@
Starting fhem
- Skip this section if you installed fhem via the Debian
- package or via the Fritzbox7390
- image
+ Skip this section if you installed fhem via the Debian package, the Fritz!Box 7390
+ image, or the FB
+ 7170/7270 zip file.
+
- First install the Device::SerialPort (or Win32::SerialPort) perl module
- with the command "sudo cpan Device::SerialPort"
. There are
- also precompiled debian packages (libdevice-serialport-perl), and this
- module is already installed on OSX. You will need it to access the USB
- devices
+ As most fhem installations access the "outer world" via a USB device
+ connected to the fhem computer (CUL, FHZ1x00, etc), we most probably need
+ the perl serial module.
+
+ This is why you should first install the Device::SerialPort (or
+ Win32::SerialPort) perl module with the command "sudo cpan
+ Device::SerialPort"
. There are also precompiled debian packages
+ (libdevice-serialport-perl), and this module is already installed on OSX
+ 10.6. If you cannot install it, you then take a look at the directio
+ option
The default configuration will install fhem into /usr/bin,
/usr/share/fhem and /var/log/fhem and /etc/fhem.cfg, according to the
@@ -62,7 +69,7 @@
- Attaching the USB device for the PC (CUL / FHZ1x00PC / EM1010PC)
+ Attaching the USB device for the PC (CUL / FHZ1x00PC / etc)
Connect to fhem with an internet browser:
http://fhem-host:8083/fhem
@@ -72,7 +79,7 @@
http://fhem-host:8085/fhem if
you are using a tablet like the iPad.
- Attach the USB device (CUL, FHZ1000PC/FHZ1300, EM1010PC) to your
+ Attach the USB device (CUL, FHZ1000PC/FHZ1300, TUL, EUL, etc) to your
computer, and look for the corresponding device in the /dev
directory. For CUL a file named
/dev/ttyACM* will be created under
@@ -105,7 +112,7 @@
- Configuring transmitter devices
+ Configuring transmitter devices (sensors)
The sample configuration file installed via "make install-pgm2" has
configured an autocreate
@@ -155,7 +162,7 @@
- Configuring FS20 receivers
+ Configuring FS20 receivers (actors)
Configure the FS20 device in
fhem first with:
@@ -168,7 +175,11 @@
Now set the model attribute of the device:
attr lamp1 model fs20st
- to get only the commands available for this device.
+ to get only the commands available for this device.
+
+ Other systems (EnOcean/HomeMatic) require a more elaborate procedure, and
+ the corresponding USB device is to be set into a pairing mode first. See
+ the commandref entry for your device.
@@ -194,7 +205,13 @@
notifies/watchdogs do. You can even simulate events by using the
trigger command:
trigger lamp1 on
-
+
+ For a more complex automation you can either control fhem by an external
+ program via telnet or HTTP, or (the usual way) do this via the fhem at
+ and notify commands. at and notify takes either simple fhem commands,
+ shell skripts or "perl oneliners" as argument. For details and tips on
+ the perl oneliners read the Perl
+ specials section in the commandref.html
FHEMWEB (pgm2) look and feel
@@ -203,12 +220,21 @@
attribute. FHEMWEB puts devices without a room attribute into the
"Unsorted" room. Devices in the room "hidden" will not be shown.
+ You can also define a stripped down FHEMWEB instance, by defining the
+ Menu entries to be hidden in the
+ hiddenroom FHEMWEB attribute.
+
- Set the title of the webpage by setting the title
attribute of the global
- device ("All together" -> global)
+
+ Set the title of the webpage by setting the title
attribute
+ of the global device ("All together" -> global)
Edit the colors / fonts by changing the style.css ("Edit files" ->
- style.css)
+ style.css), or create you own style (see stylesheetPrefix , so it
+ won't be overwritten by the next updatefhem command.
+
Further FHEMWEB attributes:
webname,
@@ -245,7 +271,8 @@
Plotting logs
Autocreate will create weblinks (i.e. plots) for newly detected devices.
- The following section describes how to do it manually.
+ The following section describes how to do it manually, e.g. if you want
+ to plot data from different sensors together.
To convert a FileLog into a plot (chart) in FHEMWEB, set the
logtype attribute of the
@@ -260,22 +287,21 @@
attr hms100th_log logtype temp4hum6:Plot,text
- When displaying the plot, you can convert it into a "weblink" device,
- so that we can in turn have a room attribute to group more than one Plot
- together. If the weblink refers to the current logfile, then it will be
- stored as a CURRENT weblink, and it will always display the most recent
- log (you do not have to redefine it if the logfile changes due to
- year/month/date parameters in its name).
+ When displaying the plot, you can convert it into a
+ weblink, which
+ has its own attributes. If the weblink refers to the current
+ logfile, then it will be stored as a CURRENT weblink, and it will always
+ display the most recent log (you do not have to redefine it if the
+ logfile changes due to year/month/date parameters in its name).
The logs can be converted to a plot either with gnuplot (which must be
installed and in your PATH), or via the builtin SVG module, in this case
- your browser must support SVG. Firefox, Opera, Chrome, Safari
- (both on OSX and iOS) support SVG out of the box, Internet Explorer
- from version 9. IE prior to version 9 does it via the Adobe "SVG viewer"
- plugin, on Android you need Opera or Firefox.
+ your browser must support SVG. All browsers support SVG, the notable
+ exception is Internet Explorer prior to version 9 and Android prior to
+ version 3.0. For such Android devices try Opera or Firefox.
SVG mode is the default, to change it set the plotmode attribute to gnuplot or
@@ -288,17 +314,17 @@
magnifier icons at the top of the page.
Note: the gnuplot files must have #FileLog entries in order to be useable
- with gnuplot-scroll or SVG, as the filtering happens with the FileLog get
+ with gnuplot-scroll or SVG (these lines are treated as comment by
+ gnuplot, but not by fhem!), as the filtering happens with the FileLog get
function, see the supplied gnuplot files or the column_spec paragraph here for the syntax.
The order of the #FileLog lines must match the corresponding 'awk'
entries.
- It make sense to build large logfiles for scrolling in them (year
- resolution), or smaller ones if you do not want to use the zoom/scroll
- feature. The size of the logfiles will be determined by its wildcard
- characters (year/month/week/day), look at the FileLog definition.
+ I recommend using log files with year resolution, this is determined by
+ its wildcard characters (year/month/week/day), look at the FileLog
+ definition.
@@ -313,7 +339,11 @@
- Using the builtin features of FHEMWEB for basic html authentication and HTTPS.
+ href="commandref.html#HTTPS">HTTPS. The perl modules needed for
+ HTTPS are missing from the FritzBox distribution, I recommend a direct
+ VPN connection here.
+
+
- Using apache to implement this features, and redirect a certain prefix to
each FHEMWEB instance.
@@ -348,7 +378,7 @@
- To display "foreign" (non fhem) files as a plot or a just as plain text,
+ To display "foreign" (non fhem) files as a plot or just as plain text,
configure a fake logfile with the correct filename and an unused regexp,
e.g.
define messages FileLog /var/log/messages fakelog
diff --git a/docs/commandref.html b/docs/commandref.html
index 7ece0c811..ec2c66663 100644
--- a/docs/commandref.html
+++ b/docs/commandref.html
@@ -31,6 +31,7 @@
attr
CULflash
+ createlog
define
delete
deleteattr
@@ -542,7 +543,8 @@ A line ending with \ will be concatenated with the next one, so long lines
jsonlist [<devspec>|<typespec>|ROOMS]
Returns an JSON tree of all definitions, all notify settings and all at
- entries if no parameter is given.
+ entries if no parameter is given. Can also be called via HTTP by
+ http://fhemhost:8083/fhem?cmd=jsonlist&XHR=1
Example:
fhem> jsonlist
@@ -732,7 +734,9 @@ A line ending with \ will be concatenated with the next one, so long lines
Download the CUL firmware from a nightly SVN chekout and flash the
hardware. Currently only the CUL is supported with its versions:
CUL_V2, CUL_V2_HM, CUL_V3, CUL_V4.
- Note: dfu-programmer has to be installed in the path.
+ Note: dfu-programmer has to be installed in the path, this is
+ already the case with the Fritz!Box 7390 image from fhem.de
+
If the CUL is not yet flashed, then first define a CUL
device (even if fhem won't be able to open the device), insert it with the
button pressed (this will set the device into flash-mode), then issue the
@@ -8093,13 +8097,7 @@ isday
min(a,b), max(a,b)
time_str2num("YYYY-MM-DD HH:MM:SS") returns a numerical value,
which makes computation of time differences easier
- abstime2rel("HH:MM:SS") converts an absolute time to a relative one,
- to compare it with the sunrise commands in the following example:
- # Switch lamp1 on at sunrise, but not before 07:00
- define a13 at +*{max(abstime2rel("07:00"),sunrise_rel())} set lamp1
- on
- # Note that this functionality is easier to achieve with:
- define a13 at +*{sunrise_rel(0,"07:00",undef)} set lamp1 on
+ abstime2rel("HH:MM:SS") converts an absolute time to a relative one
@@ -8136,10 +8134,8 @@ isday
By using the 99_SUNRISE_EL.pm module, you have access to the following
functions:
- sunset_rel($offset, $min, $max)
- sunset_abs($offset, $min, $max)
- sunrise_rel($offset, $min, $max)
- sunrise_abs($offset, $min, $max)
+ sunset($offset, $min, $max)
+ sunrise($offset, $min, $max)
isday()
offset is in seconds, and the format of min/max is "HH:MM" or "HH:MM:SS".
diff --git a/docs/fhem.html b/docs/fhem.html
index 33d5fde39..e15cc8565 100644
--- a/docs/fhem.html
+++ b/docs/fhem.html
@@ -81,8 +81,9 @@
Builtin pgm2 / external pgm5 web frontend:
overview,
the same rendered for smartphones,
- detail, SVG-plots.
+ detail,
+ SVG-plots,
+ dark style.
pgm3 web frontend:
+ functions out of fhem, e.g. sending mail, enabling WLAN, etc., it relies
+ only on the commands provided by a busybox copied to the chroot
+ environment.
+
+ This image from fhem.de contains a
+ stripped down version of the perl package from the AVM fhem-image, the fhem
+ package, a dfu-programmer for flashing the CUL, and a modified installation
+ script.
+
+ The main difference is starting fhem in a normal (non-chroot) environment,
+ and enabling autocreate. When installing it, you have to confirm with an
+ extra click that it does not have a valid AVM signature. It will reuse your
+ old logfiles and configuration, unlike the "original" AVM firmware.
+ Autocreate is on, and there are NO CUL devices defined in the initial
+ configuration, you'll have to do this manually, e.g. by following the HOWTO
+ or the command reference.
- This fhem-image contains a stripped
- down version of the perl package from the AVM fhem-image, a newer version
- of fhem, and a modified installation script. The main difference is
- starting fhem in a normal (non-chroot) environment, and enabling
- autocreate. When installing it, you have to confirm with an extra click
- that it does not have a valid AVM signature. It will reuse your old
- logfiles and configuration, unlike the "original" AVM firmware. Autocreate
- is on, and there are NO CUL devices defined in the initial configuration,
- you'll have to do this manually, e.g. by following the HOWTO or the command
- reference.
-Fritz!Box 7270 (as of 2011-09-03)
+Fritz!Box 7170/7270 (as of 2011-09-03)
Thank to Eyk's work there is also a ZIP file for the Fritz!Box7270. To install it:
+ href="fhem-=VERS=-fb7270.zip">ZIP file for the Fritz!Box 7170 and 7270
+ models. As the FB720/7170 has not enough internal storage to install fhem
+ on it, you have to use an external USB Drive, and this package follows a
+ different approach than the FB7390 image.To install it:
- First unzip the .ZIP file in the root directory of the USB-disk/USB-stick.
- Attach the stick to the FB
@@ -61,8 +68,8 @@
- With the command df check the name of the stick on the FB.
- Execute the following command in the FB telnet window to start fhem
when the FB reboots:
- echo "<name-of-the-stick>/fhem/startfhem" >> /var/flash/debug.cfg
- - Start fhem manually with "<name-of-the-stick>/fhem/startfhem"
+ echo "<path-of-the-stick>/fhem/startfhem" >> /var/flash/debug.cfg
+
- Start fhem manually with "<path-of-the-stick>/fhem/startfhem"
diff --git a/docs/pgm2-5.png b/docs/pgm2-5.png
new file mode 100644
index 000000000..6692da62e
Binary files /dev/null and b/docs/pgm2-5.png differ