Triển khai ứng dụng thực hiện đơn hàng cục bộ

Để hỗ trợ phương thức thực hiện cục bộ, bạn cần xây dựng một ứng dụng để xử lý các ý định nhà thông minh sau:

  • IDENTIFY: Hỗ trợ khám phá các thiết bị thông minh có thể điều khiển cục bộ. Trình xử lý ý định trích xuất dữ liệu mà thiết bị thông minh của bạn trả về trong quá trình khám phá và gửi dữ liệu này trong phản hồi cho Google.
  • EXECUTE: Hỗ trợ thực thi các lệnh.
  • QUERY: Hỗ trợ truy vấn trạng thái thiết bị.
  • REACHABLE_DEVICES: (Không bắt buộc) Hỗ trợ việc khám phá các thiết bị đầu cuối có thể điều khiển cục bộ ở phía sau thiết bị trung tâm (hoặc cầu).

Ứng dụng này chạy trên các thiết bị Google Home hoặc Google Nest của người dùng và kết nối thiết bị thông minh của bạn với Trợ lý. Bạn có thể tạo ứng dụng bằng TypeScript (ưu tiên) hoặc JavaScript.

Bạn nên sử dụng TypeScript vì bạn có thể tận dụng các liên kết để đảm bảo tĩnh rằng dữ liệu mà ứng dụng trả về khớp với các loại mà nền tảng dự kiến.

Để biết thêm thông tin chi tiết về API này, hãy xem Tài liệu tham khảo về API SDK Home Local.

Các đoạn mã sau đây cho thấy cách bạn có thể khởi chạy ứng dụng thực hiện đơn hàng cục bộ và đính kèm trình xử lý.

Độc lập
import App = smarthome.App;
const localHomeApp: App = new App("1.0.0");
localHomeApp
  .onIdentify(identifyHandler)
  .onExecute(executeHandler)
  .listen()
  .then(() => {
    console.log("Ready");
  });
Trung tâm
import App = smarthome.App;
const localHomeApp: App = new App("1.0.0");
localHomeApp
  .onIdentify(identifyHandler)
  .onReachableDevices(reachableDevicesHandler)
  .onExecute(executeHandler)
  .listen()
  .then(() => {
    console.log("Ready");
  });

Tạo dự án

Để triển khai ứng dụng thực hiện đơn hàng tại địa phương, bạn cần tạo một gói JavaScript cho mã và tất cả các phần phụ thuộc của mã đó.

Sử dụng trình khởi chạy dự án của ứng dụng thực hiện đơn hàng cục bộ để khởi động cấu trúc dự án phù hợp bằng cấu hình trình đóng gói mà bạn muốn.

Mẫu dự án

Để chọn cấu hình trình tạo gói, hãy chạy lệnh npm init như trong các ví dụ sau:

Không có

TypeScript không có cấu hình trình tạo gói:

npm init @google/local-home-app project-directory/ --bundler none

Cấu trúc dự án:

project-directory/
├── node_modules/
├── package.json
├── .gitignore
├── index.ts
├── test.ts
├── tsconfig.json
├── tslint.json
└── serve.js

Thay thế project-directory bằng một thư mục mới sẽ chứa dự án ứng dụng thực hiện đơn hàng tại địa phương.

Webpack

TypeScript với cấu hình trình kết hợp gói webpack:

npm init @google/local-home-app project-directory/ --bundler webpack

Cấu trúc dự án:

project-directory/
├── node_modules/
├── package.json
├── .gitignore
├── index.ts
├── test.ts
├── tsconfig.json
├── tslint.json
├── webpack.config.web.js
├── webpack.config.node.js
└── serve.js

Thay thế project-directory bằng một thư mục mới sẽ chứa dự án ứng dụng thực hiện đơn hàng tại địa phương.

Thông tin tổng quan

TypeScript với cấu hình trình kết hợp Rollup:

npm init @google/local-home-app project-directory/ --bundler rollup

Cấu trúc dự án:

project-directory/
├── node_modules/
├── package.json
├── .gitignore
├── index.ts
├── test.ts
├── tsconfig.json
├── tslint.json
├── rollup.config.js
└── serve.js

