مهاجرت به مرکز توسعه‌دهندگان گوگل هوم تکمیل شد.مهاجرت به مرکز توسعه‌دهندگان گوگل هوم تکمیل شد.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

اشکال زدایی خانه هوشمند

۱. قبل از شروع

به عنوان یک توسعه‌دهنده اینترنت اشیا (IoT)، می‌توانید یکپارچه‌سازی‌های ابری-به-ابری ایجاد کنید که به کاربران شما این امکان را می‌دهد تا دستگاه‌های خود را از طریق کنترل‌های لمسی در برنامه Google Home و دستورات صوتی با دستیار گوگل کنترل کنند.

یادگیری ابزارهای اشکال‌زدایی برای ادغام‌های ابری به ابری، گامی مهم برای ایجاد ادغام با کیفیت در تولید با دستیار گوگل است. برای تسهیل نظارت و اشکال‌زدایی آسان، معیارهای Google Cloud Platform (GCP) و Logging و Test Suite برای خانه هوشمند در دسترس هستند تا به شما در شناسایی و حل مشکلات ادغام‌هایتان کمک کنند.

پیش‌نیازها

راهنمای توسعه‌دهنده‌ی «ایجاد یک ادغام ابری به ابری» را بخوانید.
دستگاه‌های خانگی هوشمند را به دستیار گوگل وصل کنید (اجرا کنید)

آنچه خواهید ساخت

در این آزمایشگاه کد، شما یک یکپارچه‌سازی ابر به ابر با دو نقص را پیاده‌سازی کرده و آن را به دستیار متصل می‌کنید، سپس با استفاده از Test Suite برای خانه هوشمند و معیارها و گزارش‌گیری پلتفرم ابری گوگل (GCP)، نقص‌های یکپارچه‌سازی را اشکال‌زدایی می‌کنید.

آنچه یاد خواهید گرفت

نحوه استفاده از معیارهای GCP و ثبت وقایع برای شناسایی و حل مشکلات تولید
نحوه استفاده از Test Suite برای خانه هوشمند جهت شناسایی مشکلات عملکردی و API

آنچه نیاز دارید

یک مرورگر وب، مانند گوگل کروم
یک دستگاه iOS یا اندروید که برنامه Google Home روی آن نصب شده باشد
نسخه Node.js 10.16 یا بالاتر
یک حساب پرداخت گوگل کلود

۲. برنامه‌ی معیوب را اجرا کنید

دریافت کد منبع

برای دانلود نمونه این codelab روی دستگاه توسعه‌دهنده خود، روی لینک زیر کلیک کنید:

... یا می‌توانید مخزن GitHub را از خط فرمان کلون کنید:

$ git clone https://github.com/google-home/smarthome-debug.git

درباره پروژه

برنامه‌ی ماشین لباسشویی شامل زیرشاخه‌های زیر است:

public : یک رابط کاربری فرانت‌اند برای کنترل و نظارت آسان بر وضعیت ماشین لباسشویی هوشمند.
functions : A fully implemented cloud service that manages the smart washer with Cloud Functions for Firebase and Firebase Realtime Database

اتصال به فایربیس

ترمینال را روی دستگاه توسعه خود باز کنید. به پوشه washer-faulty بروید، سپس Firebase CLI را با پروژه ادغام خود که در آزمایشگاه کد Connect smart home devices to the Google Assistant ساخته شده است، تنظیم کنید:

$ cd washer-faulty
$ firebase use <firebase-project-id>

استقرار در فایربیس

به پوشه functions بروید و تمام وابستگی‌های لازم را با استفاده از npm.

$ cd functions
$ npm install

توجه: اگر پیام زیر را مشاهده کردید، می‌توانید آن را نادیده بگیرید و ادامه دهید. این هشدار به دلیل برخی وابستگی‌های قدیمی‌تر است و می‌توانید جزئیات بیشتر را اینجا بیابید.

