نحوه اتصال ODROID-XU4 به ThingsConnect

مقدمه

ODROID-XU4 یک کامپیوتر تک‌برد قدرتمند است که برای وظایف محاسباتی با عملکرد بالا و کارآیی انرژی طراحی شده است.
این برد دارای یک پردازنده Cortex-A15 Exynos5422 از سامسونگ، 2 گیگابایت رم، اترنت گیگابیتی و دو پورت USB 3.0 است.
برد همچنین دارای یک شیار کارت microSD، سوکت ماژول eMMC و هدر GPIO 40 پین برای اتصال به انواع وسایل جانبی و سنسورها است.
ODROID-XU4 با انواع سیستم عامل‌ها از جمله Ubuntu، Debian و Android سازگار است.
این ویژگی‌ها آن را برای توسعه‌دهندگان، علاقمندان به سرگرمی و علاقه‌مندان DIY که به دنبال ساخت مراکز رسانه‌ای تا کنسول‌های بازی هستند، ایده‌آل می‌کند.

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

پیش‌نیازها

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

• ODROID-XU4
• کتابخانه tb-mqtt-client
• پایتون ≥ 3.7
• Adafruit-Blinka
• حساب ThingsBoard

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

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

• به نمونه 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 را در دستگاه خود ایجاد کنید.

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

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

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

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

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 استفاده می‌کنیم که هنگام تغییر مقدار ویژگی مشترک فراخوانی می‌شود. و در نهایت، callback خود را به subscriber در تابع اصلی bind می‌کنیم.

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 را برای بلافاصله دریافت داده‌های تلمتری OrangePI پیکربندی کنیم. اگر از داشبورد وارد شده استفاده می‌کنید، نیازی به پیکربندی هیچ چیزی ندارید زیرا در داشبورد خود می‌توانید ویجت زیر را مشاهده کنید:

//img

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

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

نتیجه‌گیری

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

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