Thay thế project-directory bằng một thư mục mới sẽ chứa dự án ứng dụng thực hiện đơn hàng tại địa phương.

Gói

TypeScript với cấu hình trình tạo gói Parcel:

npm init @google/local-home-app project-directory/ --bundler parcel

Cấu trúc dự án:

project-directory/
├── node_modules/
├── package.json
├── .gitignore
├── index.ts
├── test.ts
├── tsconfig.json
├── tslint.json
└── serve.js

Thay thế project-directory bằng một thư mục mới sẽ chứa dự án ứng dụng thực hiện đơn hàng tại địa phương.

Thực hiện các thao tác phổ biến ở cấp dự án

Dự án được tạo hỗ trợ các tập lệnh npm sau:

Gói
cd project-directory/
npm run build

Tập lệnh này biên dịch nguồn TypeScript và gói ứng dụng của bạn với các phần phụ thuộc cho môi trường thời gian chạy Chrome trong thư mục con dist/web và môi trường thời gian chạy Node.js trong thư mục con dist/node.

Xác minh
cd project-directory/
npm run lint
npm run compile
npm test

Tập lệnh này xác minh cú pháp của mã TypeScript, biên dịch mã mà không tạo ra bất kỳ kết quả nào trong thư mục con dist/ và chạy các chương trình kiểm thử tự động từ test.ts.

Phân phát
cd project-directory/
npm run start

Trong quá trình phát triển, tập lệnh này sẽ phân phát các gói ứng dụng cho môi trường thời gian chạy Chrome và Node.js cục bộ.

Triển khai trình xử lý IDENTIFY

Trình xử lý IDENTIFY sẽ được kích hoạt khi thiết bị Google Home hoặc Google Nest khởi động lại và thấy các thiết bị cục bộ chưa được xác minh (bao gồm cả thiết bị cuối được kết nối với một trung tâm). Nền tảng Local Home sẽ quét các thiết bị cục bộ bằng thông tin cấu hình quét mà bạn đã chỉ định trước đó và gọi trình xử lý IDENTIFY bằng kết quả quét.

IdentifyRequest từ nền tảng Home cục bộ chứa dữ liệu quét của một thực thể LocalIdentifiedDevice. Chỉ một thực thể device được điền, dựa trên cấu hình quét đã phát hiện thiết bị.

Nếu kết quả quét khớp với thiết bị của bạn, thì trình xử lý IDENTIFY sẽ trả về một đối tượng IdentifyResponsePayload, trong đó có một đối tượng device chứa siêu dữ liệu nhà thông minh (chẳng hạn như loại, đặc điểm và trạng thái báo cáo).

Google thiết lập mối liên kết thiết bị nếu verificationId từ phản hồi IDENTIFY khớp với một trong các giá trị otherDeviceIds do phản hồi SYNC trả về.

Ví dụ:

Các đoạn mã sau đây cho biết cách bạn có thể tạo trình xử lý IDENTIFY tương ứng cho thiết bị độc lập và tích hợp trung tâm.

Độc lập
const identifyHandler = (request: IntentFlow.IdentifyRequest):
  IntentFlow.IdentifyResponse => {

    // Obtain scan data from protocol defined in your scan config
    const device = request.inputs[0].payload.device;
    if (device.udpScanData === undefined) {
      throw Error("Missing discovery response");
    }
    const scanData = device.udpScanData.data;

    // Decode scan data to obtain metadata about local device
    const verificationId = "local-device-id";

    // Return a response
    const response: IntentFlow.IdentifyResponse = {
      intent: Intents.IDENTIFY,
      requestId: request.requestId,
      payload: {
        device: {
          id: device.id || "",
          verificationId, // Must match otherDeviceIds in SYNC response
        },
      },
    };
    return response;
  };
