نحوه اتصال Coral Dev Board به ThingsConnect

مقدمه

برد توسعه کرال یک رایانه تک‌برد با یک ماژول سیستمی قابل جابجایی (SOM) است که شامل پردازنده مساعدت‌کننده ML Edge TPU از گوگل است.
این برد برای توسعه دهندگانی طراحی شده است که می‌خواهند مدل‌های یادگیری ماشین را در حاشیه اجرا و پیش‌نمونه‌سازی کنند.

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

پیش‌نیازها

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

• برد توسعه کرال
• کتابخانه tb-mqtt-client
• پایتون ≥ 3.7
• Adafruit-Blinka
• حساب ThingsBoard

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

برای سادگی، ما دستگاه را به صورت دستی با استفاده از رابط کاربری ارائه خواهیم داد.

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

//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

• کد زیر را کپی و پیست کنید

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
...

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

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

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

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

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

• تابع بازخوانی ویژگی (attribute):

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

با موفقیت ویژگی‌ها و داده‌های تلمتریکی را منتشر کردید، باید به سرعت آن‌ها را در بخش “Device Telemetry” در 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

در حال حاضر، آماده‌ایم کد خود را بنویسیم. در این بخش، از پکیج‌های جدید برای چشمک زدن LED در تابع `blink` استفاده می‌کنیم. همچنین، از تابع `attribute_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 را برای دریافت داده‌های تلمتریکی OrangePI تنظیم می‌کنیم. اگر از داشبورد وارد شده استفاده می‌کنید، نیازی به تنظیم هیچ چیزی ندارید زیرا در داشبورد خود می‌توانید ابزارک زیر را مشاهده کنید:

//img

اگر یک داشبورد جدید ایجاد کنید، می‌توانید از ابزارک “دکمه RPC” برای فراخوانی یک‌طرفه RPC استفاده کنید که در بسته “ابزارک‌های کنترل” قرار دارد.

در حال حاضر، آماده‌ایم کد خود را بنویسیم. ابتدا باید تابع `rpc_callback` را ایجاد کنیم که هنگام دریافت یک RPC از سرور فراخوانی می‌شود. و همانند مثال با ویژگی‌های مشترک، باید تابع `rpc_callback` را با سابسکرایبر در تابع اصلی متصل کنیم.

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’: {}}

نتیجه‌گیری

با دانش مشخص‌شده در این راهنما، شما به سادگی می‌توانید دستگاه Coral Dev Board خود را متصل کنید و داده‌ها را به ThingsBoard ارسال کنید.

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