ایجاد کتابخانه آردوینو برای YouTube Sight: 7 مرحله

2024 نویسنده: John Day | [email protected]. آخرین اصلاح شده: 2024-01-30 08:53

سلام به همه،

من اخیراً سرویسی به نام YouTube Sight ایجاد کرده ام که می تواند داده های مشترکین را از API YouTube Analytics استخراج کند و تعداد مشترکان دقیق تری را از زمانی که YouTube شروع به جمع آوری نتایج کرده است ، به شما ارائه دهد. با استفاده از آن ، من یک طرح نمونه ساختم ، اما همچنین می خواستم یک کتابخانه آردوینو بسازم تا مردم بتوانند راحتتر از آن استفاده کنند.

مرحله 1: کتابخانه چیست؟

کتابخانه قطعه ای از کد است که می تواند عملیات خاصی را اداره کند ، یک نوع داده را پردازش کند یا نحوه تعامل با یک عنصر سخت افزاری خاص را بداند. آنها به ما اجازه می دهند محیط Arduino را به راحتی گسترش دهیم و تعداد زیادی از آنها با IDE Arduino از پیش نصب شده اند.

در مواردی مانند من ، که می خواهیم امکانات جدیدی به آردوینو اضافه کنیم ، می توانیم کتابخانه های خود را برای استفاده سایر افراد از آنها ایجاد کنیم. همه کتابخانه های نصب شده در یک پوشه خاص در رایانه ما زندگی می کنند. در مورد من برای رایانه Windows ، کتابخانه ها در پوشه Documents/Arduino زندگی می کنند. مسیر کامل بر اساس نام کاربری شما مخصوص شما خواهد بود.

مرحله 2: ساختار کتابخانه و فایل ها

برای شروع ساختن کتابخانه خود ، ابتدا باید یک پوشه با نام آن ایجاد کنیم ، بنابراین من یک پوشه به نام YouTube Sight ایجاد کرده ام. در حداقل نسخه کتابخانه ، ما باید حداقل دو فایل داشته باشیم.

اولین مورد یک فایل به اصطلاح "سربرگ" است که شامل تمام تعاریف روشها و ویژگیهایی است که کتابخانه ما ارائه می دهد ، و دومی فایل منبع است که شامل تمام کد منبع است.

فایلهای هدر دارای پسوند ".h" هستند در حالی که فایل منبع دارای پسوند ".cpp" است و معمولاً نام کتابخانه به عنوان نام فایل است. در مورد من ، دو فایل "YouTubeSight.h" و "YouTubeSight.cpp" نامیده می شوند.

روند نوشتن کد کتابخانه می تواند کمی خسته کننده و خسته کننده باشد ، به ویژه هنگامی که برای اولین بار کتابخانه ای می نویسید ، اما با آزمایش و خطای زیاد ، می توانید به نتایج دلخواه برسید. به همین دلیل من شما را از طریق کد نهایی دو فایل راهنمایی می کنم و آن را توضیح می دهم.

کد کامل و کتابخانه برای بارگیری از GitHub در لینک زیر موجود است:

مرحله 3: فایل سربرگ

درون فایل سرصفحه ، در ابتدا ، کل فایل درون یک عبارت ifndef قرار می گیرد که بررسی می کند آیا متغیر مشخص شده تعریف شده است یا خیر. اگر این کتابخانه را دوبار در یک طرح به اشتباه وارد کنند ، خطاهایی برای هرکسی که از کتابخانه استفاده می کند جلوگیری می کند.

در مرحله بعد ، ما باید کتابخانه اصلی Arduino را وارد کنیم و از آنجا که برای ارسال درخواست به YouTube Sight با یک سرویس گیرنده HTTP کار می کنیم ، کتابخانه اصلی Client را نیز شامل می شود.

قبل از شروع به نوشتن محتوای کلاس اصلی خود ، باید هرگونه متغیر و تنظیمات ایستایی را که نمی خواهیم اصلاح شود ، تعریف کنیم. در مورد من ، دو متغیر وجود دارد. نشانی وب اصلی سرویس YouTube Sight و متغیر timeout که برای بررسی مدت زمان خواندن یک مقدار استفاده می کنیم.

همچنین در این بخش ، ما می توانیم هر نوع سفارشی را که می خواهیم از آن استفاده کنیم مانند این ساختار کانال تعریف کنیم که نتایج را در آنها ذخیره می کنیم.

تعریف ساختار کلاس به دو قسمت تقسیم می شود. بخش اول تعریف همه توابع و ویژگی های عمومی و قسمت دوم تعریف همه توابع و ویژگی های خصوصی است. تفاوت بین هر دو این است که کاربران نهایی کتابخانه ما نمی توانند از بخش خصوصی به طور مستقیم استفاده کنند در حالی که قادر خواهند بود به طور مستقیم هر یک از ویژگی ها و توابع بخش عمومی را تغییر داده و استفاده کنند.

