Es gibt viele Libraries.
Aber ich finde keine Befehlsliste, immer nur einige Beispiele, aus denen man sich die Struktur und Notation von Befehlen zusammendichten muss.
Hab ich was übersehen?
Eigentlich ist doch die Erwartung, dass man zu jeder Library einen Befehlssatz findet, so wie es auch einen Befehlssatz für die Arduino-Rechner gibt.
Ein gerade noch positives Beispiel ist milesburton/Arduino-Temperature-Control-Library;
Dort sind wenigstens die Befehle gelistet.
Schau dir die Header Datei ein. Da siehst du zumindest was es an Methoden gibt, was dieses als Parameter erwarten und was sie zurück geben. Manchmal sind sie da auch dokumentiert.
z.B. die von dir erwähnte Library:
// initalize bus
void begin(void);// returns the number of devices found on the bus
uint8_t getDeviceCount(void);// returns true if address is valid
bool validAddress(uint8_t*);// finds an address at a given index on the bus
bool getAddress(uint8_t*, const uint8_t);// attempt to determine if the device at the given address is connected to the bus
bool isConnected(uint8_t*);
In der .cpp Datei stehen manchmal auch Kommentare
z.B. bei der PID Library:
/* Compute() **********************************************************************
- This, as they say, is where the magic happens. this function should be called
- every time "void loop()" executes. the function will decide for itself whether a new
- pid Output needs to be computed. returns true when the output is computed,
- false when nothing has been done.
**********************************************************************************/
bool PID::Compute()
{
...
}
Soul01:
Hab ich was übersehen?Eigentlich ist doch die Erwartung, dass man zu jeder Library einen Befehlssatz findet, so wie es auch einen Befehlssatz für die Arduino-Rechner gibt.
Du übersiehst, dass es sich um "Open Source" handelt, der mit offenem und kommentiertem Quellcode geliefert wird.
Schaue Dir die .h und die .cpp Dateien der Library an!
In diesen Dateien steht üblicherweise alles drin, was benötigt wird: Allgemeine Beschreibung, Funktionsbeschreibung, kommentierter Quellcode, ggf. Hinweise zur Beschaltung der Hardware.
Es gibt schon Libs die kaum bis gar nicht dokumentiert sind. Aber die sind dann oft so einfach, dass man es an Hand der Methoden-Liste im Header selbst kapiert.
An perfekt dokumentierten Libs mit extra Anleitung fallen mir UTFT, SdFat und Entropy ein.
Und was es hier gibt ist zumindest grundlegend online dokumentiert:
https://www.pjrc.com/teensy/td_libs.html
Wobei da nicht immer alle verfügbaren Funktionen aufgeführt sind.
Was auch hilft ist eine professionelle IDE mit Auto-Vervollständigung wie Atmel Studio oder Visual Studio Community Edition, jeweils mit dem Visual Micro Plugin. Da sieht man schnell was an bei allen Klassen an Methoden gibt.
Danke,
Habe die .h und .ccp Dateien mal angeschaut, das hilft weiter.
Dort sind die Befehle gelistet.
Gelistet?
Nicht ganz das richtige Wort.
In den *.h Dateien werden u.A. Funktionen (Befehle ist auch das falsche Wort) deklariert.
Sogenannte "Vorwärtsdeklarationen".
Und in den *.cpp Dateien findet dann die Definition statt.
In den *.h Dateien unter public stehen die Methoden welche die Klasse bereitstellt.
Was dort nicht immer zu sehen ist, welche Hardwareressourcen (Timer,Interrupts) werden von der Klasse benutzt.
Wenn der Autor der Lib es perfekt machen will, listet er dies in einer Doku Datei auf.
Wenn nicht muß man sich durch den cpp Code wühlen, und auch zumindest teilweise zu verstehen was dort gemacht wird.