Krijimi i një biblioteke Arduino për YouTube Sight: 7 hapa

2024 Autor: John Day | [email protected]. E modifikuara e fundit: 2024-01-30 12:16

Pershendetje te gjitheve, Kohët e fundit kam ndërtuar një shërbim të quajtur YouTube Sight që mund të nxjerrë të dhënat e pajtimtarëve nga YouTube Analytics API dhe t'ju japë numërime më të sakta të pajtimtarëve që kur YouTube filloi të grumbullonte rezultatet. Me të, unë kam ndërtuar një skicë shembull, por gjithashtu kam dashur të bëj një bibliotekë Arduino në mënyrë që njerëzit ta përdorin më lehtë.

Hapi 1: Çfarë është një bibliotekë?

Një bibliotekë është një pjesë e kodit që mund të trajtojë një operacion të veçantë, të përpunojë një lloj të dhënash ose të dijë të ndërveprojë me një element specifik të harduerit. Ato na lejojnë të zgjerojmë me lehtësi mjedisin Arduino dhe ka shumë prej tyre që vijnë të para-instaluar me Arduino IDE.

Në raste si e imja, ku duam t'i shtojmë mundësi të reja Arduino -s, ne mund të krijojmë bibliotekat tona që njerëzit e tjerë t'i përdorin ato. Të gjitha bibliotekat e instaluara jetojnë në një dosje të veçantë në kompjuterin tonë. Në rastin tim për kompjuterin Windows, bibliotekat jetojnë nën dosjen Documents/Arduino. Rruga e plotë do të jetë specifike për ju, bazuar në emrin tuaj të përdoruesit.

Hapi 2: Struktura dhe skedarët e bibliotekës

Për të filluar ndërtimin e bibliotekës sonë, së pari duhet të krijojmë një dosje këtu me emrin e saj, kështu që unë kam krijuar një dosje të quajtur YouTube Sight. Në versionin minimal të bibliotekës, duhet të kemi të paktën dy skedarë.

E para është një e ashtuquajtur skedar "header" që përmban të gjitha përkufizimet e metodave dhe vetive që ofron biblioteka jonë, dhe e dyta është skedari burimor që do të përmbajë të gjithë kodin burimor.

Skedarët e kokës kanë një shtrirje prej ".h" ndërsa skedari burimor ka një shtrirje prej ".cpp" dhe zakonisht kanë emrin e bibliotekës si emrin e skedarit. Në rastin tim, të dy skedarët quhen "YouTubeSight.h" dhe "YouTubeSight.cpp".

Procesi i shkrimit të kodit të bibliotekës mund të jetë pak i lodhshëm dhe frustrues, veçanërisht kur po shkruani një bibliotekë për herë të parë, por me shumë prova dhe gabime, mund të arrini rezultatet e dëshiruara. Për shkak të kësaj unë do t'ju udhëheq përmes kodit të përfunduar të dy skedarëve dhe do ta shpjegoj atë.

Kodi i plotë dhe biblioteka janë në dispozicion për shkarkim nga GitHub në lidhjen e mëposhtme:

Hapi 3: Skedari i kokës

Brenda skedarit të kokës, në fillim, i gjithë skedari mbështillet brenda një deklarate "ifndef" e cila kontrollon nëse ndryshorja e specifikuar është përcaktuar apo jo. Kjo do të parandalojë gabimet për këdo që përdor bibliotekën nëse e përfshinë atë dy herë në të njëjtën skicë gabimisht.

Tjetra, ne duhet të përfshijmë bibliotekën bazë Arduino dhe meqenëse do të punojmë me një klient HTTP të një lloji për të dërguar kërkesën në YouTube Sight, ne gjithashtu do të përfshijmë bibliotekën bazë të Klientit.

Para se të fillojmë të shkruajmë përmbajtjen e klasës sonë kryesore, duhet të përcaktojmë çdo ndryshore dhe cilësim statik që nuk duam të modifikohet. Në rastin tim, ekzistojnë dy ndryshore të tilla. URL -ja kryesore e shërbimit YouTube Sight dhe ndryshorja e kohës që do të përdorim për të kontrolluar sa kohë lexojmë një vlerë.

Gjithashtu në këtë seksion, ne mund të përcaktojmë çdo lloj të personalizuar që duam të përdorim si ky strukturë e strukturës së statistikave në të cilën do t'i ruajmë rezultatet.

Përkufizimi i strukturës së klasës ndahet në dy pjesë. Pjesa e parë është përcaktimi i të gjitha funksioneve dhe pronave publike dhe e dyta është përcaktimi i të gjitha funksioneve dhe pronave private. Dallimi midis të dyve është se përdoruesit përfundimtarë të bibliotekës sonë nuk do të jenë në gjendje të përdorin asgjë drejtpërdrejt nga seksioni privat, ndërsa ata do të jenë në gjendje të modifikojnë dhe përdorin drejtpërdrejt ndonjë nga pronat dhe funksionet nga pjesa publike.

