Membuat Perpustakaan Arduino untuk Penglihatan YouTube: 7 Langkah

2024 Pengarang: John Day | [email protected]. Terakhir diubah: 2024-01-30 09:55

Halo semuanya, Baru-baru ini saya membuat layanan bernama YouTube Sight yang dapat mengekstrak data pelanggan dari YouTube Analytics API dan memberi Anda jumlah pelanggan yang lebih akurat sejak YouTube mulai mengumpulkan hasilnya. Dengan itu, saya telah membuat sketsa contoh tetapi saya juga ingin membuat perpustakaan Arduino sehingga orang dapat lebih mudah menggunakannya.

Langkah 1: Apa itu Perpustakaan?

Pustaka adalah bagian dari kode yang dapat menangani operasi tertentu, memproses jenis data, atau dapat mengetahui cara berinteraksi dengan elemen perangkat keras tertentu. Mereka memungkinkan kita untuk memperluas lingkungan Arduino dengan mudah dan ada banyak dari mereka yang sudah diinstal sebelumnya dengan Arduino IDE.

Dalam kasus seperti saya, di mana kami ingin menambahkan kemungkinan baru ke Arduino, kami dapat membuat perpustakaan kami sendiri untuk digunakan orang lain. Semua perpustakaan yang diinstal tinggal di folder tertentu di komputer kita. Dalam kasus saya untuk PC Windows, perpustakaan berada di bawah folder Documents/Arduino. Jalur lengkap akan khusus untuk Anda, berdasarkan nama pengguna Anda.

Langkah 2: Struktur dan File Perpustakaan

Untuk mulai membangun perpustakaan kita, pertama-tama kita perlu membuat folder di sini dengan nama itu jadi saya telah membuat folder bernama YouTube Sight. Dalam versi minimum perpustakaan, kita harus memiliki setidaknya dua file.

Yang pertama adalah apa yang disebut file "header" yang berisi semua definisi metode dan properti yang disediakan perpustakaan kami, dan yang kedua adalah file sumber yang akan berisi semua kode sumber.

File header memiliki ekstensi ".h" sedangkan file sumber memiliki ekstensi ".cpp" dan biasanya memiliki nama perpustakaan sebagai nama file. Dalam kasus saya, kedua file tersebut disebut "YouTubeSight.h" dan "YouTubeSight.cpp".

Proses penulisan kode perpustakaan dapat sedikit membosankan dan membuat frustrasi, terutama ketika Anda menulis perpustakaan untuk pertama kalinya, tetapi dengan banyak coba-coba, Anda dapat mencapai hasil yang diinginkan. Karena itu saya akan memandu Anda melalui kode yang sudah jadi dari kedua file tersebut dan menjelaskannya.

Kode lengkap dan perpustakaan tersedia untuk diunduh dari GitHub pada tautan berikut:

Langkah 3: File Header

Di dalam file header, pada awalnya, seluruh file dibungkus di dalam pernyataan "ifndef" yang memeriksa apakah variabel yang ditentukan didefinisikan atau tidak. Ini akan mencegah kesalahan bagi siapa saja yang menggunakan perpustakaan jika mereka memasukkannya dua kali dalam sketsa yang sama secara tidak sengaja.

Selanjutnya, kita perlu menyertakan perpustakaan Arduino dasar dan karena kita akan bekerja dengan klien HTTP untuk mengirim permintaan ke YouTube Sight, kita juga akan menyertakan perpustakaan Klien dasar.

Sebelum kita mulai menulis konten kelas utama kita, kita perlu mendefinisikan variabel statis dan pengaturan yang tidak ingin kita ubah. Dalam kasus saya, ada dua variabel seperti itu. URL utama layanan YouTube Sight dan variabel batas waktu yang akan kita gunakan untuk memeriksa berapa lama kita membaca suatu nilai.

Juga di bagian ini, kita dapat menentukan jenis kustom apa pun yang ingin kita gunakan seperti struktur ChannelStatistics tempat kita akan menyimpan hasilnya.

Definisi struktur kelas dibagi menjadi dua bagian. Bagian pertama adalah definisi semua fungsi dan properti publik dan yang kedua adalah definisi semua fungsi dan properti privat. Perbedaan antara keduanya adalah bahwa pengguna akhir perpustakaan kami tidak akan dapat menggunakan apa pun dari bagian pribadi secara langsung sementara mereka akan dapat secara langsung memodifikasi dan menggunakan properti dan fungsi apa pun dari bagian publik.