در بخش عمومی ، سازنده کلاس را تعریف می کنیم ، متغیر channelStats که نتایج را در آن ذخیره می کنیم ، عملکردی که داده ها را دریافت می کند و یک ویژگی اشکال زدایی است که بعداً می توانیم از آنها برای بررسی مواردی که ممکن است نتایج مورد انتظار را دریافت نکنیم ، استفاده کنیم.

برای خصوصیات خصوصی ، ما یکی را برای ذخیره کانال GUID ، یک اشاره گر به سرویس گیرنده HTTP که استفاده می کنیم و یک تابع که رشته برگشتی را از YouTube Sight جدا می کند ، تعریف می کنیم.

مرحله 4: فایل منبع

اکنون بیایید پیاده سازی واقعی همه این موارد را در داخل فایل منبع بررسی کنیم.

اولین قدم برای ما این است که فایل سرصفحه خود را که ایجاد کرده ایم اضافه کنیم و سپس باید سازنده کتابخانه را تعریف کنیم. در آن ، ما دو متغیر را عبور می دهیم. GUID در متغیر خصوصی که قبلاً تعریف کردیم ذخیره می شود و Client توسط مرجع ارسال می شود ، بنابراین می توانیم همان نمونه ای را که بدست آوردیم فراخوانی کنیم.

تابع اصلی getData کتابخانه در ابتدا با مشخص کردن نوع بازگشت و سپس نام کتابخانه و نام تابع تعریف می شود. من به جزئیات کارهایی که هر خط در این تابع انجام می دهد نمی پردازم ، اما به طور کلی ، این تابع اتصال به سرور YouTube Sight را باز می کند ، درخواست دریافت آمار را ارسال می کند و سپس داده های برگشتی را با کمک تابع getValue خصوصی

نتایج بازیابی شده سپس بر روی متغیر channelStats تنظیم می شوند و اگر ما موفق به بازیابی نتایج شدیم یا خیر و با این کار هسته کتابخانه ما کامل شده است ، یک شاخص بازگردانده می شود.

مرحله 5: ارائه طرحهای نمونه

معمولاً شما ، هر کتابخانه نمونه هایی را ارائه می دهد که می توانید به سرعت بارگذاری کرده و از آنها برای نشان دادن آنچه کتابخانه می تواند انجام دهد و نحوه انجام آن استفاده کنید. برای ارائه چنین نمونه هایی ، ما باید ساختار کتابخانه را تغییر دهیم که در آن سرصفحه و فایل منبع در یک پوشه "src" قرار می گیرد و یک پوشه جدید در زیر ریشه کتابخانه به نام "نمونه" اضافه می شود.

هر طرح آردوینو که در داخل این پوشه قرار دهید از Arduino IDE به عنوان نمونه ای برای کتابخانه شما ارائه می شود و مردم می توانند به سرعت آن را کاوش کرده و نحوه عملکرد کتابخانه را بیاموزند.

مرحله 6: انتشار برای مدیر کتابخانه

برای استفاده از کتابخانه ، افراد باید فایل سرصفحه کتابخانه شما را در طرح خود قرار دهند و Arduino IDE آن را به همراه آن بسازد. اما برای انجام این کار ، ابتدا باید آن را روی ماشین های خود نصب کنند.

یک روش معمول این است که کتابخانه را از GitHub بارگیری کنید و آن را از طریق نصب کننده ZIP در IDE نصب کنید یا به سادگی آن را مانند پوشه کتابخانه ها در هنگام ایجاد آن قرار دهید. با این حال ، Arduino IDE همچنین شامل ابزاری به نام Library Library است که به شما امکان می دهد کتابخانه ای را مستقیماً از IDE جستجو کنید.

برای قرار دادن کتابخانه خود در آن ، ابتدا باید یک فایل اضافی در پوشه اصلی به نام "libra.properties" ایجاد کنیم و در آن ، باید نام کتابخانه ، نسخه فعلی و برخی اطلاعات اضافی را که به مدیر کتابخانه کمک می کند ، مشخص کنیم. برای نمایش اطلاعات بهتر در مورد آن

با وجود فایل موجود ، باید مشکلی در صفحه Arduino GitHub ایجاد شود که به سادگی درخواست می کند که کتابخانه شما با پیوند به آن در فهرست گنجانده شود و پس از تأیید و اضافه شدن توسط کارکنان آردوینو ، مدیر کتابخانه شروع به ارائه کتابخانه خود در نتایج کنید. علاوه بر این ، مدیر در آینده به دنبال برچسب های نسخه در repo GitHub خواهد بود و به محض ایجاد تغییرات ، به روز رسانی را به افرادی که از آن استفاده می کنند ارائه می دهد.

مرحله 7: مراحل بعدی

امیدوارم بعد از این دستورالعمل ، درک بهتری از نحوه کار کتابخانه های آردوینو ، نحوه ایجاد یک کتابخانه و مهمتر از همه داشته باشید ، امیدوارم برای شروع کار روی ایده بزرگ بعدی خود انگیزه داشته باشید.

برای هر گونه سوال یا پیشنهاد اضافی ، لطفاً در نظرات بنویسید ، در کانال YouTube من مشترک شوید و در اینجا در دستورالعمل ها من را دنبال کنید.