From 0c724cb9fc8e38e2d2662e46bf5544a5d32c034a Mon Sep 17 00:00:00 2001 From: rudolfkoenig <> Date: Sat, 5 Dec 2009 09:00:12 +0000 Subject: [PATCH] Documentation changes git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@495 2b470e98-0d58-463d-a4d8-8e2adae1ed80 --- CHANGED | 1 + Makefile | 16 ++--- docs/HOWTO.html | 144 +++++++++++++++++++++++++------------------ docs/commandref.html | 2 +- docs/raw-codes | 22 ------- docs/rm100 | 28 --------- docs/snippet_1.txt | 74 ---------------------- docs/snippet_2.txt | 102 ------------------------------ docs/snippet_3.txt | 60 ------------------ docs/snippet_4.txt | 39 ------------ docs/snippet_5.txt | 60 ------------------ docs/snippet_6.txt | 127 -------------------------------------- docs/snippet_7.txt | 14 ----- examples/01_fs20 | 2 +- examples/02_fs20 | 2 +- examples/03_fht | 13 ++-- examples/04_log | 6 +- 17 files changed, 106 insertions(+), 606 deletions(-) delete mode 100644 docs/raw-codes delete mode 100644 docs/rm100 delete mode 100644 docs/snippet_1.txt delete mode 100644 docs/snippet_2.txt delete mode 100644 docs/snippet_3.txt delete mode 100644 docs/snippet_4.txt delete mode 100644 docs/snippet_5.txt delete mode 100644 docs/snippet_6.txt delete mode 100644 docs/snippet_7.txt diff --git a/CHANGED b/CHANGED index e2a17eaea..f13ed666e 100644 --- a/CHANGED +++ b/CHANGED @@ -551,3 +551,4 @@ - bugfix: CUL_RFR fixes (chaining RFR's should work) - bugfix: Path in the examples fixed (got corrupted) - bugfix: PachLog fixes from Axel + - bugfix: HOWTO/Examples revisited for correctness diff --git a/Makefile b/Makefile index 5819c48d7..057e83157 100644 --- a/Makefile +++ b/Makefile @@ -12,29 +12,31 @@ all: install:install-base -mv $(VARDIR)/fhem.cfg $(VARDIR)/fhem.cfg.`date "+%Y-%m-%d_%H:%M:%S"` - cp examples/sample_fhem $(VARDIR)/fhem.cfg + cp examples_changed/sample_fhem $(VARDIR)/fhem.cfg @echo @echo - @echo Edit $(VARDIR)/fhem.cfg then type + @echo Start fhem with @echo perl $(BINDIR)/fhem.pl $(VARDIR)/fhem.cfg install-pgm2:install-base cp -r webfrontend/pgm2/* $(MODDIR)/FHEM cp docs/commandref.html docs/faq.html docs/HOWTO.html $(MODDIR)/FHEM -mv $(VARDIR)/fhem.cfg $(VARDIR)/fhem.cfg.`date "+%Y-%m-%d_%H:%M:%S"` - cp examples/sample_pgm2 $(VARDIR)/fhem.cfg - cd examples; for i in *; do cp -r $$i $(MODDIR)/FHEM/example.$$i; done + cp examples_changed/sample_pgm2 $(VARDIR)/fhem.cfg + cd examples_changed; for i in *; do cp -r $$i $(MODDIR)/FHEM/example.$$i; done @echo @echo - @echo Edit $(VARDIR)/fhem.cfg then type + @echo Start fhem with @echo perl $(BINDIR)/fhem.pl $(VARDIR)/fhem.cfg install-base: mkdir -p $(BINDIR) $(MODDIR) $(VARDIR) cp fhem.pl $(BINDIR) cp -r FHEM $(MODDIR) - perl -pi -e 's,modpath \.,modpath $(MODDIR),' examples/[a-z]* - perl -pi -e 's,/tmp,$(VARDIR),' examples/[a-z]* + rm -rf examples_changed + cp -r examples examples_changed + perl -pi -e 's,modpath \.,modpath $(MODDIR),' examples_changed/[a-z]* + perl -pi -e 's,([^h]) /tmp,$$1 $(VARDIR),' examples_changed/[a-z]* dist: @echo Version is $(VERS), Date is $(DATE) diff --git a/docs/HOWTO.html b/docs/HOWTO.html index 3dd1e8830..45d539c6e 100644 --- a/docs/HOWTO.html +++ b/docs/HOWTO.html @@ -5,10 +5,6 @@

FHEMWEB Howto

- Note: Don't forget to type "save" in the FHEMWEB/pgm2 "Fhem cmd" - input field after defining a device or setting its attribute. Otherwise the - changes will disappear after the next start.

- Starting
Attaching an FHZ device
Configuring FS20 receivers
@@ -25,11 +21,17 @@

Starting

 +

+ Note: Don't forget to type "save" in the "Fhem cmd" input field of + the browser after defining a device or setting its attribute. Otherwise + the changes will disappear after the next start.

Configuring FS20 receivers

 -

Configuring FS20 transmitters

+

Misc. RF transmitters (FS20/EM/S300 etc.)

Configuring FHT devices

 @@ -103,11 +125,22 @@ @@ -141,11 +174,12 @@ FHEMWEB has builtin support for displaying FileLog type logs as plots, see the plot section below.

- See the attributes - archivedir, - archivecmd, - nrarchive - attributes for archiving the logs. + The size of each logfile will be determined by its wildcard characters + (year/month/week/day), look at the + FileLog definition. + Don't forget to enable archiving with the nrarchive or archivecmd attributes. @@ -160,33 +194,22 @@ When displaying the plot, you can convert it into a "weblink", which 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. + 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 internet browser must support SVG. Firefox and opera support SVG - out of the box, Internet Explorer does it via the Adobe "SVG viewer" - plugin. To use SVG graphics, set the plotmode attribute to SVG.

- In order to look at historic data, you can either convert at the archive - entries to weblink in "plotmode=gnuplot" mode, or use the - "plotmode=gnuplot-scroll" or "plotmode=SVG" modes. In the latter case - you'll get the possibility to zoom or scroll in the plot. Note: the + To zoom in the log you have to set plotmode to gnuplot-scroll or SVG. The gnuplot files must have #FileLog entries in order to be useable with - scrolling, as the filtering happens with the FileLog - get function, see the supplied - gnuplot files for an example.

- - 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. Don't forget to - enable archiving with the - archivedir or - archivecmd attributes. + scrolling, see the supplied gnuplot files for an example.

@@ -231,10 +254,9 @@ To display "foreign" (non fhem) files as a plot or a 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
-
-

+ define messages FileLog /var/log/messages fakelog +

Complex structures

diff --git a/docs/commandref.html b/docs/commandref.html index 259fb5336..41d5d1fb5 100644 --- a/docs/commandref.html +++ b/docs/commandref.html @@ -3403,7 +3403,7 @@ A line ending with \ will be concatenated with the next one, so long lines Attributes