Arduino könyvtár készítése a YouTube látványához: 7 lépés

2024 Szerző: John Day | [email protected]. Utoljára módosítva: 2024-01-30 09:40

Sziasztok, Nemrég építettem egy YouTube Sight nevű szolgáltatást, amely ki tudja vonni a feliratkozók adatait a YouTube Analytics API -ból, és pontosabb előfizetői számokat tud adni azóta, hogy a YouTube elkezdte összesíteni az eredményeket. Ezzel készítettem egy példa vázlatot, de szerettem volna egy Arduino könyvtárat is készíteni, hogy az emberek könnyebben tudják használni.

1. lépés: Mi az a könyvtár?

A könyvtár egy kódrészlet, amely képes kezelni egy adott műveletet, feldolgozni egy bizonyos típusú adatot, vagy tudni tudja, hogyan léphet kapcsolatba egy adott hardverelemmel. Lehetővé teszik számunkra, hogy könnyen kiterjesszük az Arduino környezetet, és sok közülük előre telepítve van az Arduino IDE-vel.

Az olyan esetekben, mint az enyém, ahol új lehetőségeket szeretnénk hozzáadni az Arduino -hoz, saját könyvtárakat hozhatunk létre, hogy mások is használhassák azokat. Az összes telepített könyvtár a számítógépünk egy adott mappájában található. Esetemben a Windows PC esetében a könyvtárak a Dokumentumok/Arduino mappa alatt élnek. A teljes útvonal az Ön számára lesz specifikus, a felhasználónév alapján.

2. lépés: A könyvtár szerkezete és fájljai

A könyvtárunk építésének megkezdéséhez először létre kell hoznunk egy mappát a nevével, így létrehoztam a YouTube Sight nevű mappát. A könyvtár minimális verziójában legalább két fájlnak rendelkeznünk kell.

Az első egy úgynevezett „fejléc” fájl, amely tartalmazza a könyvtárunk által biztosított módszerek és tulajdonságok összes definícióját, a második pedig a forrásfájl, amely az összes forráskódot tartalmazza.

A fejlécfájlok kiterjesztése „.h”, míg a forrásfájl kiterjesztése „.cpp”, és általában a könyvtár neve szerepel fájlnévként. Esetemben a két fájl neve „YouTubeSight.h” és „YouTubeSight.cpp”.

A könyvtári kód írásának folyamata kissé fárasztó és frusztráló lehet, különösen akkor, ha először ír könyvtárat, de sok kísérlettel és hibával elérheti a kívánt eredményt. Ezért végigvezetem a két fájl kész kódján, és elmagyarázom.

A teljes kód és a könyvtár letölthető a GitHub webhelyről az alábbi linkről:

3. lépés: A fejlécfájl

A fejlécfájl belsejében kezdetben a teljes fájl egy „ifndef” utasításba van csomagolva, amely ellenőrzi, hogy a megadott változó definiálva van -e vagy sem. Ez megakadályozza a hibákat bárki számára, aki használja a könyvtárat, ha véletlenül kétszer is belefoglalja ugyanabba a vázlatba.

Ezután be kell vonnunk az alap Arduino könyvtárat, és mivel valamilyen HTTP -ügyféllel fogunk együtt dolgozni, hogy elküldjük a kérést a YouTube Sight -nak, be fogjuk vonni az alap ügyfélkönyvtárat is.

Mielőtt elkezdenénk írni a fő osztályunk tartalmát, meg kell határoznunk minden olyan statikus változót és beállítást, amelyet nem szeretnénk módosítani. Az én esetemben két ilyen változó létezik. A YouTube Sight szolgáltatás fő URL -je és az időtúllépési változó, amellyel ellenőrizni fogjuk, hogy mennyi ideig olvasunk egy értéket.

Ebben a szakaszban is meghatározhatunk minden egyéni típust, amelyet használni szeretnénk, mint ez a csatornastatisztikai struktúra, ahová mentjük az eredményeket.

Az osztálystruktúra meghatározása két részre oszlik. Az első rész az összes nyilvános funkció és tulajdonság meghatározása, a második pedig az összes privát funkció és tulajdonság meghatározása. A különbség mindkettő között az, hogy könyvtárunk végfelhasználói nem használhatnak semmit közvetlenül a privát részből, miközben közvetlenül módosíthatják és használhatják a nyilvános rész bármely tulajdonságát és funkcióját.

