نحوه اتصال Orange Pi Zero به ThingsConnect

مقدمه

Orange Pi Zero برای هر کسی است که میخواهد با فناوری آفرینش کند، نه فقط آن را مصرف کند. این ابزار ساده، سرگرم کننده و مفیدی است که میتوانید از آن برای کنترل دنیای اطراف خود استفاده کنید. Orange Pi Zero یک کامپیوتر تک برد منبع باز است. این بسیار کوچک با ابعاد 48X46 میلیمتر است. این قادر است تا سیستم عامل Android 4.4، Ubuntu، Debian را اجرا کند. Orange Pi Zero از SoC AllWinner H2 استفاده می‌کند و دارای 256MB / 512MB DDR3 SDRAM است (نسخه 256MB نسخه استاندارد است) و شامل کارت TF، شبکه 100 Ethernet، USB 2.0، سربرگ 26 پین و غیره می‌شود. آن را از طریق USB OTG تامین می‌کند.

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

پیش نیازها

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

• Orange Pi Zero
• کتابخانه tb-mqtt-client
• python ≥ 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

با موفقیت ویژگی‌ها و داده‌های تلمتری را منتشر کردید، باید بلافاصله آنها را در برگه Telemetry Device مشاهده کنید:

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

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

نتیجه گیری

با دانشی که در این راهنما توضیح داده شده است، شما به راحتی می‌توانید Orange Pi Zero خود را متصل کرده و داده‌ها را به ThingsBoard ارسال کنید.

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