نحوه اتصال Rock64 به ThingsConnect

مقدمه

راک 64 (Rock64) یک کامپیوتر تک برد طراحی شده است تا یک راه حل قدرتمند و کارآمد در یک فرم فاکتور کوچک ارائه دهد. این برد بر پایه پردازنده چهار هسته ای ARM Cortex-A53 Rockchip RK3328 ساخته شده است که عملکرد قابل اعتماد و کارآیی انرژی را ارائه می‌دهد. برد دارای 1GB، 2GB یا 4GB حافظه RAM LPDDR3 است و همچنین یک شیار کارت microSD برای حافظه قابل ارتقاء دارد. همچنین این برد دارای یک پورت USB 3.0، یک پورت USB 2.0 و یک سربرگ GPIO 40 پین است که به آن امکان اتصال به انواع دستگاه‌ها و حسگرها را می‌دهد. راک 64 با انواع سیستم‌عامل‌ها از جمله Debian، Ubuntu و Android اجرا می‌شود که آن را به یک انتخاب عالی برای توسعه‌دهندگان، هواخواهان و علاقمندان DIY می‌کند که به دنبال ساخت هر چیزی از مراکز رسانه‌ای تا سیستم‌های خانه هوشمند هستند. فرم فاکتور کوچک، عملکرد قدرتمند و اتصالات چند منظوره آن آن را به یک افزودنی ارزشمند برای هر پروژه که به یک راه حل محاسباتی قابل اعتماد و کارآمد نیاز دارد تبدیل می‌کند.

در این راهنما، خواهیم آموخت که چگونه یک دستگاه در Thingsboard ایجاد کنیم، کتابخانه‌ها و ابزارهای مورد نیاز را نصب کنیم. سپس کد خود را تغییر داده و آن را بر روی دستگاه بارگذاری کنیم و نتایج کدنویسی خود را بررسی و داده‌ها را در ThingsBoard با استفاده از داشبورد وارد شده بررسی کنیم. دستگاه ما با استفاده از قابلیت درخواست‌های مشترک و ویژگی‌های درخواست‌های سمت کلاینت با ThingsBoard همگام می‌شود. البته، خواهیم توانست کنترل دستگاه خود را با استفاده از ویژگی‌های ارائه شده مانند ویژگی‌های مشترک یا درخواست‌های RPC صورت دهیم.

پیش نیازها

برای ادامه کار با این راهنما، موارد زیر را نیاز خواهیم داشت:

• راک 64 (Rock64)
• کتابخانه tb-mqtt-client
• پایتون ≥ 3.7
• Adafruit-Blinka
• حساب ThingsBoard

ایجاد دستگاه در ThingsBoard

به منظور سهولت، ما دستگاه را به صورت دستی با استفاده از رابط کاربری (UI) ایجاد خواهیم کرد.

• به نسخه ThingsBoard خود وارد شوید و به “موجودیت‌ها” بروید. سپس بر روی صفحه “دستگاه‌ها” کلیک کنید.
• بر روی آیکون “+” در گوشه بالا و راست جدول کلیک کنید و سپس “اضافه کردن دستگاه جدید” را انتخاب کنید.
• نام دستگاه را وارد کنید. به عنوان مثال، “دستگاه من”. در این زمان تغییر دیگری لازم نیست. برای اضافه کردن دستگاه، بر روی “اضافه کردن” کلیک کنید.
• دستگاه شما اضافه شده است.

//img

نصب کتابخانه‌ها و ابزارهای مورد نیاز

شما باید کتابخانه thingsboard-python-client-sdk را نصب کنید که می‌توانید از دستور زیر استفاده کنید. با این حال، ما توصیه می‌کنیم که پکیج‌ها را خارج از محیط عمومی نصب کنید:

pip3 install tb-mqtt-client

همچنین، باید ابزارهایی که امکان ویرایش کد را فراهم می‌کنند را داشته باشید، برای مثال، می‌توانید از ویرایشگر Nano که به صورت پیش فرض وجود دارد استفاده کنید یا هر ویرایشگر کد دیگری که با آن آشنایی دارید را نصب کنید.