Trung tâm
const identifyHandler = (request: IntentFlow.IdentifyRequest):
  IntentFlow.IdentifyResponse => {

    // Obtain scan data from protocol defined in your scan config
    const device = request.inputs[0].payload.device;
    if (device.udpScanData === undefined) {
      throw Error("Missing discovery response");
    }
    const scanData = device.udpScanData.data;

    // Decode scan data to obtain metadata about local device
    const proxyDeviceId = "local-hub-id";

    // Return a response
    const response: IntentFlow.IdentifyResponse = {
      intent: Intents.IDENTIFY,
      requestId: request.requestId,
      payload: {
        device: {
          id: proxyDeviceId,
          isProxy: true,     // Device can control other local devices
          isLocalOnly: true, // Device not present in `SYNC` response
        },
      },
    };
    return response;
  };

Xác định các thiết bị phía sau một trung tâm

Nếu xác định được thiết bị trung tâm, Google sẽ coi thiết bị trung tâm đó là đường dẫn đến các thiết bị cuối đã kết nối của thiết bị trung tâm và cố gắng xác minh các thiết bị cuối đó.

Để cho phép Google xác nhận rằng có thiết bị trung tâm, hãy làm theo hướng dẫn sau đây cho trình xử lý IDENTIFY:

  • Nếu phản hồi SYNC của bạn báo cáo mã nhận dạng của các thiết bị đầu cuối cục bộ được kết nối với trung tâm, hãy đặt isProxy thành true trong IdentifyResponsePayload.
  • Nếu phản hồi SYNC không báo cáo thiết bị trung tâm, hãy đặt isLocalOnly thành true trong IdentifyResponsePayload.
  • Trường device.id chứa mã thiết bị cục bộ cho chính thiết bị trung tâm.

Triển khai trình xử lý REACHABLE_DEVICES (chỉ tích hợp trung tâm)

Ý định REACHABLE_DEVICES do Google gửi để xác nhận thiết bị cuối nào có thể được kiểm soát cục bộ. Ý định này được kích hoạt mỗi khi Google chạy một quy trình quét khám phá (khoảng một phút một lần), miễn là trung tâm được phát hiện là đang trực tuyến.

Bạn triển khai trình xử lý REACHABLE_DEVICES tương tự như trình xử lý IDENTIFY, ngoại trừ việc trình xử lý của bạn cần thu thập thêm mã thiết bị mà thiết bị proxy cục bộ (tức là trung tâm) có thể truy cập. Trường device.verificationId chứa mã thiết bị cục bộ cho một thiết bị đầu cuối được kết nối với trung tâm.

ReachableDevicesRequest từ nền tảng Trang chủ cục bộ chứa một thực thể của LocalIdentifiedDevice. Thông qua thực thể này, bạn có thể lấy mã thiết bị proxy cũng như dữ liệu từ kết quả quét.

Trình xử lý REACHABLE_DEVICES của bạn phải trả về một đối tượng ReachableDevicesPayload bao gồm một đối tượng devices chứa một mảng các giá trị verificationId đại diện cho các thiết bị cuối mà trung tâm điều khiển. Các giá trị verificationId phải khớp với một trong các otherDeviceIds từ phản hồi SYNC.

Đoạn mã sau đây cho biết cách bạn có thể tạo trình xử lý REACHABLE_DEVICES.

Trung tâm
const reachableDevicesHandler = (request: IntentFlow.ReachableDevicesRequest):
  IntentFlow.ReachableDevicesResponse => {

    // Reference to the local proxy device
    const proxyDeviceId = request.inputs[0].payload.device.id;

    // Gather additional device ids reachable by local proxy device
    // ...

    const reachableDevices = [
      // Each verificationId must match one of the otherDeviceIds
      // in the SYNC response
      { verificationId: "local-device-id-1" },
      { verificationId: "local-device-id-2" },
    ];

    // Return a response
    const response: IntentFlow.ReachableDevicesResponse = {
      intent: Intents.REACHABLE_DEVICES,
      requestId: request.requestId,
      payload: {
        devices: reachableDevices,
      },
    };
    return response;
  };

Triển khai trình xử lý EXECUTE

Trình xử lý EXECUTE trong ứng dụng xử lý các lệnh của người dùng và sử dụng SDK Nhà cục bộ để truy cập vào các thiết bị thông minh của bạn thông qua một giao thức hiện có.

