DevelopmentUpdate

2018-03-27T21:10:27Z

Rudolfkoenig:

== Updatemechanismus ==

Wenn der Benutzer den FHEM-Befehl update in seiner FHEM-Installation aufruft, werden aus allen Repositories, die er für Updates registriert hat, aktualisierte Dateien heruntergeladen. Dieser Artikel beschreibt den Mechanismus hinter der Bereitstellung des Updates aus dem zentralen FHEM-Repository.

Jeden Tag um 7:45 Uhr wird auf dem FHEM-Updateserver fhemupdate.pl (siehe contrib) ausgeführt. Danach kann ein Benutzer von FHEM die zu diesem Zeitpunkt neuesten Dateien per update-Befehl beziehen. Abends in SVN-Repository eingecheckte Dateien stehen damit am nächsten Morgen per Update zur Verfügung.

fhemupdate.pl stellt im SVN-Repository neue und geänderte Dateien aus FHEM, FHEM/lib sowie einige weitere Dateien von FHEM sowie CUL-Firmware für das Update bereit. Die Liste der Dateien steht am Anfang von contrib/fhemupdate.pl. Insbesondere werden außer den Dateien zur Erzeugung der commandref keine Dateien aus contrib über update verteilt.

Ohne weiteres Zutun löscht das Update keine Dateien in der Installation des Users, wenn diese im SVN-Repository fehlen, und liefert auch keine neuen Verzeichnisse und darin enthaltene Dateien aus.

fhemupdate.pl wird von Rudolf König gepflegt. Ein Entwickler, der neue Verzeichnisse und deren Inhalte über Update verteilen möchte oder Dateien in den Benutzerinstallationen per Update löschen lassen möchte, stellt diesen Wunsch zunächst im [https://forum.fhem.de/index.php/board,48.0.html Forum im Board FHEM Development] zur Diskussion. Hintergrund ist es, die Entwicklung in geordnete Bahnen zu lenken. Da es in der Natur von FHEM liegt, mit unterschiedlichen Systemen zu kommunizieren, wird es nur natürlich sein, dass immer mehr Fremdpakete in FHEM abgelegt werden sollen.
Es soll einerseits den Anwendern das Leben leicht gemacht werden, andererseits soll aber FHEM weder den Paketmanager des Systems ersetzen noch als Repository für Fremdsoftware dienen.

[[Kategorie:Development]]

DevelopmentFHEMWEB

2013-07-25T12:33:34Z

Rudolfkoenig: FW_docdir removed,

This page describes the FHEMWEB module from a developer's perspective.
= Global Variables =

The following global variables are used throughout FHEMWEB, and should be used if you are extending it:

<dl><dt>$FW_ME<dd> When using FHEMWEB, you have to specify a base path in all requests, this value is stored in the variable $FW_ME and defaults to /fhem. The user may change it by setting the webname attribute.
</dl>

<dl><dt>$FW_dir<dd> base directory from which FHEMWEB serves files. Defaults to $attr{global}{modpath}/www.
</dl>

<dl><dt>$FW_icondir<dd> base directory from which FHEMWEB serves icons. Defaults to $FW_dir/images.
</dl>

<dl><dt>$FW_cssdir<dd> base directory from which FHEMWEB serves HTML and SVG style sheets and javascript files. Defaults to $FW_dir/pgm2.
</dl>

<dl><dt>$FW_gplotdir<dd> base directory where FHEMWEB searches for gplot files. Defaults to $FW_dir/gplot.
</dl>

= Special URLs =
You can request any file directly by specifying its exact path starting with $FW_dir, but there are also some special URLs available:

== Icons ==
[http://hostname:port/ http://hostname:port/]<webname>/icons/<device>

This is the standard mechanism to get an icon representing a device.

For finding an icon for a device, the directories are scanned by the iconPath FHEMWEB attribute, default ist stylesheetDir:fhemSVG:openautomation:default. Then the icon is chosen depending on the device name,type and state. The user can specify a devStateIcon to change this behaviour, and the module can also override it by specifying its FW_summaryFn, see below.

Due to historic reasons, you can still load any image from the iconPath directly by specifying its name without extension, but this feature may go away in the future.

== Documentation ==
[http://hostname:port/ http://hostname:port/]<webname>/docs/file

This is the standard mechanism to retrieve documentation, especially commandref.html: [http://hostname:port/ http://hostname:port/]<webname>/docs/commandref.html.

== Usage in your own code ==
If you need an icon to be visualized in a web site, use the function FW_makeImage(<icon>). It returns the img tag for the icon plus a comment where the icon is located. It even return an error message if no icon file exists that fits the requested logical name.

Other useful functions are FW_iconPath(<icon>) to determine the full(!) path to the icon, e.g. $FW_icondir/dark/lamp.off.png. and FW_IconURL(<icon>) to determine the URL of the icon, e.g. [http://hostname:port/ http://hostname:port/]<webname>/icons/lamp.off.

= Plugins =
FHEMWEB provides some meachnisms to plug-in own functionality. To do so, own routines can be registered in the hashes $data or $hash respectively, see details below.
== FW_detailFn ==
Provides the possibility to display additional data on the details-screen of a device, will be dosplayed above the "Internals"-section.
Registration in a modules' initialize-Routine:
$hash->{FW_detailFn} = "my_Routine";
my_Routine will be called with the parameters $FW_wname, $deviceName, $FW_room. Have a look at 01_FHEMWEB.pm for examples.
== FW_summaryFn==
Provides the possibility to display own data instead of the state-icon of a device.
Registration in a modules' initialize-Routine:
$hash->{FW_summaryFn} = "my_Routine";
my_Routine will be called with the parameters $FW_wname, $deviceName, $FW_room. Have a look at 01_FHEMWEB.pm for examples.
The return-value of my_routine can bei any of
* html-code, checked by regexp <.*>
* empty (""), will display the state as a text link usual
* undef, will continue the default search mechanism for a matching icon for STATE

== webCmdFn ==
Provides the possibility to display own data instead of the command-list of a device.
Registration in a modules' initialize-Routine:
$data{webCmdFn}{myModule} = "my_Routine";
my_Routine will be called with parameters $FW_wname, $deviceName, $FW_room, $cmd, $values.

For more details refer to [http://forum.fhem.de/index.php?t=msg&th=12460&goto=74762&rid=86#msg_74762 the original thread in fhem-forum].
[[Kategorie:Development]]

FHEMWiki - Benutzerbeiträge [de]

DevelopmentUpdate

DevelopmentFHEMWEB