DevelopmentIntroduction - Versionsgeschichte

Krikan: Kategorie:Development (Archive) zugeordnet

2016-10-19T12:14:17Z

Kategorie:Development (Archive) zugeordnet

← Nächstältere Version		Version vom 19. Oktober 2016, 14:14 Uhr
Zeile 97:		Zeile 97:
	global userattr hinzufuegen.		global userattr hinzufuegen.

	[[Kategorie:Development]]		[[Kategorie:Development (Archive)]]

Yfhem: /* STATE */ Added space.

2013-11-10T18:31:18Z

STATE: Added space.

← Nächstältere Version		Version vom 10. November 2013, 20:31 Uhr
Zeile 62:		Zeile 62:


	Die Funktion '''readingsEndUpdate'''aktualisiert $hash->{STATE} grundsätzlich immer bei jedem Aufruf nach folgendem Algorithmus:		Die Funktion '''readingsEndUpdate''' aktualisiert $hash->{STATE} grundsätzlich immer bei jedem Aufruf nach folgendem Algorithmus:

	Falls $sr= $attr{$name}{stateReading} gesetzt ist:		Falls $sr= $attr{$name}{stateReading} gesetzt ist:
Zeile 80:		Zeile 80:


	Aus '''DoTrigger'''werden		Aus '''DoTrigger''' werden

	<nowiki>$defs{$dev}{STATE} = ReplaceEventMap($dev, $defs{$dev}{STATE}, 1);</nowiki>		<nowiki>$defs{$dev}{STATE} = ReplaceEventMap($dev, $defs{$dev}{STATE}, 1);</nowiki>
Zeile 89:		Zeile 89:
	$r->{state}{VAL} = $defs{$dev}{STATE} if($r && $r->{state});</nowiki>		$r->{state}{VAL} = $defs{$dev}{STATE} if($r && $r->{state});</nowiki>
	entfernt.		entfernt.





	== Global Attributes ==		== Global Attributes ==

Yfhem: /* Main Application Loop */ Clean up.

2013-11-10T16:32:05Z

Main Application Loop: Clean up.

← Nächstältere Version		Version vom 10. November 2013, 18:32 Uhr
Zeile 26:		Zeile 26:
	## For FHZ devices, the FHZ_CheckCRC method is used to validate the received data		## For FHZ devices, the FHZ_CheckCRC method is used to validate the received data
	## Call the Dispatch method in FHEM.pl to pass the message onto the correct device and corresponding module (Parse function)		## Call the Dispatch method in FHEM.pl to pass the message onto the correct device and corresponding module (Parse function)
	~~</li><li>~~ $server->fileno() is used to check for and accept new connections to the server		$server->fileno() is used to check for and accept new connections to the server
	~~</li><li>~~ For each connected client:		For each connected client:
	# Read data from the client using sysread		# Read data from the client using sysread
	# Pass the received input into the AnalyzeInput method to execute the command		# Pass the received input into the AnalyzeInput method to execute the command
	~~</li></ol>~~
	== Configuration and State Files ==		== Configuration and State Files ==
	Note that these are just lists of commands to execute in a text file! So anything in these files will be interpreted by FHEM in the exact same way if a user keys the commands manually into a client application, eg a telnet connection.		Note that these are just lists of commands to execute in a text file! So anything in these files will be interpreted by FHEM in the exact same way if a user keys the commands manually into a client application, eg a telnet connection.

Yfhem: /* Application Lifecycle */ Improved list.

2013-10-29T11:42:52Z

Application Lifecycle: Improved list.

← Nächstältere Version		Version vom 29. Oktober 2013, 13:42 Uhr
Zeile 8:		Zeile 8:
	# Application variables are initialised		# Application variables are initialised
	# The valid application commands are loaded into a structure (%cmds) with the corresponding function name to call		# The valid application commands are loaded into a structure (%cmds) with the corresponding function name to call
	# If the application has been called as a FHEM client (eg perl fhem.pl 127.0.0.1:7072 commandToExecute):		# Do the job, either act as client or server. One of the following applies:
	## Connect to the FHEM server		## If the application has been called as a FHEM client (eg perl fhem.pl 127.0.0.1:7072 commandToExecute)
	## Execute the command		### Connect to the FHEM server
	## Exit the program		### Execute the command
	~~</li><li>~~ Otherwise (the application has been started as a server)		### Exit the program
	# Execute each of the commands listed in the configuration file to initialise the server (see the CommandInclude and then the AnalyzeCommandChain methods)		## Otherwise (the application has been started as a server)
	# Execute each of the commands in the state file if configured to restore the devices to the last state recorded when the server last ran		### Execute each of the commands listed in the configuration file to initialise the server (see the CommandInclude and then the AnalyzeCommandChain methods)
	# Start the main application loop		### Execute each of the commands in the state file if configured to restore the devices to the last state recorded when the server last ran
	~~</li></ol>~~		### Start the main application loop

	== Main Application Loop ==		== Main Application Loop ==
	The following code is repeated until the application ends:		The following code is repeated until the application ends:

Markusbloch: /* Global Attributes */

2013-05-13T19:23:01Z

Global Attributes

← Nächstältere Version		Version vom 13. Mai 2013, 21:23 Uhr
Zeile 99:		Zeile 99:
	Weiterhin kann jedes Modul im Initialize mit addToAttrList eigene Attribute zu		Weiterhin kann jedes Modul im Initialize mit addToAttrList eigene Attribute zu
	global userattr hinzufuegen.		global userattr hinzufuegen.

			[[Kategorie:Development]]