اتصال دستگاه به ThingsBoard

برای اتصال دستگاه، ابتدا باید اطلاعات اعتبار دستگاه را دریافت کنید. ThingsBoard از انواع مختلفی از اعتبارهای دستگاه پشتیبانی می‌کند. ما توصیه می‌کنیم از اعتبارهای پیش فرض و خودکار تولید شده استفاده کنید که برای این راهنما یک توکن دسترسی است.

• روی ردیف دستگاه در جدول کلیک کنید تا جزئیات دستگاه را باز کنید.
• روی “کپی توکن دسترسی” کلیک کنید. توکن در کلیپ بورد شما کپی خواهد شد. لطفاً آن را در یک مکان ایمن ذخیره کنید.

//هimg
حالا آماده هستید تا داده‌های تلمتری را به نمایندگی از دستگاه خود منتشر کنید. همانطور که قبلاً اشاره شد، از کتابخانه thingsboard-python-client-sdk استفاده خواهیم کرد. بیایید پروژه‌ی خود را راه‌اندازی کنیم:

• پوشه پروژه را ایجاد کنید:

mkdir thingsboard_example && cd thingsboard_example

• نصب بسته ها:

pip install tb-mqtt-client

• ایجاد اسکریپت اصلی:

nano main.py

• کد زیر را کپی و Paste کنید:

import logging.handlers
import time
import os
   
from tb_gateway_mqtt import TBDeviceMqttClient
   
ACCESS_TOKEN = "TEST_TOKEN"
THINGSBOARD_SERVER = 'demo.thingsboard.io'
THINGSBOARD_PORT = 1883

logging.basicConfig(level=logging.DEBUG)
   
client = None
   
# default blinking period
period = 1.0
   
   
# callback function that will call when we will change value of our Shared Attribute
def attribute_callback(result, _):
     print(result)
     # make sure that you paste YOUR shared attribute name
     period = result.get('blinkingPeriod', 1.0)

# callback function that will call when we will send RPC
def rpc_callback(id, request_body):
    # request body contains method and other parameters
    print(request_body)
    method = request_body.get('method')
    if method == 'getTelemetry':
        attributes, telemetry = get_data()
        client.send_attributes(attributes)
        client.send_telemetry(telemetry)
    else:
        print('Unknown method: ' + method)
   
   
def get_data():
    cpu_usage = round(float(os.popen('''grep 'cpu ' /proc/stat | awk '{usage=($2+$4)*100/($2+$4+$5)} END {print usage }' ''').readline().replace('\n', '').replace(',', '.')), 2)
    ip_address = os.popen('''hostname -I''').readline().replace('\n', '').replace(',', '.')[:-1]
    mac_address = os.popen('''cat /sys/class/net/*/address''').readline().replace('\n', '').replace(',', '.')
    processes_count = os.popen('''ps -Al | grep -c bash''').readline().replace('\n', '').replace(',', '.')[:-1]
    swap_memory_usage = os.popen("free -m | grep Swap | awk '{print ($3/$2)*100}'").readline().replace('\n', '').replace(',', '.')[:-1]
    ram_usage = float(os.popen("free -m | grep Mem | awk '{print ($3/$2) * 100}'").readline().replace('\n', '').replace(',', '.')[:-1])
    st = os.statvfs('/')
    used = (st.f_blocks - st.f_bfree) * st.f_frsize
    boot_time = os.popen('uptime -p').read()[:-1]
    avg_load = (cpu_usage + ram_usage) / 2
   
    attributes = {
        'ip_address': ip_address,
        'macaddress': mac_address
    }
    telemetry = {
        'cpu_usage': cpu_usage,
        'processes_count': processes_count,
        'disk_usage': used,
        'RAM_usage': ram_usage,
        'swap_memory_usage': swap_memory_usage,
        'boot_time': boot_time,
        'avg_load': avg_load
    }
    print(attributes, telemetry)
    return attributes, telemetry
   
# request attribute callback
def sync_state(result, exception=None):
     global period
     if exception is not None:
         print("Exception: " + str(exception))
     else:
         period = result.get('shared', {'blinkingPeriod': 1.0})['blinkingPeriod']

