लोकल फ़ुलफ़िलमेंट ऐप्लिकेशन लागू करना

स्थानीय नियमों और शर्तों को पूरा करने के लिए, आपको एक ऐसा ऐप्लिकेशन बनाना होगा जो इन स्मार्ट होम इंटेंट को मैनेज कर सके:

• IDENTIFY: स्थानीय तौर पर कंट्रोल किए जा सकने वाले स्मार्ट डिवाइसों को खोजने की सुविधा देता है. इंटेंट हैंडलर, उस डेटा को इकट्ठा करता है जिसे आपका स्मार्ट डिवाइस, खोज के दौरान लौटाता है और उसे Google को भेजता है.
• EXECUTE: इससे निर्देश लागू किए जा सकते हैं.
• QUERY: इससे डिवाइस की स्थिति के बारे में क्वेरी की जा सकती है.
• REACHABLE_DEVICES: (ज़रूरी नहीं) हब (या ब्रिज) डिवाइस के पीछे स्थानीय तौर पर कंट्रोल किए जा सकने वाले एंड डिवाइसों को खोजने की सुविधा.

यह ऐप्लिकेशन उपयोगकर्ता के Google Home या Google Nest डिवाइसों पर चलता है और आपके स्मार्ट डिवाइस को Assistant से कनेक्ट करता है. टाइपस्क्रिप्ट (पसंदीदा) या JavaScript का इस्तेमाल करके ऐप्लिकेशन बनाया जा सकता है.

टाइपस्क्रिप्ट का सुझाव इसलिए दिया जाता है, क्योंकि बाइंडिंग की मदद से, स्टैटिक रूप से यह पक्का किया जा सकता है कि आपके ऐप्लिकेशन से मिलने वाला डेटा, प्लैटफ़ॉर्म की उम्मीद के मुताबिक हो.

एपीआई के बारे में ज़्यादा जानने के लिए, Local Home SDK API API का रेफ़रंस देखें.

यहां दिए गए स्निपेट से पता चलता है कि लोकल फ़ुलफ़िलमेंट ऐप्लिकेशन को कैसे शुरू किया जा सकता है और अपने हैंडलर अटैच कैसे किए जा सकते हैं.

import App = smarthome.App;
const localHomeApp: App = new App("1.0.0");
localHomeApp
  .onIdentify(identifyHandler)
  .onExecute(executeHandler)
  .listen()
  .then(() => {
    console.log("Ready");
  });

import App = smarthome.App;
const localHomeApp: App = new App("1.0.0");
localHomeApp
  .onIdentify(identifyHandler)
  .onReachableDevices(reachableDevicesHandler)
  .onExecute(executeHandler)
  .listen()
  .then(() => {
    console.log("Ready");
  });

अपना प्रोजेक्ट बनाएं

लोकल फ़ुलफ़िलमेंट ऐप्लिकेशन को डिप्लॉय करने के लिए, आपको अपने कोड और उसकी सभी डिपेंडेंसी के लिए एक JavaScript बंडल बनाना होगा.

लोकल फ़ुलफ़िलमेंट ऐप्लिकेशन प्रोजेक्ट इनिशियलाइज़र का इस्तेमाल करके, अपने पसंदीदा बंडलर कॉन्फ़िगरेशन के साथ सही प्रोजेक्ट स्ट्रक्चर को बूटस्ट्रैप करें.

प्रोजेक्ट टेंप्लेट

बंडलर कॉन्फ़िगरेशन चुनने के लिए, npm init कमांड चलाएं, जैसा कि यहां दिए गए उदाहरणों में दिखाया गया है:

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

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

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

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

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

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

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

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

प्रोजेक्ट-लेवल के सामान्य टास्क पूरे करना

जनरेट किया गया प्रोजेक्ट, इन npm स्क्रिप्ट के साथ काम करता है:

cd project-directory/
npm run build

cd project-directory/
npm run lint
npm run compile
npm test

cd project-directory/
npm run start

पहचान बताने वाले हैंडलर को लागू करना

जब Google Home या Google Nest डिवाइस फिर से चालू होगा, तब IDENTIFY हैंडलर ट्रिगर होगा. साथ ही, ऐसे लोकल डिवाइस भी दिखेंगे जिनकी पुष्टि नहीं हुई है (इनमें हब से कनेक्ट किए गए एंड डिवाइस भी शामिल हैं). लोकल Home प्लैटफ़ॉर्म, पहले से तय की गई स्कैन कॉन्फ़िगरेशन जानकारी का इस्तेमाल करके, लोकल डिवाइसों को स्कैन करेगा और स्कैन के नतीजे के साथ आपके IDENTIFY हैंडलर को कॉल करेगा.

