„Arduino“bibliotekos kūrimas „YouTube“akims: 7 žingsniai

2024 Autorius: John Day | [email protected]. Paskutinį kartą keistas: 2024-01-30 10:45

Sveiki visi, Neseniai sukūriau paslaugą „YouTube Sight“, kuri gali išgauti prenumeratorių duomenis iš „YouTube Analytics“API ir suteikti jums tikslesnį prenumeratorių skaičių nuo tada, kai „YouTube“pradėjo kaupti rezultatus. Su juo aš sukūriau pavyzdinį eskizą, bet taip pat norėjau sukurti „Arduino“biblioteką, kad žmonės galėtų lengviau ja naudotis.

1 žingsnis: kas yra biblioteka?

Biblioteka yra kodo dalis, galinti atlikti tam tikrą operaciją, apdoroti tam tikro tipo duomenis arba žinoti, kaip sąveikauti su konkrečiu aparatūros elementu. Jie leidžia mums lengvai išplėsti „Arduino“aplinką ir yra daug jų, kurie yra iš anksto įdiegti naudojant „Arduino IDE“.

Tokiais atvejais kaip mano, kai norime „Arduino“suteikti naujų galimybių, galime sukurti savo bibliotekas, kad kiti žmonės galėtų jomis naudotis. Visos įdiegtos bibliotekos yra tam tikrame mūsų kompiuterio aplanke. Mano atveju, jei naudojate „Windows“kompiuterį, bibliotekos gyvena po aplanku „Dokumentai/Arduino“. Visas kelias bus konkretus, atsižvelgiant į jūsų vartotojo vardą.

2 veiksmas: bibliotekos struktūra ir failai

Norėdami pradėti kurti savo biblioteką, pirmiausia turime čia sukurti aplanką su jo pavadinimu, todėl sukūriau aplanką pavadinimu „YouTube Sight“. Minimalioje bibliotekos versijoje turime turėti bent du failus.

Pirmasis yra vadinamasis „antraštės“failas, kuriame yra visi mūsų bibliotekos teikiamų metodų ir savybių apibrėžimai, o antrasis-šaltinio failas, kuriame bus visas šaltinio kodas.

Antraštės failų plėtinys yra „.h“, o šaltinio - „.cpp“, o failo pavadinimas paprastai yra bibliotekos pavadinimas. Mano atveju, du failai vadinami „YouTubeSight.h“ir „YouTubeSight.cpp“.

Bibliotekos kodo rašymo procesas gali būti šiek tiek varginantis ir varginantis, ypač kai rašote biblioteką pirmą kartą, tačiau daug bandymų ir klaidų galite pasiekti norimų rezultatų. Dėl to aš jums padėsiu per baigtą dviejų failų kodą ir paaiškinsiu.

Visą kodą ir biblioteką galite atsisiųsti iš „GitHub“naudodami šią nuorodą:

3 žingsnis: antraštės failas

Antraštės failo pradžioje visas failas yra suvyniotas į „ifndef“sakinį, kuris patikrina, ar nurodytas kintamasis yra apibrėžtas, ar ne. Taip išvengsite klaidų visiems, kurie naudojasi biblioteka, jei per klaidą į tą patį eskizą įtraukia du kartus.

Be to, turime įtraukti pagrindinę „Arduino“biblioteką ir, kadangi dirbsime su tam tikru HTTP klientu, kad nusiųstume užklausą „YouTube Sight“, mes taip pat įtrauksime pagrindinę klientų biblioteką.

Prieš pradėdami rašyti savo pagrindinės klasės turinį, turime apibrėžti visus statinius kintamuosius ir nustatymus, kurių nenorime keisti. Mano atveju yra du tokie kintamieji. Pagrindinis „YouTube Sight“paslaugos URL ir skirtojo laiko kintamasis, kurį naudosime norėdami patikrinti, kiek laiko skaitome vertę.

Taip pat šiame skyriuje galime apibrėžti bet kokius pasirinktinius tipus, kuriuos norime naudoti, kaip šią kanalo statistikos struktūrą, kurioje išsaugosime rezultatus.

Klasės struktūros apibrėžimas yra padalintas į dvi dalis. Pirmoji dalis yra visų viešųjų funkcijų ir savybių apibrėžimas, o antroji - visų privačių funkcijų ir nuosavybių apibrėžimas. Skirtumas tarp abiejų yra tas, kad mūsų bibliotekos galutiniai vartotojai negalės tiesiogiai naudoti nieko iš privataus skyriaus, kol galės tiesiogiai keisti ir naudoti bet kurią viešosios dalies ypatybę ir funkcijas.