def main():
     global client
     client = TBDeviceMqttClient(THINGSBOARD_SERVER, THINGSBOARD_PORT, ACCESS_TOKEN)
     client.connect()
     client.request_attributes(shared_keys=['blinkingPeriod'], callback=sync_state)
        
     # now attribute_callback will process shared attribute request from server
     sub_id_1 = client.subscribe_to_attribute("blinkingPeriod", attribute_callback)
     sub_id_2 = client.subscribe_to_all_attributes(attribute_callback)

     # now rpc_callback will process rpc requests from server
     client.set_server_side_rpc_request_handler(rpc_callback)

     while not client.stopped:
         attributes, telemetry = get_data()
         client.send_attributes(attributes)
         client.send_telemetry(telemetry)
         time.sleep(60)
   
if __name__=='__main__':
    if ACCESS_TOKEN != "TEST_TOKEN":
        main()
    else:
        print("Please change the ACCESS_TOKEN variable to match your device access token and run script again.")

در کد بالا، مقادیر متغیرهای زیر – THINGSBOARD_SERVER، ACCESS_TOKEN را به اعتبارنامه خود تغییر دهید.

متغیرهای لازم برای اتصال:

//جدول

• برای ذخیره کردن فایل، کلیدهای Ctrl+X و سپس Ctrl+O را فشار دهید.
• و در نهایت، بیایید اسکریپت خود را اجرا کنیم:

python3 main.py

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

> INFO:tb_device_mqtt:connection SUCCESS
> 
> 
> {'ip_address': '192.168.1.198', 'macaddress': '3c:06:30:44:e0:24'} {'cpu_usage': 6.6, 'processes_count': 8, 'disk_usage': 70.0, 'RAM_usage': 73.9, 'swap_memory_usage': 69.4, 'battery': 29, 'boot_time': 1675154176.0}
>

بیایید کد خود را مرور کرده و توضیحی برای آن بدهیم. در این مرحله، ما به تابع get_data علاقه‌مند هستیم. در این تابع، داده‌ها بسته‌بندی و در یک دیکشنری برگشت داده می‌شوند، بنابراین شما می‌توانید به سادگی تلمتری‌ها یا ویژگی‌های جدید را به دیکشنری اضافه کنید اگر می‌خواهید مقادیر دیگری را نظارت کنید:

...
def get_data():
       cpu_usage = round(float(os.popen('''grep 'cpu ' /proc/stat | awk '{usage=($2+$4)*100/($2+$4+$5)} END {print usage }' ''').readline().replace('\n', '').replace(',', '.')), 2)
       ip_address = os.popen('''hostname -I''').readline().replace('\n', '').replace(',', '.')[:-1]
       mac_address = os.popen('''cat /sys/class/net/*/address''').readline().replace('\n', '').replace(',', '.')
       processes_count = os.popen('''ps -Al | grep -c bash''').readline().replace('\n', '').replace(',', '.')[:-1]
       swap_memory_usage = os.popen("free -m | grep Swap | awk '{print ($3/$2)*100}'").readline().replace('\n', '').replace(',', '.')[:-1]
       ram_usage = float(os.popen("free -m | grep Mem | awk '{print ($3/$2) * 100}'").readline().replace('\n', '').replace(',', '.')[:-1])
       st = os.statvfs('/')
       used = (st.f_blocks - st.f_bfree) * st.f_frsize
       boot_time = os.popen('uptime -p').read()[:-1]
       avg_load = (cpu_usage + ram_usage) / 2
   
       attributes = {
           'ip_address': ip_address,
           'macaddress': mac_address
       }
       telemetry = {
           'cpu_usage': cpu_usage,
           'processes_count': processes_count,
           'disk_usage': used,
           'RAM_usage': ram_usage,
           'swap_memory_usage': swap_memory_usage,
           'boot_time': boot_time,
           'avg_load': avg_load
       }
       print(attributes, telemetry)
       return attributes, telemetry
...

