داکیومنت پیاده‌سازی WebSocket

۱. معرفی و مقدمه

این داکیومنت، راهنمای جامعی برای پیاده‌سازی ارتباط WebSocket بین اپلیکیشن موبایل (اندروید و iOS) و تبلت سفارشی را ارائه می‌دهد. با استفاده از این راهنما، برنامه‌نویسان قادر خواهند بود یک سیستم ارتباطی پایدار، امن و سریع بین این دو دستگاه از طریق سرور WebSocket پیاده‌سازی کنند.

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

۲. معماری سیستم

در این سیستم سه ایستگاه کاری اصلی وجود دارد:

۳. ساختار پیام‌های WebSocket

تمام پیام‌های ارسالی و دریافتی با فرمت JSON انجام می‌شود و شامل فیلدهای زیر است:

مثال یک پیام درخواست از اپ موبایل به تبلت:

{
  "deviceType": "1",
  "sequence": 0,
  "code": "101",
  "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
  "time": 1503,
  "type": "com.astrum.websocket.JSONRequest",
  "deviceName": "M2101K6G-Xiaomi",
  "connectType": 3,
  "ipSrc": "2.144.3.143",
  "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
  "iptrg": "2.144.3.143"
}

مثال پیام پاسخ از تبلت به اپ موبایل:

{
  "targetId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
  "time": 8305688,
  "type": "com.lotus.websocket.JSONResponse",
  "code": "505",
  "sequence": 835,
  "connectType": 1,
  "ipSrc": "2.144.3.143",
  "sourceId": "688d2452-cf85-d16b-a094-c57e8b81347b",
  "iptrg": "2.144.3.143"
}

۴. انواع پیام‌ها و کدهای آنها

کدهای پیام زیر برای ارتباط بین اپلیکیشن موبایل و تبلت سفارشی استفاده می‌شود:

۵. فرایند احراز هویت و اتصال

روند کلی ارتباط و احراز هویت بین اپلیکیشن موبایل و تبلت سفارشی به شرح زیر است:

مثال روند احراز هویت:

1. درخواست ثبت مانیتورینگ از اپ موبایل:

   {
     "deviceType": "1",
     "sequence": 0,
     "code": "101",
     "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
     "time": 1503,
     "type": "com.astrum.websocket.JSONRequest",
     "deviceName": "M2101K6G-Xiaomi",
     "connectType": 3,
     "ipSrc": "2.144.3.143",
     "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
     "iptrg": "2.144.3.143"
   }

2. پاسخ انتظار مجوز از تبلت سفارشی:

   {
     "targetId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
     "time": 8305688,
     "type": "com.lotus.websocket.JSONResponse",
     "code": "505",
     "sequence": 835,
     "connectType": 1,
     "ipSrc": "2.144.3.143",
     "sourceId": "688d2452-cf85-d16b-a094-c57e8b81347b",
     "iptrg": "2.144.3.143"
   }

3. تایید دسترسی و ارسال اطلاعات ایتم‌ها از تبلت:

   {
     "targetId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
     "time": 10308775,
     "message": [
       { "id": "5f8396c6-369d-45bd-ac3b-02ea27494682", "value": null },
       { "id": "be0727b7-6cca-4b5e-8b9f-881a312e9355", "value": null },
       { "id": "237697c2-9815-4b8e-b145-9b9798214390", "value": "1" },
       // صدها مورد دیگر
     ],
     "deviceInfo": {
       "deviceId": "L000A0924303B9",
       "screensaver_timeout": 60,
       "soundLevel": 50,
       // اطلاعات دستگاه
     },
     "type": "com.lotus.websocket.JSONResponse",
     "sequence": 856,
     "code": "201",
     "connectType": 1,
     "ipSrc": "2.144.3.143",
     "sourceId": "688d2452-cf85-d16b-a094-c57e8b81347b",
     "iptrg": "2.144.3.143"
   }

۶. کنترل آیتم‌های مختلف

پس از برقراری ارتباط، اپلیکیشن موبایل می‌تواند آیتم‌های مختلف را کنترل کند. این کنترل از طریق ارسال پیام با کد '104' (نوشتن وضعیت) انجام می‌شود و تبلت وضعیت به‌روزرسانی شده را با کد '100' (مانیتورینگ-داده) باز می‌گرداند.

انواع آیتم‌های قابل کنترل:

مثال‌های کنترل آیتم‌ها:

1. روشن کردن یک کلید:

   {
     "sequence": 6,
     "code": "104",
     "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
     "time": 8088,
     "message": {
       "force": false,
       "id": "23ace3e0-92b8-43f0-8c49-6bf365fdede3",
       "type": "INTEGER",
       "value": "1"
     },
     "type": "com.astrum.websocket.JSONRequest",
     "connectType": 3,
     "ipSrc": "2.144.3.143",
     "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
     "iptrg": "2.144.3.143"
   }

