syntax van library-functies

[KC52 Profiel Privébericht]

Hoi,

Ik ben pas bezig met Arduino en kom nu op het punt om libraries te gebruiken.
Hoe of waar kan ik zien welke functies er gemaakt zijn in zo'n library en hoe de syntax van elke functie er uitziet ?
Ik heb de .cpp en .h files al eens proberen te bekijken maar daar wordt ik niet veel wijzer van.
Nog een aanvullende vraag: Met wat voor editor kun je die files het best bekijken...kladblok blijkt niet werkbaar.

al vast bedankt
Kees

[Koepel Profiel Privébericht]

Voor Windows gebruik ik al heel lang Akelpad, maar ik neem aan dat anderen zo hun eigen voorkeur voor een editor hebben.
http://akelpad.sourceforge.net/

Dan de libraries, tja, soms (zeg maar regelmatig, of misschien zelfs vaak) is het toch echt nodig om in de *.cpp en *.h files te kijken.

De bedoeling is dit:

Probeer eerst de Library Manager te gebruiken om iets binnen te halen.
Of gebruik een *.zip file van Github, gebruik de Arduino IDE om die *.zip library te installeren.

Daarna kun je via het menu de voorbeelden bekijken. Die voorbeelden maken het meeste al duidelijk.
Vervolgens kun je informatie opzoeken over die library. Via de Library Manager kun je vaak naar een website en bij Github is de 'wiki' ingevuld als je geluk hebt.

Als dat nog niet genoeg is, dan de broncode van de *.cpp en *.h bekijken en op een forum vragen hoe het zit.

[nicoverduin Profiel PrivéberichtWebsite]

Er zijn tools om de documentatie volledig te genereren uit de source code. Dit betekent wel dat men een stijl moet hanteren zodat het tool deze documentatie ook daadwerkelijk eruit kan halen. Doxygen is vrij populair en kan een complete website genereren uit een library of programma. voorbeeld: http://malawi.verelec.nl dit kun je volledig genereren uit een sketch mits je de discipline hebt om goed te documenteren.
Om een goede library te maken zou ik zeker eens wat tijd steken in C++ classes en OO. Uiteindelijk zijn de meeste libs gewoon een of meerdere classes. Verder moet je wat bestandjes maken zodat de IDE herkent wat de sleutelwoorden (functies) zijn in de lib en een paar voorbeelden in een examples folder.

Overigens ik werk met Eclipse-Arduino plugin nu voor een aantal jaren omdat ik daar mee een ontwikkel omgeving heb voor meerdere platformen en programmeertalen. Maar als je dat wilt gebruiken zul je daar eerst tijd in moeten steken om er goed mee overweg te kunnen.

[shooter Profiel Privébericht]

een library moet je zien als een stuk gereedschap, en daar hoort eigenlijk een manual bij. Echter het blijft allemaal hobby en dus wil dat nog wel eens misgaan.

ja als je de cpp (ofwel de source leest) dan kun je vaak een eind komen.