Di bagian publik, kita mendefinisikan konstruktor kelas, variabel channelStats tempat kita akan menyimpan hasil, fungsi yang akan mendapatkan data dan properti debug yang nantinya dapat kita gunakan untuk memeriksa kasus di mana kita mungkin tidak mendapatkan hasil yang diharapkan.

Untuk properti pribadi, kami akan menentukan satu untuk menyimpan GUID saluran, penunjuk ke klien HTTP yang akan kami gunakan dan fungsi yang akan membagi string yang dikembalikan dari YouTube Sight.

Langkah 4: File Sumber

Sekarang mari kita lihat implementasi sebenarnya dari semua ini di dalam file sumber.

Langkah pertama bagi kita adalah memasukkan file header kita sendiri yang baru saja kita buat dan kemudian kita perlu mendefinisikan konstruktor perpustakaan. Di dalamnya, kami melewati dua variabel. GUID disimpan ke dalam variabel pribadi yang kita definisikan sebelumnya dan Klien diteruskan dengan referensi sehingga kita dapat memanggil instance yang sama yang kita dapatkan.

Fungsi getData utama dari pustaka didefinisikan selanjutnya dengan terlebih dahulu menentukan tipe pengembalian, diikuti dengan nama pustaka dan nama fungsi. Saya tidak akan merinci apa yang dilakukan setiap baris dalam fungsi ini, tetapi secara umum, fungsi tersebut membuka koneksi ke server YouTube Sight, mengirimkan permintaan untuk mendapatkan statistik dan kemudian mem-parsing data yang dikembalikan dengan bantuan fungsi getValue pribadi.

Hasil yang diambil kemudian diatur ke variabel channelStats dan indikator dikembalikan jika kita berhasil mengambil hasil atau tidak dan dengan itu inti dari perpustakaan kita selesai.

Langkah 5: Memberikan Contoh Sketsa

Biasanya, setiap perpustakaan menyediakan contoh yang dapat Anda muat dan gunakan dengan cepat untuk menunjukkan apa yang dapat dilakukan perpustakaan dan bagaimana melakukannya. Untuk memberikan contoh seperti itu, kita perlu memodifikasi struktur perpustakaan di mana sekarang header dan file sumber akan berada di folder "src" dan folder baru akan ditambahkan di bawah akar perpustakaan yang disebut "contoh".

Sketsa Arduino apa pun yang Anda tempatkan di dalam folder ini akan disajikan dari Arduino IDE sebagai contoh untuk perpustakaan Anda dan orang-orang dapat dengan cepat menjelajahinya dan mempelajari cara kerja perpustakaan.

Langkah 6: Menerbitkan ke Manajer Perpustakaan

Untuk menggunakan perpustakaan, orang hanya perlu menyertakan file header perpustakaan Anda di sketsa mereka dan Arduino IDE akan membuatnya bersama-sama. Tetapi untuk melakukannya, pertama-tama mereka harus menginstalnya di mesin mereka.

Cara yang umum adalah mengunduh pustaka dari GitHub dan menginstalnya melalui penginstal ZIP di IDE atau cukup letakkan di dalam folder pustaka seperti yang kita lakukan saat membuatnya. Namun, Arduino IDE juga menyertakan alat, yang disebut Manajer Perpustakaan yang memungkinkan Anda untuk mencari perpustakaan langsung dari IDE.

Untuk memasukkan perpustakaan Anda di dalamnya, pertama-tama kita perlu membuat file tambahan di folder root yang disebut "library.properties" dan di dalamnya, kita perlu menentukan nama perpustakaan, versi saat ini dan beberapa info tambahan yang akan membantu manajer perpustakaan untuk menampilkan info yang lebih baik tentangnya.

Dengan file di tempat, masalah perlu dibuat di halaman Arduino GitHub yang hanya meminta perpustakaan Anda untuk dimasukkan dalam indeks dengan tautan ke sana dan setelah disetujui dan ditambahkan oleh staf Arduino, manajer Perpustakaan akan mulai menawarkan perpustakaan Anda dalam hasil. Selain itu, manajer akan mencari tag versi apa pun di repo GitHub di masa mendatang dan menawarkan pembaruan kepada orang-orang yang menggunakannya setelah ada perubahan.

Langkah 7: Langkah Selanjutnya

Saya harap setelah Instruksi ini, Anda memiliki pemahaman yang lebih baik tentang cara kerja perpustakaan Arduino, bagaimana Anda dapat membuatnya dan yang paling penting, saya harap Anda mendapatkan inspirasi untuk mulai mengerjakan ide besar Anda berikutnya.

Untuk pertanyaan atau saran tambahan, silakan tulis di komentar, berlangganan saluran YouTube saya dan ikuti saya di sini di Instructables.