Nền tảng Trang chủ cục bộ truyền cùng một tải trọng đầu vào đến hàm trình xử lý EXECUTE như đối với ý định EXECUTE đến phương thức thực hiện trên đám mây. Tương tự, trình xử lý EXECUTE sẽ trả về dữ liệu đầu ra ở cùng định dạng như khi xử lý ý định EXECUTE. Để đơn giản hoá việc tạo phản hồi, bạn có thể sử dụng lớp Execute.Response.Builder do SDK Trang chủ cục bộ cung cấp.

Ứng dụng của bạn không có quyền truy cập trực tiếp vào địa chỉ IP của thiết bị. Thay vào đó, hãy sử dụng giao diện CommandRequest để tạo lệnh dựa trên một trong các giao thức sau: UDP, TCP hoặc HTTP. Sau đó, hãy gọi hàm deviceManager.send() để gửi các lệnh.

Khi nhắm mục tiêu các lệnh đến thiết bị, hãy sử dụng mã thiết bị (và các tham số từ trường customData, nếu có) trong phản hồi SYNC để giao tiếp với thiết bị.

Ví dụ:

Đoạn mã sau đây cho thấy cách bạn có thể tạo trình xử lý EXECUTE.

Độc lập/Trung tâm
const executeHandler = (request: IntentFlow.ExecuteRequest):
  Promise<IntentFlow.ExecuteResponse> => {

    // Extract command(s) and device target(s) from request
    const command = request.inputs[0].payload.commands[0];
    const execution = command.execution[0];

    const response = new Execute.Response.Builder()
      .setRequestId(request.requestId);

    const result = command.devices.map((device) => {
      // Target id of the device provided in the SYNC response
      const deviceId = device.id;
      // Metadata for the device provided in the SYNC response
      // Use customData to provide additional required execution parameters
      const customData: any = device.customData;

      // Convert execution command into payload for local device
      let devicePayload: string;
      // ...

      // Construct a local device command over TCP
      const deviceCommand = new DataFlow.TcpRequestData();
      deviceCommand.requestId = request.requestId;
      deviceCommand.deviceId = deviceId;
      deviceCommand.data = devicePayload;
      deviceCommand.port = customData.port;
      deviceCommand.operation = Constants.TcpOperation.WRITE;

      // Send command to the local device
      return localHomeApp.getDeviceManager()
        .send(deviceCommand)
        .then((result) => {
          response.setSuccessState(result.deviceId, state);
        })
        .catch((err: IntentFlow.HandlerError) => {
          err.errorCode = err.errorCode || IntentFlow.ErrorCode.INVALID_REQUEST;
          response.setErrorState(device.id, err.errorCode);
        });
    });

    // Respond once all commands complete
    return Promise.all(result)
      .then(() => response.build());
  };

Triển khai trình xử lý QUERY

Trình xử lý QUERY trong ứng dụng xử lý các yêu cầu của người dùng và sử dụng SDK Home cục bộ để báo cáo trạng thái của các thiết bị thông minh.

Nền tảng Trang chủ cục bộ truyền cùng một tải trọng yêu cầu đến hàm trình xử lý "QUERY" như đối với ý định QUERY đến phương thức thực hiện trên đám mây. Tương tự, trình xử lý QUERY sẽ trả về dữ liệu theo định dạng giống như khi xử lý ý định QUERY.

Gửi lệnh đến các thiết bị phía sau một trung tâm

Để điều khiển các thiết bị cuối phía sau một trung tâm, bạn có thể cần cung cấp thêm thông tin trong tải trọng lệnh dành riêng cho giao thức được gửi đến trung tâm để trung tâm xác định được lệnh đó nhắm đến thiết bị nào. Trong một số trường hợp, bạn có thể suy ra trực tiếp giá trị này từ giá trị device.id, nhưng nếu không, bạn nên đưa dữ liệu bổ sung này vào trường customData.

Nếu bạn đã tạo ứng dụng bằng TypeScript, hãy nhớ biên dịch ứng dụng sang JavaScript. Bạn có thể sử dụng hệ thống mô-đun mà bạn chọn để viết mã. Đảm bảo trình duyệt Chrome hỗ trợ mục tiêu của bạn.

Trước
Hỗ trợ khám phá thiết bị
Tiếp
Kiểm thử và gỡ lỗi