Local Home प्लैटफ़ॉर्म के IdentifyRequest में, LocalIdentifiedDevice इंस्टेंस का स्कैन डेटा होता है. डिवाइस को खोजने वाले स्कैन कॉन्फ़िगरेशन के आधार पर, सिर्फ़ एक device इंस्टेंस अपने-आप भरा जाता है.

अगर स्कैन के नतीजे आपके डिवाइस से मिलते-जुलते हैं, तो आपके IDENTIFY हैंडलर को IdentifyResponsePayload ऑब्जेक्ट दिखेगा. इसमें स्मार्ट होम मेटाडेटा (जैसे कि टाइप, traits, और रिपोर्ट की स्थिति) वाला device ऑब्जेक्ट शामिल होता है.

अगर IDENTIFY रिस्पॉन्स में दिया गया verificationId, SYNC रिस्पॉन्स से मिले otherDeviceIds वैल्यू में से किसी एक वैल्यू से मेल खाता है, तो Google उस डिवाइस से कनेक्ट करता है.

उदाहरण

यहां दिए गए स्निपेट से पता चलता है कि स्टैंडअलोन डिवाइस और हब इंटिग्रेशन के लिए, IDENTIFY हैंडलर कैसे बनाए जा सकते हैं.

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;
  };

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;
  };

हब में शामिल डिवाइसों की पहचान करना

अगर Google किसी हब डिवाइस की पहचान करता है, तो वह हब को कनेक्ट किए गए डिवाइसों का नेटवर्क मानेगा और उन असली डिवाइसों की पुष्टि करने की कोशिश करेगा.

Google को यह पुष्टि करने की अनुमति देने के लिए कि हब डिवाइस मौजूद है या नहीं, अपने IDENTIFY हैंडलर के इन निर्देशों का पालन करें:

• अगर आपका SYNC जवाब, हब से कनेक्ट किए गए लोकल एंड डिवाइसों के आईडी की रिपोर्ट करता है, तो isProxy को IdentifyResponsePayload में true के तौर पर सेट करें.
• अगर SYNC के जवाब से आपके हब डिवाइस की जानकारी नहीं मिलती, तो IdentifyResponsePayload में isLocalOnly को true के तौर पर सेट करें.
• device.id फ़ील्ड में, हब डिवाइस के लिए भी लोकल डिवाइस आईडी शामिल होता है.

ReachABLE_device हैंडलर को लागू करें (सिर्फ़ हब इंटिग्रेशन के लिए)

Google, REACHABLE_DEVICES इंटेंट को भेजता है. इससे यह पुष्टि की जाती है कि किन डिवाइसों को स्थानीय तौर पर कंट्रोल किया जा सकता है. Google जब भी Google का डिस्कवरी स्कैन (हर मिनट में करीब एक बार) करता है, तब यह इंटेंट ट्रिगर होता है. ऐसा तब तक होता है, जब तक हब के ऑनलाइन होने का पता चलता है.

REACHABLE_DEVICES हैंडलर को IDENTIFY हैंडलर की तरह ही लागू किया जाता है. हालांकि, हैंडलर को कुछ ऐसे डिवाइस आईडी इकट्ठा करने की ज़रूरत है जिन पर लोकल प्रॉक्सी (यानी हब) से ऐक्सेस किया जा सकता हो. device.verificationId फ़ील्ड में, हब से कनेक्ट किए गए आखिरी डिवाइस का लोकल डिवाइस आईडी होता है.

Local Home प्लैटफ़ॉर्म से लिए गए ReachableDevicesRequest में, LocalIdentifiedDevice का एक इंस्टेंस शामिल है. इस तरह, आपको स्कैन के नतीजों से प्रॉक्सी डिवाइस आईडी के साथ-साथ, डेटा भी मिल सकता है.

आपके REACHABLE_DEVICES हैंडलर को ReachableDevicesPayload ऑब्जेक्ट दिखाएगा, जिसमें एक devices ऑब्जेक्ट शामिल है. इस ऑब्जेक्ट में, verificationId वैल्यू की कैटगरी शामिल है. ये उन एंड डिवाइसों के बारे में बताते हैं जिन्हें हब कंट्रोल करता है. verificationId वैल्यू, SYNC रिस्पॉन्स के otherDeviceIds में से किसी एक से मेल खानी चाहिए.

