From e6c757d1f25d69c1d577f0c4800808e287db39f8 Mon Sep 17 00:00:00 2001 From: Marko Oldenburg Date: Sat, 24 Dec 2022 04:48:42 +0100 Subject: [PATCH] move and rename API.de API description change README.m API.de description --- docs/{API.de.md => API.de/README.md} | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) rename docs/{API.de.md => API.de/README.md} (92%) diff --git a/docs/API.de.md b/docs/API.de/README.md similarity index 92% rename from docs/API.de.md rename to docs/API.de/README.md index d0e4d68..488ba0b 100644 --- a/docs/API.de.md +++ b/docs/API.de/README.md @@ -8,9 +8,11 @@ Da sich die API selbst noch in Entwicklung befindet, sollte vor jedem neuen API- 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. -Der Packagename muß im Format `API::Weather` angegeben werden, also z.B. +Alle API Moduldateien für 59_Weather.pm werden unter `lib/FHEM/APIs/Weather/` abgelegt - package FoobarAPI::Weather +Der Packagename muß im Format `FHEM::APIs::WeatherAPI` angegeben werden, also z.B. + + package FHEM::APIs::Weather::FoobarAPI für den Wetter-Service Foobar. @@ -70,9 +72,9 @@ Wird `LOCATION` und `LANGUAGE` beim Define des Devices nicht angeben, wird von ` 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. -`$obj→setRetrieveData` wird in `Weather` in der GetUpdate-Funktion aufgerufen. +`$obj->setRetrieveData` wird in `Weather` in der GetUpdate-Funktion aufgerufen. -`$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);` +`$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);` Für beide Methodenaufrufe **muss** eine entsprechende Methode existieren. Das ist Pflicht.