Skip to content

Commit e6c757d

Browse files
author
Marko Oldenburg
committed
move and rename API.de API description
change README.m API.de description
1 parent 4b8aad2 commit e6c757d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/API.de.md renamed to docs/API.de/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ Da sich die API selbst noch in Entwicklung befindet, sollte vor jedem neuen API-
88

99
Das Modul muss zwingend Objektorientiert geschrieben werden. Man sollte sich also schon einmal damit befasst haben um zu verstehen, wie so ein objektorientiertes Modul funktioniert.
1010

11-
Der Packagename muß im Format `<SERIVCE_NAME>API::Weather` angegeben werden, also z.B.
11+
Alle API Moduldateien für 59_Weather.pm werden unter `lib/FHEM/APIs/Weather/` abgelegt
1212

13-
package FoobarAPI::Weather
13+
Der Packagename muß im Format `FHEM::APIs::Weather<SERIVCE_NAME>API` angegeben werden, also z.B.
14+
15+
package FHEM::APIs::Weather::FoobarAPI
1416

1517
für den Wetter-Service Foobar.
1618

@@ -70,9 +72,9 @@ Wird `LOCATION` und `LANGUAGE` beim Define des Devices nicht angeben, wird von `
7072

7173
Es müssen zwingend zwei Objektmethoden vorhanden sein. `Weather` wird dann über den Konstruktor eine neue Instanz als Instanzvariable anlegen. Über diese Instanzvariablen werden dann die zwei Methodenaufrufe durchgeführt.
7274

73-
`$objsetRetrieveData` wird in `Weather` in der GetUpdate-Funktion aufgerufen.
75+
`$obj->setRetrieveData` wird in `Weather` in der GetUpdate-Funktion aufgerufen.
7476

75-
`$objgetWeather` wird in der `CallbackFn-Funktion aufgerufen um die Daten aus dem API-Modul zu erhalten. Vorher muss aus dem API-Modul heraus die `CallbackFn` aufgerufen und der Name der `Weather`-Instanz übergeben werden: `Weather_CallbackFn(devName);`
77+
`$obj->getWeather` wird in der `CallbackFn-Funktion aufgerufen um die Daten aus dem API-Modul zu erhalten. Vorher muss aus dem API-Modul heraus die `CallbackFn` aufgerufen und der Name der `Weather`-Instanz übergeben werden: `Weather_CallbackFn(devName);`
7678

7779
Für beide Methodenaufrufe **muss** eine entsprechende Methode existieren. Das ist Pflicht.
7880

0 commit comments

Comments
 (0)