Android पर Structure API

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

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

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

Home APIs में मौजूद कोई भी तरीका, 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
            }
        }
    }
}

ऑटोमेशन

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