found 5 high severity vulnerabilities
  run `npm audit fix` to fix them, or `npm audit` for details

اکنون که وابستگی‌ها را نصب و پروژه خود را پیکربندی کرده‌اید، آماده‌اید تا برنامه ماشین لباسشویی معیوب را مستقر کنید.

$ firebase deploy

این خروجی کنسولی است که باید ببینید:

...

✔ Deploy complete!

Project Console: https://console.firebase.google.com/project/<Firebase-project-id>/overview
Hosting URL: https://<Firebase-project-id>.firebaseapp.com

به‌روزرسانی هوم‌گراف

برای مشاهده برنامه وب، آدرس میزبانی وب ( https://<firebase-project-id>.firebaseapp.com ) را در مرورگر خود باز کنید. در رابط کاربری وب، روی دکمه Refresh کلیک کنید. دکمه را فشار دهید تا HomeGraph با جدیدترین فراداده‌های دستگاه از برنامه ماشین لباسشویی معیوب با استفاده از درخواست همگام‌سازی به‌روزرسانی شود.

برنامه Google Home را باز کنید و تأیید کنید که می‌توانید دستگاه ماشین لباسشویی با نام Faulty Washer را ببینید.

۳. یکپارچه‌سازی خود را آزمایش کنید

پس از استقرار پروژه، بررسی کنید که آیا یکپارچه‌سازی شما ماشین لباسشویی را کنترل می‌کند یا خیر.

واشر را آزمایش کنید

هنگام امتحان کردن هر یک از فرمان‌های صوتی زیر از طریق تلفن خود، تغییر مقدار را بررسی کنید:

«هی گوگل، ماشین لباسشویی من را روشن کن.»

«هی گوگل، ماشین لباسشویی من را متوقف کن.»

«هی گوگل، ماشین لباسشویی من را روشن کن.»

«هی گوگل، ماشین لباسشویی من را خاموش کن.»

متوجه خواهید شد که دستیار صوتی هنگام مکث/ادامه شستشو، از طریق صدا به شما اطلاع می‌دهد که مشکلی پیش آمده است:

«متاسفم، نتوانستم به <نام نمایشی پروژه> دسترسی پیدا کنم.»

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

داشبورد تجزیه و تحلیل اسمارت هوم

یک جای خوب برای بررسی خطاها، داشبورد Smarthome Analytics است که نمودارهایی از معیارهای مصرف و سلامت را برای تحقق ابری شما جمع‌آوری می‌کند:

معیارهای استفاده ، روند استفاده از ادغام ابر به ابر شما را نشان می‌دهد، از جمله تعداد کاربران فعال روزانه و تعداد کل درخواست‌ها تا زمان انجام درخواست‌های شما.
The Health metrics helps you monitor anomaly occurrence on your Cloud-to-cloud integration, covering request latency, success percentage, and error breakdown.

برای محدود کردن علت خطا، مراحل زیر را برای دسترسی به داشبورد پروژه دنبال کنید.

در کنسول توسعه‌دهندگان ، به صفحه پروژه‌ها بروید.
پروژه خانه هوشمند خود را انتخاب کنید.
روی برگه Analytics در منوی سمت چپ کلیک کنید.

این شما را به لیستی از داشبوردهای پروژه‌تان در گوگل کلود هدایت می‌کند. داشبورد گوگل هوم آنالیتیکس - ادغام با ابر (Google Home Analytics - Cloud Integration) را انتخاب کنید.

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

کد خطای PARTNER_RESPONSE_MISSING_DEVICE به ریشه مشکل اشاره می‌کند. در مرحله بعد، برای جزئیات بیشتر، گزارش‌های رویداد را بر اساس کد خطا بازیابی کنید.

دسترسی به گزارش‌های رویداد

برای کسب جزئیات بیشتر در مورد خطا، با استفاده از Cloud Logging به گزارش‌های رویداد برای ادغام Cloud-to-cloud خود دسترسی پیدا کنید.

منوی ناوبری را در Google Cloud Platform باز کنید و در قسمت Operations ، گزینه Logging > Logs Explorer را انتخاب کنید تا به گزارش‌های رویداد پروژه خود دسترسی پیدا کنید. همچنین می‌توانید در کادر جستجو، Logs Explorer را جستجو کنید.

در فیلد ورودی «جستجوی همه فیلدها» ، عبارت PARTNER_RESPONSE_MISSING_DEVICE را وارد کنید و روی «اجرای جستجو» کلیک کنید. گزارش‌های منطبق با جستجو در بخش نتایج نمایش داده می‌شوند.

گزارش خطا، یک رویداد خانه هوشمند را با جزئیات خطا نشان می‌دهد که موارد زیر را مشخص می‌کند:

اقدام انجام شده توسط کاربر «از سرگیری ماشین لباسشویی» ( actionType: « STARTSTOP_UNPAUSE ») است که مربوط به فرمان صوتی ناموفق اخیر است.
پیام اشکال‌زدایی مرتبط « JSON response does not include device.

بر اساس پیام اشکال‌زدایی، باید بررسی کنید که چرا برنامه ماشین لباسشویی، دستگاه صحیح را در پاسخ EXECUTE قرار نمی‌دهد.

علت اصلی خطا را شناسایی کنید

در functions/index.js ، هندلر EXECUTE (در آرایه onExecute ) را پیدا کنید که وضعیت هر دستور و وضعیت جدید دستگاه را برمی‌گرداند. درج شناسه‌های دستگاه در یک پاسخ EXECUTE به تابع updateDevice بستگی دارد:

ایندکس.js

app.onExecute(async (body) => {
 ...

 for (const command of intent.payload.commands) {
   for (const device of command.devices) {
     for (const execution of command.execution) {
       executePromises.push(
           updateDevice(execution, device.id)
               .then((data) => {
                 result.ids.push(device.id);
                 Object.assign(result.states, data);
               })
               .catch((e) =>
                 functions.logger.error('EXECUTE',
                     device.id, e.message)));
     }
   }
 }

بررسی بیشتر نحوه مدیریت مکث/ادامه توسط تابع updateDevice در ماشین لباسشویی، نشان می‌دهد که رشته‌ی مورد نظر برای دستور مکث/ادامه نادرست است:

ایندکس.js

const updateDevice = async (execution, deviceId) => {
 const {params, command} = execution;
 let state; let ref;
 switch (command) {
   ...
   case 'action.devices.commands.PauseUnpausePause':
      const data = await queryDevice(deviceId);
      state = (data.isPaused === false && data.isRunning === false)
        ? {isRunning: false, isPaused: false}
        : {isRunning: !params.pause, isPaused: params.pause};
      ref = getFirebaseRef().child(deviceId).child('StartStop');
      break;
 }

 return ref.update(state)
     .then(() => state);
};

خطا را برطرف کنید

اکنون که علت اصلی خطا را شناسایی کرده‌اید، می‌توانید رشته‌ی مربوط به دستور pause / resume را اصلاح کنید:

ایندکس.js

const updateDevice = async (execution, deviceId) => {
 const {params, command} = execution;
 let state; let ref;
 switch (command) {
   ...
   case 'action.devices.commands.PauseUnpause':
      const data = await queryDevice(deviceId);
      state = (data.isPaused === false && data.isRunning === false)
        ? {isRunning: false, isPaused: false}
        : {isRunning: !params.pause, isPaused: params.pause};
      ref = getFirebaseRef().child(deviceId).child('StartStop');
      break;
 }

 return ref.update(state)
     .then(() => state);
};

راه حل خود را آزمایش کنید

کد به‌روزرسانی‌شده را با استفاده از Firebase CLI مستقر کنید:

firebase deploy --only functions

دستورات صوتی زیر را دوباره امتحان کنید، و خواهید دید که دستیار اکنون هنگام مکث/از سرگیری شستشو به درستی پاسخ می‌دهد.

«هی گوگل، ماشین لباسشویی من را متوقف کن.»

«البته، ماشین لباسشویی را متوقف می‌کنم.»

«هی گوگل، ماشین لباسشویی من را روشن کن.»

«فهمیدم، ماشین لباسشویی را دوباره روشن می‌کنم.»

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

«هی گوگل، ماشین لباسشویی من روشنه؟»

«هی گوگل، ماشین لباسشویی من روی چه چرخه‌ای است؟»

۴. یکپارچه‌سازی خود را با Test Suite آزمایش کنید

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

اجرای مجموعه تست برای خانه هوشمند

برای آزمایش ادغام ابر به ابر خود توسط Test Suite، این دستورالعمل‌ها را دنبال کنید:

در مرورگر وب خود، مجموعه تست خانه هوشمند را باز کنید.
با استفاده از دکمه‌ای که در گوشه بالا سمت راست قرار دارد، وارد گوگل شوید. این به مجموعه تست اجازه می‌دهد تا دستورات را مستقیماً به دستیار گوگل ارسال کند.
در فیلد شناسه پروژه ، شناسه پروژه ادغام ابر به ابر خود را وارد کنید. و سپس برای ادامه روی بعدی کلیک کنید.
در مرحله تنظیمات تست ، خواهید دید که Test Suite نوع دستگاه و ویژگی‌های ماشین لباسشویی را فهرست می‌کند.

گزینه Test Request Sync را غیرفعال کنید زیرا برنامه ماشین لباسشویی نمونه هیچ رابط کاربری برای اضافه کردن/حذف کردن/تغییر نام ماشین لباسشویی ندارد. در یک سیستم عملیاتی، هر زمان که کاربر دستگاه‌ها را اضافه/حذف/تغییر نام می‌دهد، باید Request Sync را فعال کنید.
برای شروع اجرای آزمون، روی NEXT کلیک کنید.

پس از اتمام اجرای Test Suite، نتایج موارد تست را مشاهده کنید. متوجه خواهید شد که دو مورد تست ناموفق با پیام خطای مربوطه ثبت شده‌اند:

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

تحلیل پیام خطا

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

برای اولین مورد آزمون ناموفق در بالا،

پیام خطای آن نشان می‌دهد که Test Suite در حالت‌های گزارش‌شده از ادغام Cloud-to-cloud شما، انتظار "isPause": true دارد، اما حالت‌های واقعی فقط شامل "isPause": false .

علاوه بر این، پیام خطای مورد آزمایشی دوم که با شکست مواجه شد، نشان می‌دهد که حالت‌های موجود در پاسخ QUERY از ادغام Cloud-to-cloud شما شامل "isPause": true است که با "isPause": false در حالت‌های گزارش شده از ادغام Cloud-to-cloud شما متفاوت است:

طبق هر دو پیام خطا، باید بررسی کنید که آیا گزارش‌های ادغام شما مقدار صحیحی برای isPaused دارند یا خیر.

علت اصلی خطا را شناسایی کنید

functions/index.js را باز کنید، که شامل تابع reportstate است که تغییرات وضعیت را با استفاده از Report State به Home Graph ارسال می‌کند. payload مربوط به Report State را بررسی کنید، متوجه خواهید شد که payload فاقد وضعیت isPaused است، که دقیقاً همان چیزی است که Test Suite در موارد تست ناموفق بررسی کرده است.

ایندکس.js

exports.reportstate = functions.database.ref('{deviceId}').onWrite(
    async (change, context) => {
      ...

      const requestBody = {
        requestId: 'ff36a3cc', /* Any unique ID */
        agentUserId: USER_ID,
        payload: {
          devices: {
            states: {
              /* Report the current state of our washer */
             [context.params.deviceId]: {
                online: snapshot.online,
                on: snapshot.OnOff.on,
                isRunning: snapshot.StartStop.isRunning,
                currentRunCycle: [{
                  currentCycle: 'rinse',
                  nextCycle: 'spin',
                  lang: 'en',
                }],
                currentTotalRemainingTime: 1212,
                currentCycleRemainingTime: 301,
              },
            },
          },
        },
      };

      const res = await homegraph.devices.reportStateAndNotification({
        requestBody,
      });
      ...
    });

خطا را برطرف کنید

حالا که علت اصلی خطا را شناسایی کرده‌اید، functions/index.js را با اضافه کردن حالت isPaused به payload گزارش حالت (Report State) اصلاح کنید:

ایندکس.js

exports.reportstate = functions.database.ref('{deviceId}').onWrite(
    async (change, context) => {
      ...

      const requestBody = {
        requestId: 'ff36a3cc', /* Any unique ID */
        agentUserId: USER_ID,
        payload: {
          devices: {
            states: {
              /* Report the current state of our washer */
             [context.params.deviceId]: {
                online: snapshot.online,
                on: snapshot.OnOff.on,
                isPaused: snapshot.StartStop.isPaused,
                isRunning: snapshot.StartStop.isRunning,
                currentRunCycle: [{
                  currentCycle: 'rinse',
                  nextCycle: 'spin',
                  lang: 'en',
                }],
                currentTotalRemainingTime: 1212,
                currentCycleRemainingTime: 301,
              },
            },
          },
        },
      };
      ...
    });

راه حل خود را آزمایش کنید

کد به‌روزرسانی‌شده را با استفاده از Firebase CLI مستقر کنید:

$ firebase deploy --only functions

Re-run the Test Suite for smart home, and you will find that all test cases have passed.

۱۴۸۸۳۷f۸۵d۳۷۷dd۶.png

۵. تبریک

تبریک! شما با موفقیت یاد گرفتید که چگونه مشکلات ادغام ابر به ابر را با استفاده از Test Suite برای خانه هوشمند و GCP Metrics and Logging عیب‌یابی کنید.

بیشتر بدانید

با تکیه بر این Codelab، تمرین‌های زیر را امتحان کنید و منابع اضافی را بررسی کنید:

ویژگی‌های پشتیبانی‌شده‌ی بیشتری را به دستگاه خود اضافه کنید و آن‌ها را با مجموعه‌ی تست آزمایش کنید.
داشبورد ایجاد کنید، هشدارها را تنظیم کنید و به داده‌های معیارها به صورت برنامه‌نویسی‌شده دسترسی پیدا کنید تا معیارهای مفید استفاده در مورد ادغام خود را دریافت کنید.
برای خانه هوشمند، به دنبال تکمیل سفارشات محلی باشید.
برای اطلاعات بیشتر، نمونه گیت‌هاب ما را بررسی کنید.

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

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

۱. قبل از شروع

پیش‌نیازها

آنچه خواهید ساخت

آنچه یاد خواهید گرفت

آنچه نیاز دارید

۲. برنامه‌ی معیوب را اجرا کنید

دریافت کد منبع

درباره پروژه

اتصال به فایربیس

استقرار در فایربیس

به‌روزرسانی هوم‌گراف

۳. یکپارچه‌سازی خود را آزمایش کنید

واشر را آزمایش کنید

داشبورد تجزیه و تحلیل اسمارت هوم

دسترسی به گزارش‌های رویداد

علت اصلی خطا را شناسایی کنید

خطا را برطرف کنید

راه حل خود را آزمایش کنید

۴. یکپارچه‌سازی خود را با Test Suite آزمایش کنید

اجرای مجموعه تست برای خانه هوشمند

تحلیل پیام خطا

علت اصلی خطا را شناسایی کنید

خطا را برطرف کنید

راه حل خود را آزمایش کنید

۵. تبریک

بیشتر بدانید

اشکال زدایی خانه هوشمند