Android पर Structure API

Android के लिए Home API के ज़रिए, स्ट्रक्चर API को ऐक्सेस किया जा सकता है. अपने ऐप्लिकेशन में ये पैकेज इंपोर्ट करें:

import com.google.home.Home
import com.google.home.Id
import com.google.home.Structure

गड़बड़ी ठीक करना

होम एपीआई में मौजूद कोई भी तरीका, HomeException को थ्रो कर सकता है. इसलिए, हमारा सुझाव है कि सभी कॉल पर HomeException को पकड़ने के लिए, try-catch ब्लॉक का इस्तेमाल करें.

HomeException को मैनेज करते समय, उसके error.code और error.message फ़ील्ड देखें. इससे आपको गड़बड़ी के बारे में पता चलेगा. इसमें सब-गड़बड़ी कोड भी हो सकते हैं. इसलिए, getSubErrorCodes() तरीके को कॉल करें और नतीजे देखें.

अगर किसी अपवाद को हैंडल नहीं किया जाता है, तो आपका ऐप्लिकेशन क्रैश हो जाएगा.

ज़्यादा जानकारी के लिए, गड़बड़ी ठीक करना लेख पढ़ें.

कॉल के सैंपल

स्ट्रक्चर की सूची पाना

शुरू होने के बाद, structures() कॉल से आपको ऐक्सेस किए जा सकने वाले स्ट्रक्चर का फ़्लो मिलता है:

// Get a flow of all structures accessible to the user
val allStructuresFlow: HomeObjectsFlow<Structure> = home.structures()

// Calling list() on a HomeObjectsFlow returns the first Set of elements.
val allStructures: Set<Structure> = allStructuresFlow.list()

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

इसके अलावा, अगर रिएक्टिव प्रोग्रामिंग के बजाय इंपरेटिव प्रोग्रामिंग का इस्तेमाल करना ज़रूरी है, तो टर्मिनल फ़्लो ऑपरेटर का इस्तेमाल किया जा सकता है:

val everyStructure = withTimeout(5000) { home.structures().first { it.isNotEmpty() } }

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

स्ट्रक्चर की प्रॉपर्टी पाना

स्ट्रक्चर की सूची मिलने के बाद, उनके लिए प्रॉपर्टी ऐक्सेस की जा सकती हैं:

// Get a flow on a structure. Flow emits new values on structure metadata changes: name.
val structureFlow: Flow<Structure> = home.structures().itemFlow(myStructureId)

// Get a snapshot of the structure.
val structure: Structure = structureFlow.first()

// Get structure properties
println("id ${structure.id}")
println("name ${structure.name}")

नाम के हिसाब से स्ट्रक्चर ढूंढना

अगर आपको किसी स्ट्रक्चर का नाम पता है, तो name प्रॉपर्टी का इस्तेमाल करके भी उसे ऐक्सेस किया जा सकता है:

val myHome = home.structures().list().first { it.name == "My home" }

यहां से, हर स्ट्रक्चर के लिए प्रॉपर्टी, कमरों, और डिवाइसों को ऐक्सेस किया जा सकता है.

एक से ज़्यादा स्ट्रक्चर के साथ काम करना

एक से ज़्यादा स्ट्रक्चर का इस्तेमाल करने के लिए, हर स्ट्रक्चर का अलग रेफ़रंस पाएं:

var structure1: Structure? = null
var structure2: Structure? = null

try {
  structure1 = home.structures().list().firstOrNull { it.name == "Main House" }
} catch (e: HomeException) {
  // Code for handling the exception
}
try {
  structure2 = home.structures().list().firstOrNull { it.name == "Guest Cottage" }
} catch (e: HomeException) {
  // Code for handling the exception
}

चैट रूम की सूची पाना

स्ट्रक्चर की मदद से, चैट रूम की सूची देखी जा सकती है. साथ ही, उनके लिए प्रॉपर्टी ऐक्सेस की जा सकती हैं:

val allRoomsFlow: HomeObjectsFlow<Room> = structure.rooms()
val allRooms: Set<Room> = allRoomsFlow.list()
val room: Room = allRooms.first()

println("id ${room.id}")
println("name ${room.name}")

चैट रूम बनाएं

नया रूम बनाने के लिए:

val testName = "Test Room Name"
val newRoom: Room = structure.createRoom(testName)

किसी रूम को मिटाना