2. تغییر مود ترموستات:

   {
     "sequence": 223,
     "code": "104",
     "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
     "time": 8741,
     "message": {
       "force": false,
       "id": "c8b5a21f-44fc-4c41-a2b3-aa5ec39eb201",
       "type": "MODE",
       "value": "Frost_Protection"
     },
     "type": "com.astrum.websocket.JSONRequest",
     "connectType": 3,
     "ipSrc": "2.144.3.143",
     "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
     "iptrg": "2.144.3.143"
   }

3. تغییر سرعت فن ترموستات:

   {
     "sequence": 378,
     "code": "104",
     "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
     "time": 9568,
     "message": {
       "force": false,
       "id": "6b37308e-b18d-4be7-8cc8-6b98c875f322",
       "type": "FAN_SPEED",
       "value": "High"
     },
     "type": "com.astrum.websocket.JSONRequest",
     "connectType": 3,
     "ipSrc": "2.144.3.143",
     "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
     "iptrg": "2.144.3.143"
   }

مثال پاسخ وضعیت (مانیتورینگ-داده):

{
  "targetId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
  "time": 10325345,
  "message": {
    "force": false,
    "id": "66047347-3b5b-4817-8713-a3bf8d1ab546",
    "value": "35.47"
  },
  "type": "com.lotus.websocket.JSONResponse",
  "sequence": 866,
  "code": "100",
  "connectType": 1,
  "ipSrc": "2.144.3.143",
  "sourceId": "688d2452-cf85-d16b-a094-c57e8b81347b",
  "iptrg": "2.144.3.143"
}

۷. دریافت اطلاعات از دیتابیس

اپلیکیشن موبایل می‌تواند با ارسال پیام با کد '303' (درخواست داده)، کوئری‌هایی را برای استخراج اطلاعات از دیتابیس تبلت ارسال کند. تبلت سفارشی نتیجه کوئری را با کد '304' (پاسخ داده) بازگرداند.

مثال ارسال کوئری برای دریافت دسترسی‌ها:

{
  "sequence": 2,
  "code": "303",
  "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
  "time": 4638,
  "message": { "queryLocal": "select * from tb_permission WHERE push_token = ''" },
  "type": "com.astrum.websocket.JSONRequest",
  "sequenceId": 1,
  "connectType": 3,
  "ipSrc": "2.144.3.143",
  "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
  "iptrg": "2.144.3.143"
}

مثال پاسخ کوئری:

{
  "targetId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
  "sequenceId": 1,
  "time": 10309477,
  "message": { "sequenceId": 1, "queryResult": [ {...} ] },
  "type": "com.lotus.websocket.JSONResponse",
  "sequence": 857,
  "code": "304",
  "connectType": 1,
  "ipSrc": "2.144.3.143",
  "sourceId": "688d2452-cf85-d16b-a094-c57e8b81347b",
  "iptrg": "2.144.3.143"
}

مثال ارسال کوئری برای دریافت سناریوها:

{
  "sequence": 3,
  "code": "303",
  "targetId": "688d2452-cf85-d16b-a094-c57e8b81347b",
  "time": 4834,
  "message": { "queryLocal": "select * from tb_scenarios" },
  "type": "com.astrum.websocket.JSONRequest",
  "sequenceId": 2,
  "connectType": 3,
  "ipSrc": "2.144.3.143",
  "sourceId": "5f3c6d61-434e-f64a-fcfa-b645a5637386",
  "iptrg": "2.144.3.143"
}

۸. ملاحظات امنیتی

برای حفظ امنیت ارتباط بین اپلیکیشن موبایل و تبلت سفارشی، موارد زیر را در نظر بگیرید:

۹. بهینه‌سازی عملکرد و پایداری

برای بهینه‌سازی عملکرد و افزایش پایداری ارتباط، موارد زیر را در نظر بگیرید:

۱۰. نکات پیاده‌سازی در اندروید

برای پیاده‌سازی WebSocket در اندروید، می‌توانید از کتابخانه‌های زیر استفاده کنید:

• OkHttp WebSocket
• Scarlet
• Java-WebSocket

نکات مهم پیاده‌سازی:

۱۱. نکات پیاده‌سازی در iOS

برای پیاده‌سازی WebSocket در iOS، می‌توانید از کتابخانه‌های زیر استفاده کنید:

• Starscream
• SwiftWebSocket
• URLSessionWebSocketTask (iOS 13+)

نکات مهم پیاده‌سازی:

۱۲. بهترین شیوه‌های پیاده‌سازی

برای پیاده‌سازی بهینه و کارآمد، موارد زیر را رعایت کنید:

۱۳. عیب‌یابی و رفع خطاها

خطاهای رایج و راه‌حل‌های آنها: