نحوه اتصال LattePanda به Thingscoonect

 مقدمه

LattePanda یک رایانه تک برد بر پایه پردازنده Intel Atom x5-Z8350 است. این رایانه دارای 4GB رم، وای‌فای، بلوتوث 4.0 و یک پورت USB 3.0 است.
این برد همچنین دارای یک شیار کارت microSD، پورت HDMI و سربرگ GPIO 40 پین است که به اتصال به انواع دستگاه‌ها و حسگرها امکان می‌دهد.
LattePanda با سیستم عامل ویندوز 10 یا لینوکس کار می‌کند که آن را یک انتخاب عالی برای توسعه‌دهندگان، علاقمندان به ساخت و ساز و علاقه‌مندان DIY می‌کند که به دنبال ساخت هر چیزی از ربات‌ها تا مراکز رسانه‌ای هستند.
LattePanda همچنین در مدل‌های متنوعی ارائه می‌شود، از جمله مدل‌هایی با قابلیت Arduino داخلی و مدل‌هایی با مشخصات عملکرد بالاتر.

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

پیشنیازها

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

•  دستگاه LattePanda
•  کتابخانه 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 انواع مختلفی از اعتبارهای دستگاه را پشتیبانی می‌کند. ما توصیه می‌کنیم که از مشخصات پیش‌فرض و خودکار تولید شده استفاده کنید که یک توکن دسترسی برای این راهنما است.

• روی ردیف دستگاه در جدول کلیک کنید تا جزئیات دستگاه باز شود.
• روی “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 در هنگام راه‌اندازی، قابلیت مربوطه در کد وجود دارد. بخش‌های مسئول در نمونه کد به شرح زیر است:

تابع بازخوانی صفت (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

پس از موفقیت در انتشار صفات و داده‌های تلمتری، شما باید به سرعت آن‌ها را در بخش “Device Telemetry Tab” مشاهده کنید:

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

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

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 از سرور فراخوانی شود. و مانند مثال با صفات مشترک، نیاز داریم تا تابع 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’: {}}

نتیجه‌گیری

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

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