यह देखना कि कोई ट्रैट किसी निर्देश के साथ काम करता है या नहीं
किसी विशेषता के लिए सहायता भी देखी जा सकती है. किसी खास डिवाइस के लिए कोई कमांड काम करता है या नहीं, यह देखने के लिए ट्रैट-लेवल के supports
फ़ंक्शन का भी इस्तेमाल करें.
उदाहरण के लिए, किसी डिवाइस पर चालू/बंद करने की सुविधा के toggle
कमांड के काम करने की जांच करने के लिए:
// Check if the OnOff trait supports the toggle command. if (onOffTrait.supports(OnOff.Command.Toggle)) { println("onOffTrait supports toggle command") } else { println("onOffTrait does not support stateful toggle command") }
किसी डिवाइस को निर्देश भेजना
कोई निर्देश भेजना, किसी ट्रैट से स्टेटस एट्रिब्यूट को पढ़ने जैसा ही है. डिवाइस को चालू या बंद करने के लिए, OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
OnOff
�toggle()
इस तरीके से, onOff
को false
में बदला जाता है, अगर यह true
है. अगर यह false
है, तो इसे true
में बदला जाता है:
// Calling a command on a trait. try { onOffTrait.toggle() } catch (e: HomeException) { // Code for handling the exception }
ट्रेट के सभी निर्देश suspend
फ़ंक्शन होते हैं. ये निर्देश तब ही पूरे होते हैं, जब एपीआई से कोई जवाब मिलता है. जैसे, डिवाइस की स्थिति में बदलाव होने की पुष्टि करना.
अगर निर्देशों को लागू करने के फ़्लो में कोई समस्या का पता चलता है, तो निर्देशों से कोई अपवाद दिख सकता है. डेवलपर के तौर पर, आपको इन अपवादों को ठीक से मैनेज करने के लिए, try-catch
ब्लॉक का इस्तेमाल करना चाहिए. साथ ही, उन मामलों में उपयोगकर्ताओं को पूरी जानकारी देनी चाहिए जिनमें गड़बड़ियों को ठीक किया जा सकता है. बिना मैनेज किए गए अपवाद, ऐप्लिकेशन के रनटाइम को रोक देंगे और आपके ऐप्लिकेशन को क्रैश कर सकते हैं.
इसके अलावा, स्थिति को साफ़ तौर पर सेट करने के लिए, off()
या on()
निर्देशों का इस्तेमाल करें:
onOffTrait.off() onOffTrait.on()
स्थिति बदलने का निर्देश भेजने के बाद, उसे पूरा होने पर, डिवाइस की स्थिति पढ़ें में बताए गए तरीके से स्थिति को पढ़ा जा सकता है, ताकि उसे अपने ऐप्लिकेशन में मैनेज किया जा सके. इसके अलावा, स्थिति देखें में बताए गए तरीके से फ़्लो का इस्तेमाल किया जा सकता है. यह सबसे सही तरीका है.
पैरामीटर के साथ कोई निर्देश भेजना
कुछ निर्देशों में पैरामीटर का इस्तेमाल किया जा सकता है. जैसे, OnOff
या LevelControl
के ट्रैट में मौजूद पैरामीटर:
offWithEffect
// Turn off the light using the DyingLight effect. onOffTrait.offWithEffect( effectIdentifier = OnOffTrait.EffectIdentifierEnum.DyingLight, effectVariant = 0u, )
moveToLevel
// Change the brightness of the light to 50% levelControlTrait.moveToLevel( level = 127u.toUByte(), transitionTime = null, optionsMask = LevelControlTrait.OptionsBitmap(), optionsOverride = LevelControlTrait.OptionsBitmap(), )
कुछ निर्देशों में वैकल्पिक आर्ग्युमेंट होते हैं, जो ज़रूरी आर्ग्युमेंट के बाद आते हैं.
उदाहरण के लिए, FanControl
ट्रेट के लिए step
कमांड के दो वैकल्पिक आर्ग्युमेंट हैं:
val fanControlTraitFlow: Flow<FanControl?> = device.type(FanDevice).map { it.standardTraits.fanControl }.distinctUntilChanged() val fanControl = fanControlTraitFlow.firstOrNull() // Calling a command with optional parameters not set. fanControl?.step(direction = FanControlTrait.StepDirectionEnum.Increase) // Calling a command with optional parameters. fanControl?.step(direction = FanControlTrait.StepDirectionEnum.Increase) { wrap = true }
यह देखना कि कोई ट्रैट किसी एट्रिब्यूट के साथ काम करता है या नहीं
ऐसा हो सकता है कि कुछ डिवाइसों पर Matter ट्रैट काम करे, लेकिन किसी खास एट्रिब्यूट के साथ काम न करे. उदाहरण के लिए, ऐसा हो सकता है कि Cloud-to-cloud डिवाइस, Matter एट्रिब्यूट के हर वैरिएंट के साथ काम न करे.Matter इस तरह के मामलों को मैनेज करने के लिए, supports
फ़ंक्शन और Attribute
एट्रिब्यूट के एनोटेशन का इस्तेमाल करें. इससे यह पता चलता है कि एट्रिब्यूट किसी डिवाइस के लिए काम करता है या नहीं.
उदाहरण के लिए, किसी डिवाइस पर चालू/बंद ट्रैट के onOff
एट्रिब्यूट के काम करने की जांच करने के लिए:
// Check if the OnOff trait supports the onOff attribute. if (onOffTrait.supports(OnOff.Attribute.onOff)) { println("onOffTrait supports onOff state") } else { println("onOffTrait is for a command only device!") }
Matter स्पेसिफ़िकेशन या Cloud-to-cloud smart home स्कीमा में, कुछ एट्रिब्यूट के लिए वैल्यू सबमिट करना ज़रूरी नहीं है. इन एट्रिब्यूट के लिए, यह तय किया जा सकता है कि एट्रिब्यूट से मिली null वैल्यू, डिवाइस की ओर से वैल्यू रिपोर्ट न करने की वजह से मिली है या एट्रिब्यूट की वैल्यू असल में null
है. इसके लिए, supports
के साथ-साथ isNullable
का इस्तेमाल करें:
// Check if a nullable attribute is set or is not supported. if (onOffTrait.supports(OnOff.Attribute.startUpOnOff)) { // The device supports startupOnOff, it is safe to expect this value in the trait. if (OnOff.Attribute.startUpOnOff.isNullable && onOffTrait.startUpOnOff == null) { // This value is nullable and set to null. Check the specification as to // what null in this case means println("onOffTrait supports startUpOnOff and it is null") } else { // This value is nullable and set to a value. println("onOffTrait supports startUpOnOff and it is set to ${onOffTrait.startUpOnOff}") } } else { println("onOffTrait does not support startUpOnOff!") }
ट्रैट एट्रिब्यूट अपडेट करना
अगर आपको किसी एट्रिब्यूट की वैल्यू बदलनी है और ट्रेट का कोई भी कमांड ऐसा नहीं करता है, तो हो सकता है कि एट्रिब्यूट की वैल्यू साफ़ तौर पर सेट की जा सके.
किसी एट्रिब्यूट की वैल्यू बदली जा सकती है या नहीं, यह दो बातों पर निर्भर करता है:
- क्या एट्रिब्यूट में बदलाव किया जा सकता है?
- क्या किसी ट्रेट कमांड को भेजने के साइड इफ़ेक्ट के तौर पर, एट्रिब्यूट की वैल्यू बदल सकती है?
इस जानकारी के लिए, ट्रेट और उनके एट्रिब्यूट के रेफ़रंस दस्तावेज़ देखें.
इसलिए, प्रॉपर्टी के ऐसे कॉम्बिनेशन जो यह तय करते हैं कि किसी एट्रिब्यूट की वैल्यू कैसे बदली जा सकती है:
सिर्फ़ पढ़ने के लिए है और अन्य निर्देशों का इस पर कोई असर नहीं पड़ता. इसका मतलब है कि एट्रिब्यूट की वैल्यू नहीं बदलती. उदाहरण के लिए,
Switch
ट्रीट कीcurrentPosition
एट्रिब्यूट वैल्यू.सिर्फ़ पढ़ने के लिए है और दूसरे निर्देशों से इस पर असर पड़ता है. इसका मतलब है कि एट्रिब्यूट की वैल्यू सिर्फ़ कमांड भेजने पर बदल सकती है. उदाहरण के लिए,
LevelControl
Matter ट्रीट की वैल्यू केcurrentLevel
एट्रिब्यूट की वैल्यू को सिर्फ़ पढ़ा जा सकता है. हालांकि,moveToLevel
जैसे निर्देशों की मदद से इसकी वैल्यू में बदलाव किया जा सकता है.इनमें डेटा लिखा जा सकता है और दूसरे निर्देशों का इन पर कोई असर नहीं पड़ता. इसका मतलब है कि आपके पास, ट्रैट के
update
फ़ंक्शन का इस्तेमाल करके, एट्रिब्यूट की वैल्यू को सीधे तौर पर बदलने का विकल्प है. हालांकि, ऐसे कोई भी निर्देश नहीं हैं जिनसे एट्रिब्यूट की वैल्यू पर असर पड़े. उदाहरण के लिए,DoorLock
ट्रीट कीWrongCodeEntryLimit
एट्रिब्यूट वैल्यू.इनमें डेटा लिखा जा सकता है और इन पर अन्य निर्देशों का असर पड़ता है. इसका मतलब है कि आपके पास, ट्रैट के
update
फ़ंक्शन का इस्तेमाल करके, एट्रिब्यूट की वैल्यू को सीधे तौर पर बदलने का विकल्प है. साथ ही, कोई निर्देश भेजने पर, एट्रिब्यूट की वैल्यू बदल सकती है. उदाहरण के लिए,Thermostat
ट्रीट की वैल्यू केoccupiedCoolingSetpoint
एट्रिब्यूट को लिखा जा सकता है. साथ ही,setpointRaiseLower
कमांड की मदद से अपडेट भी किया जा सकता है.
किसी एट्रिब्यूट की वैल्यू बदलने के लिए, अपडेट फ़ंक्शन का इस्तेमाल करने का उदाहरण
इस उदाहरण में, DoorLockTrait.WrongCodeEntryLimit
एट्रिब्यूट की वैल्यू साफ़ तौर पर सेट करने का तरीका बताया गया है.
एट्रिब्यूट की वैल्यू सेट करने के लिए, ट्रैट के update
फ़ंक्शन को कॉल करें और उसे एक म्यूटेटर फ़ंक्शन पास करें, जो नई वैल्यू सेट करता है.
सबसे पहले, पुष्टि करना अच्छा होता है कि ट्रेट में एट्रिब्यूट काम करता है या नहीं.
उदाहरण के लिए:
var doorLockDevice = home.devices().list().first { device -> device.has(DoorLock) } val traitFlow: Flow<DoorLock?> = doorLockDevice.type(DoorLockDevice).map { it.standardTraits.doorLock }.distinctUntilChanged() val doorLockTrait: DoorLock = traitFlow.first()!! if (doorLockTrait.supports(DoorLock.Attribute.wrongCodeEntryLimit)) { val unused = doorLockTrait.update { setWrongCodeEntryLimit(3u) } }