نحوه اتصال HummingBoard Gate به ThingsConnect

مقدمه

HummingBoard Gate یک کامپیوتر تک‌تراشه‌ای است که برای اینترنت اشیا و خانه‌های هوشمند طراحی شده است. این برد دارای پردازنده قدرتمند NXP i.MX6 است و انواع گزینه‌های اتصالی از جمله اترنت، وای‌فای و بلوتوث را ارائه می‌دهد. این برد با مجموعه‌ای از سیستم‌عامل‌ها سازگار است و برای برنامه‌های مختلف از مراکز رسانه‌ای تا پروژه‌های خانه هوشمند ایده‌آل است.

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

پیش‌نیازها

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

• HummingBoard Gate
• کتابخانه tb-mqtt-client
• python ≥ 3.7
• Adafruit-Blinka
• حساب کاربری ThingsBoard

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

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

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

//img

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

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

pip3 install tb-mqtt-client

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

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

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

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

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

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

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

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

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

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

تابع بازخورد ویژگی

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 استفاده می‌کنیم که هنگام تغییر مقدار ویژگی مشترک، فراخوانی خواهد شد. و در نهایت، 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 خود را با 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’: {}}

نتیجه‌گیری

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

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