قسمت ارسال داده، همانطور که در زیر مشاهده می‌کنید، ما ویژگی‌ها و داده‌های تلمتری خود را هر 60 ثانیه ارسال می‌کنیم (اگر می‌خواهید بروزرسانی داده‌ها بیشتری را تجربه کنید، می‌توانید آن را تغییر دهید):

...		
    while not client.stopped:
        attributes, telemetry = get_data()
        client.send_attributes(attributes)
        client.send_telemetry(telemetry)
        time.sleep(60)
...

همگام‌سازی وضعیت دستگاه با استفاده از درخواست کاربر و ویژگی مشترک

توجه داشته باشید که برای دستگاه خود ویژگی مشترک blinkingPeriod را ایجاد کنید.

به منظور دریافت وضعیت دستگاه از ThingsBoard در طول بوت شدن، قابلیتی برای این کار در کد وجود دارد. بخش‌های مربوط به این کار در کد نمونه عبارتند از:

بازخوانی ویژگی (Attribute callback):

def sync_state(result, exception=None):
    global period
    if exception is not None:
        print("Exception: " + str(exception))
    else:
        period = result.get('shared', {'blinkingPeriod': 1.0})['blinkingPeriod']

درخواست ویژگی:

def main():
    client = TBDeviceMqttClient("thingsboard.cloud", 1883, "ACCESS_TOKEN")
    client.connect()
    client.request_attributes(shared_keys=['blinkingPeriod'], callback=sync_state)
    ...

برای اینکه قابلیت دریافت داده‌ها توسط تابع‌های بازخورد ممکن باشد، باید یک درخواست به ThingsBoard ارسال کنیم. این قابلیت به ما اجازه می‌دهد تا پس از راه‌اندازی مجدد، وضعیت فعلی را حفظ کنیم.

بررسی داده‌ها در ThingsBoard

بعد از موفقیت‌آمیز بودن انتشار ویژگی‌ها و داده‌های تلمتری، باید آن‌ها را به طور فوری در تب تلمتری دستگاه مشاهده کنید:

بر روی ردیف دستگاه در جدول کلیک کنید تا جزئیات دستگاه را باز کنید.
به تب تلمتری رفته و داده‌ها را بررسی کنید.

//img
همچنین، بیایید ویژگی‌ها و داده‌های تلمتری برد تک برد را در یک داشبورد نمایش دهیم. برای این کار، می‌توانید یک داشبورد سفارشی با ابزارهای سفارشی خود ایجاد کنید یا از یک داشبورد آماده استفاده کرده و آن را وارد کنید.

کنترل دستگاه با استفاده از ویژگی‌های مشترک

فراموش نکنید که ویژگی مشترک blinkingPeriod را در دستگاه خود ایجاد کنید.

علاوه بر این، می‌توانیم با استفاده از قابلیت بروزرسانی ویژگی مشترک، دوره‌ی چشمک‌زنی را تغییر دهیم.

این نوع ویژگی فقط برای دستگاه‌ها در دسترس است. آن مشابه ویژگی‌های سمت سرور است اما تفاوت مهمی دارد. نرم‌افزار/برنامه دستگاه می‌تواند مقدار ویژگی‌های مشترک را درخواست کند یا به بروزرسانی ویژگی‌ها مشترک شود. مورد استفاده رایج‌ترین ویژگی‌های مشترک ذخیره کردن تنظیمات دستگاه است.

برای اجرای کد این بخش از راهنما، توصیه می‌کنیم از Python 3.9 یا بالاتر استفاده کنید.

اگر Python را نصب نکرده‌اید، لطفاً مراحل زیر را دنبال کنید:

sudo apt update
sudo apt install software-properties-common

sudo add-apt-repository ppa:deadsnakes/ppa

sudo apt install python3.9

sudo apt-get install -y python3 git python3-pip

همچنین، نیازمند کتابخانه Adafruit-Blinka هستیم. لطفاً از دستور زیر برای نصب آن استفاده کنید:

pip3 install Adafruit-Blinka

