Library Funktionen

Hallo zusammen,

ich arbeite schon länger hobbymäßig mit Arduinos, stoße aber immer wieder auf ein Problemchen. Einige Librariey sind ja recht einfach gehalten, aber wenn ich komplexere habe, gibt es nur (so vorhanden) die Beispielsketche, nach denen ich Funkionen aufrufen kann.

Gibt es nicht generell eine Möglichkeit, alle Funktionen einer Library zu ermitteln?

Gucky.

Ihr Beitrag wurde an seinen aktuellen Speicherort verschoben, da er besser geeignet ist.

@gucky_87

wirf einen Blick in die .h Dateien - da hast normalerweise die konkrete Definitionen und oft auch sinnvolle Kommentare.
Machmal sind diese Dateien auch im Unterverzeichnis
src
der jeweiligen Library

Der Großteil gut gepflegter Lib's wird mit einer Keywords.txt ausgeliefert, in der sind die Namen der verfügbaren Funktionen, die dann für eine farbliche Darstellung in der IDE sorgen, enthalten.
Oft werden auch insgesamt alle Funktionen extern beschrieben. z.B. für die neopixel: Adafruit NeoPixel Library: Adafruit_NeoPixel Class Reference

Und wenn alles nicht hilft, dann in der .cpp nachsehen, was drin steht.

Danke für die Tipps.
Ich hatte das mit den ".cpp" und ".h" Dateien selber schon herausgefunden, aber es ist doch etwas umständlich :wink:
Solch eine Dokumentation würde ich an sich von den Programmieren erwarten.
Wwas machen die, wenn sie nach Monaten/Jahren selber nicht mehr wissen, wo was steht?
Na ja, dann wde ich diesen Umweg wohl beschreiten müssen.

@my_xy_projekt:
Ich bin schon länger bei AZ zufriedener Kunde. Was Dokumentationen angeht, sind die wirklich super.
Ich meinte aber z.B. Libs von GitHub, etc.
Da finde ich zwar eine 'Keywords.txt', aber dort steht leider oftmal Käse drin oder nichts wirklich verwertbares.

Danke für Eure Ausführungen,

Gucky.

Schraube deine Erwartungen runter: Viele Programmierer wollen programmieren - nicht Doku schreiben.
Fast noch schlimmer sind die generierten Dokumentationen ala Doxygen. Da kann man überwiegend auch gleich in die .h reinschauen.
Immer daran denken, dass du all die Libs für lau bekommst, daher etwas die Erwartungen anpassen :wink:

und weil du gerade AZ erwähnst: genau den Laden solltest du künftig meiden, denn die registrieren aktuell viele Begriffe als Wortmarke - und da kann nichts Gutes dabei rauskommen wenn ein Vertrieb das macht. Da wird es noch einige Überraschungen geben!

Du kannst ja selber mal eine Abfrage machen:
https://register.dpma.de/DPMAregister/marke/basis

und bei Applicant schreibst AZ-Delivery Vertriebs GmbH rein.

all diese Warenzeichen beansprucht AZ?
MAX7219, HT16K33, HD44780, DS18B20 ...

Ob das auf Dauer gut für die Preise auf Amazon/Ebay/Ali gut ist sei dahingestellt.

Oha. Da sind eine Menge gängiger Modulbezeichnungen und Bauteilnummern dabei, für die die internationalen Produzenten vermutlich nicht rechtzeitig Widersprüche einlegen werden. Und ein Aufhebungsverfahren ist langwierig.

Ob da jemand ein zweites Standbein über Abmahnungen aufbauen will?

In Github kann jeder alles einstellen.
Das Problem beim Internet ist immer das Finden.
Mist muss man erkennen können und mühsam ist es auch.

Immerhin liefert AZ brauchbare Dokus, fast so gut wie Adafruit.

Naja, darüber kann man wohl geteilter Meinung sein.

Da wird auch schon mal ein IC auf dem Modul beschrieben, der überhaupt nicht verbaut ist, sondern eine abgespeckte Version davon. Die natürlich kein I2C kann, wie es beworben wurde.
Auch wenn man ihnen die richtigen Daten liefert, braucht es Monate, bis es geändert wird. Beispiel.

Gruß Tommy

Nun, ich programmiere seit vielen Jahren selber und dokumentiere immer alles. Allein schon, damit ich selber mich nach Jahren noch im Code zurechtfinde. Das macht zwar manchmal echt Arbeit, ich sehe es aber auch als Vorteil.
Freunde scherzen immer, dass ich mehr Kommentare als Quellcode schreiben würde (lach).

Mag sein, doch wen juckt das, wenn man rein privat bastelt?
Wenn ich es natürlich öffentlich dokumentiere, muss ich mich eh auch um sowas kümmern - leider Gottes...
Aber danke für diesen doch nicht ganz unwichtigen Hinweis :wink:

Na ja, ok, aber besser als dass man etwas kauft und da ist rein gar nichts dabei. Z.B. mein DCF77 Modul. Erst nach langer Suche habe ich durch Platinen, bzw. Aufbauvergleich herausgefunden, woher das Ding kommt und dann irgendwann auch ein PDF dazu gefunden.
Bisher habe ich mit denen jedenfalls noch keine Probleme gehabt.
Ich habe mal 5 Nanos dort über Amazon bestellt, es kamen aber 10 zum Preis von 5. Ich wollte die überzähligen zurücksenden, als Antwort bekam ich sinngemäß: "Behalt sie, vie Spaß damit."

Das kannst Du allerdings sehr laut sagen...

Gucky.

Also ich kaufe erst, wenn ich wenigstens zum IC ein Datenblatt gefunden habe.
Keine Info => kein Kauf

Gruß Tommy

Ich normalerweise auch nicht, aber in der Artikelbeschreibung stand, dass man das PDF per Mail bekommt, gleich nach der Bestellung. Nun rate...... :wink:

Gucky.

Hast Du das wenigstens in einer negativen Bewertung als Fehler des Versenders beschrieben?

Gruß Tommy

Yep :wink:

Und ich habe für alle anderen sogar den Link zum PDF dort gepostet, weil ich es immer sehr nervig finde, wenn andere schreiben, dass sie z.B. ein PDF, etc. gfunden haben, es aber schön für sich behalten.

Gucky.

1 Like