A nyilvános részben definiáljuk az osztálykonstruktor, a channelStats változó helyét, ahol az eredményeket tároljuk, az adatokat lekérő függvény és egy hibakeresési tulajdonság, amelyet később használhatunk annak ellenőrzésére, hogy nem kapjuk -e meg a várt eredményeket.

A magántulajdonoknál definiálunk egyet a csatorna GUID -jének tárolására, mutatót az általunk használt HTTP -ügyfélre, és egy funkciót, amely szétválasztja a visszaadott karakterláncot a YouTube Sight szolgáltatásból.

4. lépés: A forrásfájl

Most nézzük meg mindezek tényleges megvalósítását a forrásfájlban.

Az első lépés számunkra, hogy belefoglaljuk a saját fejlécfájlunkat, amelyet most hoztunk létre, majd meg kell határoznunk a könyvtár konstruktorát. Ebben két változót adunk át. A GUID a korábban definiált privát változóba kerül, és az ügyfelet referenciaként továbbítják, így ugyanazt a példányt hívhatjuk meg, mint amit kaptunk.

A könyvtár fő getData függvényét határozzuk meg, ha először megadjuk a visszatérési típust, majd a könyvtár nevét és a függvény nevét. Nem részletezem, hogy ebben a funkcióban minden egyes sor mit tesz, de általában a funkció megnyitja a kapcsolatot a YouTube Sight szerverrel, elküldi a kérést a statisztikák lekérésére, majd elemzi a visszaadott adatokat a a privát getValue függvényt.

A lekért eredményeket ezután a channelStats változóra állítjuk, és egy mutatót adunk vissza, ha sikerült lekérnünk az eredményeket, vagy sem, és ezzel teljes a könyvtárunk magja.

5. lépés: Példavázlatok megadása

Általában Ön minden könyvtárban talál példákat, amelyeket gyorsan betölthet és felhasználhatja annak bemutatására, hogy mire képes a könyvtár és hogyan. Az ilyen példák bemutatásához módosítanunk kell a könyvtár szerkezetét, ahol most a fejléc és a forrásfájl egy „src” mappában lesz, és egy új mappa kerül hozzáadásra a könyvtár gyökere alá, „példák” néven.

Bármely Arduino -vázlatot, amelyet ebbe a mappába helyez, az Arduino IDE szolgáltatja példaként a könyvtár számára, és az emberek gyorsan felfedezhetik azt és megtanulhatják a könyvtár működését.

6. lépés: Közzététel a Könyvtárkezelőben

A könyvtár használatához az embereknek egyszerűen bele kell foglalniuk a könyvtáruk fejlécfájlját a vázlatukba, és az Arduino IDE együtt fogja felépíteni. De ehhez először telepíteniük kell a gépeikre.

Gyakori módszer a könyvtár letöltése a GitHub -ból, és a ZIP telepítőn keresztül történő telepítése az IDE -ben, vagy egyszerűen a könyvtárak mappába helyezése, ahogy azt a létrehozáskor tettük. Az Arduino IDE azonban tartalmaz egy eszközt is, amelyet Könyvtárkezelőnek hívnak, és amely lehetővé teszi, hogy közvetlenül az IDE -ből keressen könyvtárat.

Ahhoz, hogy a könyvtárat belefoglalhassuk, először létre kell hoznunk egy további fájlt a „library.properties” nevű gyökérmappában, és meg kell adnunk a könyvtár nevét, az aktuális verziót és néhány további információt, amelyek segítenek a könyvtárkezelőben hogy jobb információkat jelenítsen meg róla.

Ha a fájl a helyén van, egy olyan problémát kell létrehozni az Arduino GitHub oldalon, amely egyszerűen kéri, hogy a könyvtárat vegye fel az indexbe a hivatkozással, és miután az Arduino személyzete jóváhagyta és hozzáadta, a könyvtárkezelő kezdje el kínálni könyvtárát az eredmények között. Ezenkívül a menedzser a jövőben megkeresi a GitHub repó bármely verziócímkéjét, és frissítéseket kínál a felhasználóknak, amint változásokat észlelnek.

7. lépés: Következő lépések

Remélem, hogy az Instructable után jobban megérti az Arduino könyvtárak működését, hogyan hozhat létre egyet, és ami a legfontosabb, remélem, hogy inspirációt kap a következő nagy ötlet kidolgozásához.

Ha bármilyen további kérdése vagy javaslata van, írjon megjegyzéseket, iratkozzon fel YouTube -csatornámra, és kövessen itt az Instructables oldalon.