Generix: Die Seite wurde neu angelegt: „= Developer's Introduction to FHEM = == Introduction == This page is intended to give an introduction to the FHEM application from a developer's perspective. I…“

2013-05-10T20:41:10Z

Die Seite wurde neu angelegt: „= Developer's Introduction to FHEM = == Introduction == This page is intended to give an introduction to the FHEM application from a developer's perspective. I…“

Neue Seite

= Developer's Introduction to FHEM =
== Introduction ==
This page is intended to give an introduction to the FHEM application from a developer's perspective. If you're interested in extending, modifying or reusing the FHEM code, then hopefully you will find this a useful document. Note that this document is a work in progress! I myself at the time of writing this have only a few hours of experience under my belt, but I'm documenting things I learn as I learn them.

== Application Lifecycle ==
When you first launch the FHEM server, the following activities take place:

# Application variables are initialised
# The valid application commands are loaded into a structure (%cmds) with the corresponding function name to call
# If the application has been called as a FHEM client (eg perl fhem.pl 127.0.0.1:7072 commandToExecute):
## Connect to the FHEM server
## Execute the command
## Exit the program
</li><li> Otherwise (the application has been started as a server)
# Execute each of the commands listed in the configuration file to initialise the server (see the CommandInclude and then the AnalyzeCommandChain methods)
# Execute each of the commands in the state file if configured to restore the devices to the last state recorded when the server last ran
# Start the main application loop
</li></ol>
== Main Application Loop ==
The following code is repeated until the application ends:

# For each input device (eg FHZ1000 / FHZ1300 / CUL):
## Use that device module's Ready and Read functions to read data from the device
## For CUL devices, the data is read and parsed at this point
## For FHZ devices, the FHZ_CheckCRC method is used to validate the received data
## Call the Dispatch method in FHEM.pl to pass the message onto the correct device and corresponding module (Parse function)
</li><li> $server->fileno() is used to check for and accept new connections to the server
</li><li> For each connected client:
# Read data from the client using sysread
# Pass the received input into the AnalyzeInput method to execute the command
</li></ol>
== Configuration and State Files ==
Note that these are just lists of commands to execute in a text file! So anything in these files will be interpreted by FHEM in the exact same way if a user keys the commands manually into a client application, eg a telnet connection.

== Readings ==
The following mechanism is recommended for updating readings. It saves lines of codes and automatically makes your module honor the event-on-update-reading and event-on-change-reading attributes.

Before you start updating readings, write (in case $hash = $defs{<device>})

<nowiki>readingsBeginUpdate($hash);</nowiki>
For every reading you update, write

<nowiki>readingsBulkUpdate($hash,$reading,$value);</nowiki>
Terminate with

<nowiki>readingsEndUpdate($hash, $dotrigger);</nowiki>
The $dotrigger parameter should be 0 for updates initiated by fhem message dispatcher as the dispatcher already calls DoTrigger on its behalf. $dotrigger should be 1 for updates initiated by internal timers, e.g. for polling devices.

As a shorthand notation for updating just one reading write

<nowiki>readingsSingleUpdate($hash,$reading,$value,$dotrigger);</nowiki>
which is the same as

<nowiki>readingsBeginUpdate($hash);
readingsBulkUpdate($hash,$reading,$value);
readingsEndUpdate($hash, $dotrigger);</nowiki>
== STATE ==
Vorschlag zur Umsetzung, diskutiert [https://groups.google.com/forum/?hl=de&fromgroups#!topic/fhem-developers/vqCx4M4X5l0 hier].

In den [[DevelopmentGuidelines]], Kapselung, Standardisierung der Vorgehensweise.

Die Funktion '''readingsEndUpdate'''aktualisiert $hash->{STATE} grundsätzlich immer bei jedem Aufruf nach folgendem Algorithmus:

Falls $sr= $attr{$name}{stateReading} gesetzt ist:

<nowiki>Fall 1: wenn $sr =~ "^{.*}$" dann eval "\$hash->{STATE} = $sr";
Fall 2: sonst $hash->{STATE}= $hash->{READINGS}{$sr}{VAL}</nowiki>
sonst

<nowiki>Falls es $hash->{READINGS}{state} gibt, $hash->{STATE}= $hash->{READINGS}{state}{VAL}</nowiki>
sonst

<nowiki>Tue nichts (das Modul hat sich gekuemmert).</nowiki>
Ausserdem wird

<nowiki>ReplaceEventMap()</nowiki>
losgelassen, um die EventMaps des Anwenders auch im STATE zur Anwendung zu bringen.

Aus '''DoTrigger'''werden

<nowiki>$defs{$dev}{STATE} = ReplaceEventMap($dev, $defs{$dev}{STATE}, 1);</nowiki>
und

<nowiki># STATE && {READINGS}{state} should be the same
my $r = $defs{$dev}{READINGS};
$r->{state}{VAL} = $defs{$dev}{STATE} if($r && $r->{state});</nowiki>
entfernt.

== Global Attributes ==
In fhem.pl existiert ein

<nowiki>my $AttrList = "room comment alias ...";</nowiki>
Weiterhin kann jedes Modul im Initialize mit addToAttrList eigene Attribute zu
global userattr hinzufuegen.