در حال حاضر، آماده هستیم که کد خود را بنویسیم. در این قسمت، از بسته‌های جدید برای تابش (blink) LED خود استفاده می‌کنیم در تابع blink. همچنین، از تابع attribute_callback نیز استفاده می‌کنیم که وقتی مقدار ویژگی مشترک ما تغییر کند، فراخوانی خواهد شد. و در نهایت، callback خود را به subscriber در تابع اصلی متصل می‌کنیم.

import digitalio
import board

...

# default blinking period
period = 1.0

# callback function that will call when we will change value of our Shared Attribute
def attribute_callback(client, result):
    print(client, result)
    # make sure that you paste YOUR shared attribute name
    period = result.get('blinkingPeriod', 1.0)

def main():
    ...
    # make sure that you paste YOUR shared attribute name
    sub_id_1 = client.subscribe_to_attribute("blinkingPeriod", attribute_callback)
    sub_id_2 = client.subscribe_to_all_attributes(attribute_callback)
    led = digitalio.DigitalInOut(board.PD14)
    led.direction = digitalio.Direction.OUTPUT
    ...
    led.value = True
    time.sleep(period)
    led.value = False
    time.sleep(period)

همچنین، اگر از داشبورد وارد شده استفاده می‌کنید، می‌توانید با استفاده از ویجت زیر، که در گوشه پایین سمت راست داشبورد مشاهده می‌کنید، دوره چشمک زدن را تغییر دهید:

//img

کنترل دستگاه با استفاده از RPC

ThingsBoard به شما امکان ارسال فراخوانی‌های رومزی (RPC) از برنامه‌های سمت سرور به دستگاه‌ها و بالعکس را می‌دهد. در واقع، این ویژگی به شما امکان ارسال دستورات به/از دستگاه‌ها و دریافت نتایج اجرای دستور را می‌دهد.

در این راهنما، ما دستور RPC را برای به دست آوردن داده‌های تلمتری اورنج‌پای را فوراً پیکربندی خواهیم کرد. اگر از داشبورد وارد شده استفاده می‌کنید، نیازی به پیکربندی هیچ چیزی ندارید، زیرا در داشبورد شما می‌توانید ابزارک زیر را مشاهده کنید:

//img

💡 اگر داشبورد جدیدی ایجاد می‌کنید، می‌توانید از ابزارک “دکمه RPC” برای ارتباط یکطرفه RPC استفاده کنید که در بسته “ابزارهای کنترل” قرار دارد.
حالا، آماده هستیم که کد خود را بنویسیم. ابتدا باید تابع rpc_callback را ایجاد کنیم که در هنگام دریافت RPC از سرور فراخوانی خواهد شد. و همانند نمونه‌ای که با ویژگی‌های مشترک استفاده شده است، نیاز است تا تابع فراخوانی rpc خود را با subscriber در تابع اصلی مرتبط کنیم.

client = None

...

# callback function that will call when we will send RPC
def rpc_callback(id, request_body):
    # request body contains method and other parameters
    print(request_body)
    method = request_body.get('method')
    if method == 'getTelemetry':
        attributes, telemetry = get_data()
        client.send_attributes(attributes)
        client.send_telemetry(telemetry)
    else:
        print('Unknown method: ' + method)

...

def main():
    ...

    # now rpc_request_response will process rpc requests from server
    client.set_server_side_rpc_request_handler(rpc_callback)

    ...

به طور نهایی، بیایید دکمه خود را فشار داده و داده‌های OrangePI را دریافت کنیم:

//img

همچنین، اگر همه چیز را به درستی انجام داده‌اید، باید خروجی کنسول زیر را مشاهده کنید:

{‘method’: ‘getTelemetry’, ‘params’: {}}

نتیجه‌گیری

با دانشی که در این راهنما آورده شده است، می‌توانید به راحتی Rock64 خود را متصل کرده و داده‌ها را به ThingsBoard ارسال کنید.

برای دریافت اطلاعات بیشتر درباره مفاهیم و ویژگی‌های کلیدی، به مستندات پلتفرم مراجعه کنید. به عنوان مثال، می‌توانید قوانین هشدارها یا داشبوردها را پیکربندی کنید.