SDM API एक REST API है, जो विशेषताएं देखें और मैनेज करने के लिए Trait कमांड लागू करें Google Nest डिवाइस. इस दौरान दिए गए ऐक्सेस टोकन का इस्तेमाल करें अनुमति देने की प्रक्रिया का इस्तेमाल करता है.
विशेषताएं
डिवाइस की जानकारी के लिए, एसडीएम एपीआई, विशेषता पर आधारित मॉडल का इस्तेमाल करता है और उसके काम करने का तरीका बताएंगे. अलग-अलग डिवाइस गाइड देखकर अपनी विशेषताओं के बारे में जानें यह सेटिंग किसी डिवाइस के लिए उपलब्ध है:
- कैमरा
- कैमरा (बैटरी)
- Floodlight वाला कैमरा
- कैमरा (वायर वाला)
- डिसप्ले
- डोरबेल
- डोरबेल (बैटरी)
- डोरबेल (तार वाली)
- थर्मोस्टैट
तरीके
SDM API के लिए उपलब्ध सभी तरीकों के बारे में पूरी जानकारी पाने के लिए, एपीआई का रेफ़रंस देखें.
executeCommand
अनुमति वाले डिवाइस पर निर्देश भेजता है.
कोई निर्देश लागू करने के लिए, POST
कॉल का इस्तेमाल करें. उदाहरण के लिए, थर्मोस्टैट का मोड बदलने के लिए:
POST /enterprises/project-id/devices/device-id:executeCommand { "command" : "sdm.devices.commands.ThermostatMode.SetMode", "params" : { "mode" : "HEAT" } }
निर्देशों के और उदाहरण हर विशेषता के रेफ़रंस में मिल सकते हैं करें. पूरी Trait लिस्टिंग देखें हमारा वीडियो देखें.
रिवॉर्ड पाएँ
अनुमति वाले स्ट्रक्चर या डिवाइस के बारे में जानकारी मिलती है.
GET
कॉल, किसी ऐसे स्ट्रक्चर या डिवाइस के लिए उपलब्ध सभी विशेषताओं के मौजूदा फ़ील्ड और वैल्यू के साथ एक रिस्पॉन्स दिखाता है जिसके लिए user ने अनुमति दी है. साथ ही, यह एक `parentRelations' ऑब्जेक्ट दिखाता है, जो मौजूदा संसाधन के पैरंट संसाधन को दिखाता है. यह संसाधन, कोई स्ट्रक्चर या रूम हो सकता है.
उदाहरण के लिए, Nest Thermostat से ये जानकारी मिल सकती है:
GET /enterprises/project-id/devices/device-id { "name" : "enterprises/project-id/devices/device-id", "type" : "sdm.devices.types.THERMOSTAT", "assignee" : "enterprises/project-id/structures/structure-id/rooms/room-id", "traits" : { "sdm.devices.traits.Connectivity" : { "status" : "ONLINE" }, "sdm.devices.traits.Fan" : { "timerMode" : "ON", "timerTimeout" : "2019-05-10T03:22:54Z" }, "sdm.devices.traits.Humidity" : { "ambientHumidityPercent" : 35.0 }, "sdm.devices.traits.Info" : { "customName" : "My device" }, "sdm.devices.traits.Settings" : { "temperatureScale" : "CELSIUS" }, "sdm.devices.traits.Temperature" : { "ambientTemperatureCelsius" : 23.0 }, "sdm.devices.traits.ThermostatEco" : { "availableModes" : ["MANUAL_ECO", "OFF"], "mode" : "MANUAL_ECO", "heatCelsius" : 20.0, "coolCelsius" : 22.0 }, "sdm.devices.traits.ThermostatHvac" : { "status" : "HEATING" }, "sdm.devices.traits.ThermostatMode" : { "availableModes" : ["HEAT", "COOL", "HEATCOOL", "OFF"], "mode" : "COOL" }, "sdm.devices.traits.ThermostatTemperatureSetpoint" : { "heatCelsius" : 20.0, "coolCelsius" : 22.0 } }, "parentRelations" : [ { "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id", "displayName" : "Lobby" } ] }
सूची
सूची में ऐसे स्ट्रक्चर, कमरे या डिवाइस की सूची होती है जिन्हें अनुमति मिली है.
किसी एक ऐक्सेस टोकन के तहत अनुमति वाले सभी स्ट्रक्चर, कमरों या डिवाइसों की सूची देखने के लिए, सही संसाधन एंडपॉइंट के लिए GET
कॉल करें:
GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices
Google Assistant के साथ इंटिग्रेशन
डिवाइस को एसडीएम इस्तेमाल करने की अनुमति मिलने के बाद, Google को Home ऐप्लिकेशन में उस डिवाइस की जानकारी मिलती है अपनी स्थिति का ग्राफ़ बनाएं और उसे सीधे तौर पर मैनेज करें. अगर आपने Google Assistant को इंटिग्रेट किया हुआ है, तो व्यावसायिक ऑफ़र के हिस्से के तौर पर:
- SDM डिवाइसों के लिए, सिंक करने का अनुरोध न भेजें
- सिंक करने के लिए भेजे गए किसी भी जवाब से एसडीएम डिवाइसों को हटा दें इंटेंट
गड़बड़ियां
एपीआई गड़बड़ी कोड की पूरी सूची के लिए, एपीआई गड़बड़ी कोड का रेफ़रंस देखें.