इसके अलावा, चैट रूम को मिटाने के लिए:

val roomToDelete = structure.rooms().list().filter { it.name == "room_id1" }.firstOrNull()
    structure.deleteRoom(roomToDelete!!)

सिर्फ़ आईडी का इस्तेमाल करके भी किसी रूम को मिटाया जा सकता है:

val roomToDelete1 = allRooms.filter { it.id == testRoomId }.firstOrNull()
structure.deleteRoom(roomToDelete1!!)

अगर डिवाइसों वाले किसी रूम को मिटा दिया जाता है, तो डिवाइस अब भी स्ट्रक्चर में मौजूद रहेंगे. हालांकि, उन्हें किसी रूम के लिए असाइन नहीं किया जाएगा.

डिवाइसों को किसी दूसरे कमरे में ले जाना

स्ट्रक्चर बनाने के बाद, डिवाइसों को उस स्ट्रक्चर के किसी दूसरे रूम में ट्रांसफ़र किया जा सकता है:

val room2 = structure.rooms().get(Id("room_id_other_structure"))
    val device1 = structure.devices().get(Id("device_id1"))
    structure.moveDevicesToRoom(room2!!, listOf(device1!!))

अगर आपके पास सिर्फ़ डिवाइस और कमरे के आईडी हैं, तो भी डिवाइसों को ट्रांसफ़र किया जा सकता है:

structure.moveDevicesToRoom(Id("room_id_other_structure"), listOf(Id("device_id1")))

किसी रूम का नाम बदलना

किसी रूम का नाम बदलने के लिए, setName() तरीके को कॉल करें:

livingRoom.setName("Living Room")

अगर नाम में 60 यूनिकोड कोड पॉइंट (वर्ण) से ज़्यादा हैं, तो उन्हें छोटा कर दिया जाएगा. हालांकि, कोई गड़बड़ी नहीं दिखेगी. डेवलपर की यह ज़िम्मेदारी है कि वे लंबे नामों को मैनेज करें. उदाहरण के लिए, वे यह तय कर सकते हैं कि उन्हें उपयोगकर्ताओं को यह सूचना देनी है या नहीं कि नाम छोटा कर दिया जाएगा.

यह देखना कि उपयोगकर्ता ने किन डिवाइसों के लिए अनुमतियां दी हैं

Google Home के नेटवर्क में, ज़्यादातर डिवाइस टाइप के लिए, उपयोगकर्ता एक बार में उस टाइप के सभी डिवाइसों के लिए अनुमतियां दे सकते हैं. संवेदनशील या पाबंदी वाले डिवाइस टाइप, जैसे कि लॉक, कैमरे या डोरबेल के लिए, उपयोगकर्ताओं को उन्हें अलग-अलग अनुमति देनी होगी.

यह पता लगाने के लिए कि किसी उपयोगकर्ता ने संवेदनशील या प्रतिबंधित डिवाइस टाइप को ऐक्सेस करने की अनुमति दी है या नहीं, स्ट्रक्चर-लेवल के consentedDeviceTypes() फ़ंक्शन का इस्तेमाल करें:

import com.google.home.Structure
import com.google.home.DeviceType
import com.google.home.DeviceTypeFactory
import com.google.home.consentedDeviceTypes // Extension function from the SDK
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.collect
import kotlinx.coroutines.launch

/**
 * Example of how an app may monitor which device types have been granted access by a user.
 */
fun monitorDeviceConsent(structure: Structure, myScope: CoroutineScope) {
    // Obtain the flow of consented device type factories
    val consentedTypesFlow: Flow<Set<DeviceTypeFactory<out DeviceType>>> =
        structure.consentedDeviceTypes()

    myScope.launch {
        consentedTypesFlow.collect { consentedSet ->
            // Check if the user has consented to share a specific restricted
            // type, such as a Doorbell or Camera.
            val hasCameraAccess = consentedSet.any {
                it.toString() == "matter.google.type.GoogleDoorbellDevice"
            }

            if (hasCameraAccess) {
                // Enable features that require camera access
            } else {
                // Inform the user or disable camera-specific features
            }
        }
    }
}

ऑटोमेशन

ऑटोमेशन एपीआई का एंट्री पॉइंट, स्ट्रक्चर के ज़रिए होता है. होम एपीआई में ऑटोमेशन के बारे में ज़्यादा जानने के लिए, Android पर Automation API की खास जानकारी देखें.