Në seksionin publik, ne përcaktojmë konstruktorin e klasës, variablin channelStats ku do të ruajmë rezultatet, funksionin që do të marrë të dhënat dhe një veti debug që mund të përdorim më vonë për të kontrolluar për rastet kur mund të mos marrim rezultatet e pritura.

Për pronat private, ne do të përcaktojmë një për ruajtjen e kanalit GUID, një tregues për klientin HTTP që do të përdorim dhe një funksion që do të ndajë vargun e kthyer nga YouTube Sight.

Hapi 4: Skedari Burimor

Tani le të shohim zbatimin aktual të gjithë kësaj brenda skedarit burimor.

Hapi i parë për ne është të përfshijmë skedarin tonë të titullit që sapo kemi krijuar dhe më pas duhet të përcaktojmë konstruktorin e bibliotekës. Në të, ne kalojmë dy ndryshore. GUID ruhet në variablin privat që kemi përcaktuar më herët dhe Klienti kalon me referencë, kështu që ne mund të thërrasim të njëjtën shembull që kemi marrë.

Funksioni kryesor getData i bibliotekës përcaktohet më pas duke specifikuar së pari llojin e kthimit, i ndjekur nga emri i bibliotekës dhe emri i funksionit. Unë nuk do të hyj në detaje se çfarë bën çdo linjë e vetme në këtë funksion, por në përgjithësi, funksioni hap një lidhje me serverin YouTube Sight, dërgon kërkesën për të marrë statistikat dhe më pas analizon të dhënat e kthyera me ndihmën e funksioni privat getValue.

Rezultatet e marra më pas vendosen në ndryshoren channelStats dhe një tregues kthehet nëse kemi arritur të marrim rezultatet ose jo dhe me këtë thelbi i bibliotekës sonë është i plotë.

Hapi 5: Sigurimi i Skicave Shembull

Zakonisht ju, çdo bibliotekë jep shembuj që mund t'i ngarkoni dhe përdorni shpejt për të treguar se çfarë mund të bëjë biblioteka dhe si ta bëjë atë. Për të dhënë shembuj të tillë, ne duhet të modifikojmë strukturën e bibliotekës ku tani titulli dhe skedari burimor do të jenë në një dosje "src" dhe një dosje e re do të shtohet nën rrënjën e bibliotekës të quajtur "shembuj".

Çdo skicë Arduino që vendosni brenda këtij dosje do të shërbehet nga Arduino IDE si një shembull për bibliotekën tuaj dhe njerëzit mund ta eksplorojnë shpejt atë dhe të mësojnë se si funksionon biblioteka.

Hapi 6: Publikimi te Menaxheri i Bibliotekës

Për të përdorur bibliotekën, njerëzit do të duhet të përfshijnë thjesht skedarin e titullit të bibliotekës tuaj në skicën e tyre dhe Arduino IDE do ta ndërtojë atë së bashku me të. Por për ta bërë këtë, ata së pari do të duhet ta instalojnë atë në makinat e tyre.

Një mënyrë e zakonshme është të shkarkoni bibliotekën nga GitHub dhe ta instaloni përmes instaluesit ZIP në IDE ose thjesht ta vendosni brenda dosjes së bibliotekave siç bëmë kur e krijuam. Sidoqoftë, Arduino IDE gjithashtu përfshin një mjet, të quajtur Menaxheri i Bibliotekës që ju lejon të kërkoni një bibliotekë direkt nga IDE.

Për të përfshirë bibliotekën tuaj në të, së pari duhet të krijojmë një skedar shtesë në dosjen rrënjë të quajtur "libra.properties" dhe në të, ne duhet të specifikojmë emrin e bibliotekës, versionin aktual dhe disa informacione shtesë që do të ndihmojnë menaxherin e bibliotekës për të shfaqur informacion më të mirë në lidhje me të.

Me skedarin në vend, duhet të krijohet një çështje në faqen Arduino GitHub që thjesht kërkon që biblioteka juaj të përfshihet në indeks me lidhjen me të dhe pasi të miratohet dhe shtohet nga stafi i Arduino, menaxheri i Bibliotekës filloni të ofroni bibliotekën tuaj në rezultate. Për më tepër, menaxheri do të kërkojë çdo etiketë të versionit në repon e GitHub në të ardhmen dhe do të ofrojë një përditësim për njerëzit që e përdorin atë pasi të ketë ndryshime.

Hapi 7: Hapat e ardhshëm

Shpresoj që pas këtij Udhëzuesi, të keni një kuptim më të mirë se si funksionojnë bibliotekat Arduino, si mund të krijoni një dhe më e rëndësishmja, shpresoj që të frymëzoheni për të filluar punën në idenë tuaj të ardhshme të madhe.

Për çdo pyetje ose sugjerim shtesë mos ngurroni të shkruani në komente, regjistrohuni në kanalin tim në YouTube dhe më ndiqni këtu në Instructables.