नीचे दिया गया स्निपेट दिखाता है कि आप अपना REACHABLE_DEVICES हैंडलर कैसे बना सकते हैं.

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;
  };

EXECUTE हैंडलर को लागू करना

ऐप्लिकेशन में मौजूद आपका EXECUTE हैंडलर, उपयोगकर्ता के निर्देशों को प्रोसेस करता है. साथ ही, किसी मौजूदा प्रोटोकॉल के ज़रिए आपके स्मार्ट डिवाइसों को ऐक्सेस करने के लिए, Local Home SDK टूल का इस्तेमाल करता है.

Local Home प्लैटफ़ॉर्म, EXECUTE हैंडलर को उसी इनपुट पेलोड देता है जो क्लाउड फ़ुलफ़िलमेंट के लिए EXECUTE इंटेंट के लिए काम करता है. इसी तरह, आपका EXECUTE हैंडलर भी आउटपुट डेटा को उसी फ़ॉर्मैट में दिखाता है जिस फ़ॉर्मैट में EXECUTE इंटेंट को प्रोसेस किया जाता है. जवाब देना आसान बनाने के लिए, लोकल होम SDK टूल से मिलने वाली Execute.Response.Builder क्लास का इस्तेमाल किया जा सकता है.

आपके ऐप्लिकेशन के पास डिवाइस के आईपी पते का सीधा ऐक्सेस नहीं है. इसके बजाय, CommandRequest इंटरफ़ेस का इस्तेमाल करके, इनमें से किसी एक प्रोटोकॉल पर आधारित निर्देश बनाएं: यूडीपी, टीसीपी या एचटीटीपी. इसके बाद, निर्देश भेजने के लिए deviceManager.send() फ़ंक्शन को कॉल करें.

डिवाइसों को निर्देश देते समय, SYNC रिस्पॉन्स के डिवाइस आईडी (और customData फ़ील्ड में मौजूद पैरामीटर, अगर शामिल हों) का इस्तेमाल करके डिवाइस से संपर्क करें.

उदाहरण

नीचे दिया गया कोड स्निपेट दिखाता है कि आप अपना EXECUTE हैंडलर कैसे बना सकते हैं.

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());
  };

QUERY हैंडलर लागू करें

ऐप्लिकेशन में मौजूद आपका QUERY हैंडलर, उपयोगकर्ताओं के अनुरोधों को प्रोसेस करता है. साथ ही, आपके स्मार्ट डिवाइस की स्थिति की रिपोर्ट देने के लिए, Local Home SDK टूल का इस्तेमाल करता है.

Local Home प्लैटफ़ॉर्म, 'QUERY' हैंडलर को उसी तरह के अनुरोध पेलोड पास करता है जो क्लाउड फ़ुलफ़िलमेंट के लिए QUERY इंटेंट के लिए काम करता है. इसी तरह, आपका QUERY हैंडलर उसी फ़ॉर्मैट में डेटा दिखाता है जैसा QUERY इंटेंट को प्रोसेस करने से मिलता है.

हब में शामिल डिवाइसों को निर्देश भेजना

हब में आखिरी डिवाइसों को कंट्रोल करने के लिए, आपको हब को भेजे गए प्रोटोकॉल के हिसाब से कमांड पेलोड में ज़्यादा जानकारी देनी पड़ सकती है. इससे हब को यह पता चल सकेगा कि निर्देश किस डिवाइस के लिए है. कुछ मामलों में, इसका अनुमान सीधे device.id वैल्यू से लगाया जा सकता है. हालांकि, अगर ऐसा नहीं है, तो आपको इस अतिरिक्त डेटा को customData फ़ील्ड के हिस्से के तौर पर शामिल करना चाहिए.

अगर आपने TypeScript का इस्तेमाल करके अपना ऐप्लिकेशन बनाया है, तो अपने ऐप्लिकेशन को JavaScript में कंपाइल करना न भूलें. अपना कोड लिखने के लिए, अपनी पसंद के मॉड्यूल सिस्टम का इस्तेमाल किया जा सकता है. पक्का करें कि Chrome ब्राउज़र पर आपका टारगेट काम करता हो.