Viešajame skyriuje mes apibrėžiame klasės konstruktorių, kintamąjį „channelStats“, kuriame išsaugosime rezultatus, funkciją, kuri gaus duomenis, ir derinimo ypatybę, kurią vėliau galėsime naudoti, kad patikrintume, ar negalime gauti laukiamų rezultatų.

Privačioms nuosavybėms nustatysime vieną, skirtą kanalo GUID saugojimui, žymeklį prie naudojamo HTTP kliento ir funkciją, kuri padalins grąžintą eilutę iš „YouTube Sight“.

4 žingsnis: šaltinio failas

Dabar pažvelkime į faktinį viso to įgyvendinimą šaltinio faile.

Pirmasis mūsų žingsnis yra įtraukti savo sukurtą antraštės failą ir tada turime apibrėžti bibliotekos konstruktorių. Jame perduodame du kintamuosius. GUID įrašomas į privatų kintamąjį, kurį mes apibrėžėme anksčiau, o klientas perduodamas nuoroda, kad galėtume iškviesti tą patį egzempliorių, kurį gavome.

Pagrindinė bibliotekos „getData“funkcija apibrėžiama toliau, pirmiausia nurodant grąžinimo tipą, po to bibliotekos pavadinimą ir funkcijos pavadinimą. Nesigilinsiu į tai, ką atlieka kiekviena šios funkcijos eilutė, bet apskritai ši funkcija atveria ryšį su „YouTube Sight“serveriu, siunčia užklausą gauti statistiką ir tada analizuoja grąžintus duomenis naudodami privati „getValue“funkcija.

Gauti rezultatai nustatomi į kintamąjį „channelStats“ir grąžinamas indikatorius, jei mums pavyko gauti rezultatus, ar ne, ir mūsų bibliotekos pagrindas yra baigtas.

5 veiksmas: pateikite eskizų pavyzdžius

Paprastai kiekviena biblioteka pateikia pavyzdžių, kuriuos galite greitai įkelti ir naudoti, kad parodytumėte, ką biblioteka gali ir kaip tai padaryti. Norėdami pateikti tokių pavyzdžių, turime modifikuoti bibliotekos struktūrą, kur dabar antraštė ir šaltinio failas bus aplanke „src“, o po bibliotekos šaknimi bus pridėtas naujas aplankas, pavadintas „pavyzdžiai“.

Bet koks „Arduino“eskizas, kurį įdėsite į šį aplanką, bus pateiktas iš „Arduino IDE“kaip pavyzdys jūsų bibliotekai, ir žmonės gali greitai jį ištirti ir sužinoti, kaip biblioteka veikia.

6 veiksmas: paskelbimas bibliotekos valdytojui

Norėdami naudotis biblioteka, žmonės turės tiesiog įtraukti savo bibliotekos antraštės failą į savo eskizą ir „Arduino IDE“jį sukurs kartu. Tačiau norėdami tai padaryti, jie pirmiausia turės jį įdiegti savo mašinose.

Įprastas būdas yra atsisiųsti biblioteką iš „GitHub“ir įdiegti ją per ZIP diegimo programą IDE arba tiesiog įdėti ją į bibliotekų aplanką, kaip tai darėme kurdami. Tačiau „Arduino IDE“taip pat yra įrankis, vadinamas bibliotekos tvarkytuvu, kuris leidžia ieškoti bibliotekos tiesiai iš IDE.

Norėdami į ją įtraukti savo biblioteką, pirmiausia turime sukurti papildomą failą šakniniame aplanke pavadinimu „library.properties“ir jame nurodyti bibliotekos pavadinimą, dabartinę versiją ir papildomą informaciją, kuri padės bibliotekos valdytojui kad būtų rodoma geresnė informacija apie tai.

Įdėjus failą, „Arduino GitHub“puslapyje reikia sukurti problemą, kuri paprasčiausiai paprašo jūsų biblioteką įtraukti į indeksą su nuoroda į ją, o kai ją patvirtins ir pridės „Arduino“darbuotojai, bibliotekos vadovas pradėkite siūlyti savo biblioteką rezultatuose. Be to, valdytojas ateityje ieškos bet kokių „GitHub“atpirkimo versijos žymų ir pasiūlys atnaujinimą žmonėms, kurie ją naudoja, kai bus atlikti pakeitimai.

7 veiksmas: kiti veiksmai

Tikiuosi, kad po šios „Instructable“jūs geriau suprasite, kaip veikia „Arduino“bibliotekos, kaip galite sukurti vieną, o svarbiausia - tikiuosi, kad įkvėpsite pradėti kurti kitą didelę idėją.

Jei turite papildomų klausimų ar pasiūlymų, nedvejodami rašykite komentaruose, užsiprenumeruokite mano „YouTube“kanalą ir sekite mane čia „Instructables“.