Arduino raamatukogu tegemine YouTube'i silmis: 7 sammu

2024 Autor: John Day | [email protected]. Viimati modifitseeritud: 2024-01-30 08:47

Tere kõigile, Olen hiljuti loonud teenuse nimega YouTube Sight, mis saab YouTube Analyticsi API -st tellijate andmeid hankida ja teile täpsemat tellijate arvu pärast seda, kui YouTube hakkas tulemusi koondama. Sellega olen koostanud näidisvisandi, kuid tahtsin teha ka Arduino raamatukogu, et inimesed saaksid seda hõlpsamini kasutada.

Samm: mis on raamatukogu?

Raamatukogu on kooditükk, mis saab hakkama konkreetse toiminguga, töötleb teatud tüüpi andmeid või teab, kuidas konkreetse riistvara elemendiga suhelda. Need võimaldavad meil Arduino keskkonda hõlpsalt laiendada ja neid on palju, mis on Arduino IDE-ga eelinstallitud.

Sellistel juhtudel nagu mina, kui tahame Arduinole uusi võimalusi lisada, saame luua oma teegid, et teised saaksid neid kasutada. Kõik installitud teegid asuvad meie arvuti kindlas kaustas. Minu puhul Windows PC puhul elavad teegid kausta Dokumendid/Arduino all. Kogu tee on teie kasutajanime põhjal konkreetne.

2. samm: raamatukogu struktuur ja failid

Meie raamatukogu ehitamise alustamiseks peame kõigepealt looma siia kausta selle nimega, nii et olen loonud kausta nimega YouTube Sight. Raamatukogu minimaalses versioonis peab meil olema vähemalt kaks faili.

Esimene neist on nn päisefail, mis sisaldab kõiki meie raamatukogu pakutavate meetodite ja omaduste määratlusi, ja teine on lähtefail, mis sisaldab kogu lähtekoodi.

Päisefailide laiend on „.h”, lähtefail aga „.cpp” ja failinimeks on tavaliselt teegi nimi. Minu puhul kannavad need kaks faili nime YouTubeSight.h ja YouTubeSight.cpp.

Raamatukogu koodi kirjutamise protsess võib olla pisut tüütu ja masendav, eriti kui te kirjutate raamatukogu esmakordselt, kuid paljude katse -eksituse meetoditega saate soovitud tulemusi saavutada. Seetõttu juhendan teid läbi kahe faili valmis koodi ja selgitan seda.

Kogu kood ja kogu on GitHubist allalaadimiseks saadaval järgmisel lingil:

Samm: päisefail

Päisefaili sees on alguses kogu fail pakitud ifndef -lause sisse, mis kontrollib, kas määratud muutuja on määratletud või mitte. See väldib vigu kõigil, kes teeki kasutavad, kui lisavad selle kogemata samasse visandisse kaks korda.

Järgmisena peame kaasama Arduino baasraamatukogu ja kuna me töötame koos mõne HTTP -kliendiga, et saata päring YouTube Sightile, kaasame ka põhikliendi kogu.

Enne kui hakkame oma põhiklassi sisu kirjutama, peame määratlema kõik staatilised muutujad ja sätted, mida me ei soovi muuta. Minu puhul on selliseid muutujaid kaks. Teenuse YouTube Sight peamine URL ja ajalõpu muutuja, mida kasutame väärtuse lugemise kontrollimiseks.

Ka selles jaotises saame määratleda mis tahes kohandatud tüübid, mida soovime kasutada, nagu see kanalStatistika struktuur, kuhu tulemused salvestame.

Klassistruktuuri määratlus on jagatud kaheks osaks. Esimene osa on kõigi avalike funktsioonide ja omaduste määratlus ning teine on kõigi privaatsete funktsioonide ja omaduste määratlus. Mõlema erinevus seisneb selles, et meie raamatukogu lõppkasutajad ei saa privaatjaotisest midagi otse kasutada, samal ajal kui nad saavad avaliku osa atribuute ja funktsioone otse muuta ja kasutada.

Avalikus jaotises määratleme klassi konstruktori, muutuja channelStats, kuhu tulemused salvestame, funktsiooni, mis andmeid saab, ja silumisomaduse, mida saame hiljem kasutada juhtumite kontrollimiseks, kus me ei pruugi oodatud tulemusi saada.

Privaatsete omaduste jaoks määratleme ühe kanali GUID -i salvestamiseks, kursori kasutatavale HTTP -kliendile ja funktsiooni, mis jagab tagastatud stringi YouTube Sightist.

Samm: lähtefail

Nüüd vaatame selle tegelikku rakendamist lähtefailis.

Meie esimene samm on lisada oma päisefail, mille me just lõime, ja seejärel peame määratlema raamatukogu konstruktori. Selles edastame kaks muutujat. GUID salvestatakse privaatsesse muutujale, mille me varem määratlesime, ja klient edastatakse viitena, et saaksime helistada samale eksemplarile, mille saime.

Raamatukogu põhifunktsioon getData määratletakse järgmisena, määrates kõigepealt tagastuse tüübi, seejärel teegi nime ja funktsiooni nime. Ma ei hakka üksikasjalikult kirjeldama, mida iga rida selle funktsiooni puhul teeb, kuid üldiselt avab funktsioon ühenduse YouTube Sight serveriga, saadab taotluse statistika hankimiseks ja analüüsib seejärel tagastatavaid andmeid privaatne getValue funktsioon.

Saadud tulemused seatakse seejärel muutujale channelStats ja tagastatakse indikaator, kui meil õnnestus tulemused alla laadida või mitte ja sellega on meie raamatukogu tuum valmis.

5. samm: näidisvisandite esitamine

Tavaliselt pakub iga raamatukogu näiteid, mida saate kiiresti laadida ja kasutada, et näidata, mida raamatukogu suudab ja kuidas seda teha. Selliste näidete esitamiseks peame muutma raamatukogu struktuuri, kus nüüd on päis ja lähtefail kaustas „src” ning raamatukogu juure alla lisatakse uus kaust nimega „näited”.

Kõik sellesse kausta paigutatud Arduino visandid esitatakse teie raamatukogule näitena Arduino IDE -st ja inimesed saavad seda kiiresti uurida ja raamatukogu toimimist õppida.

6. toiming: avaldamine raamatukoguhalduris

Raamatukogu kasutamiseks peavad inimesed lihtsalt visandisse lisama teie raamatukogu päisefaili ja Arduino IDE koostab selle koos sellega. Kuid selleks peavad nad selle kõigepealt oma masinatesse installima.

Tavaline viis on raamatukogu alla laadida GitHubist ja installida see ZIP -installi kaudu IDE -sse või lihtsalt paigutada see raamatukogude kausta, nagu me seda tegime. Kuid Arduino IDE sisaldab ka tööriista, mida nimetatakse raamatukoguhalduriks ja mis võimaldab teil otsida raamatukogu otse IDE -st.

Teie raamatukogu sellesse kaasamiseks peame esmalt looma juurkausta täiendava faili nimega „library.properties” ja selles peame määrama raamatukogu nime, praeguse versiooni ja täiendava teabe, mis aitab raamatukoguhalduril et selle kohta paremat teavet kuvada.

Kui fail on paigas, tuleb Arduino GitHubi lehel luua probleem, mis palub lihtsalt teie raamatukogu lisada koos selle lingiga registrisse ja kui Arduino töötajad on selle heaks kiitnud ja lisanud, teeb raamatukoguhaldur hakata oma raamatukogu tulemustes pakkuma. Lisaks otsib haldur tulevikus GitHubi repost mis tahes versioonimärgendeid ja pakub muudatuste korral seda kasutavatele inimestele värskendust.

Samm: järgmised sammud

Loodan, et pärast seda juhendamist saate paremini aru, kuidas Arduino raamatukogud töötavad, kuidas seda luua ja mis kõige tähtsam - loodan, et saate inspiratsiooni oma järgmise suure idee kallal töötamiseks.

Kui teil on lisaküsimusi või ettepanekuid, kirjutage kommentaaridesse, tellige minu YouTube'i kanal ja järgige mind siin Instructables.