Package apple.matter

Class MTRDevice

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.matter.MTRDevice

All Implemented Interfaces:

NSObject

public class MTRDevice
extends NSObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MTRDevice.Block_invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutClientQueueCompletion
static interface	MTRDevice.Block_invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutQueueCompletion
static interface	MTRDevice.Block_openCommissioningWindowWithDiscriminatorDurationQueueCompletion
static interface	MTRDevice.Block_openCommissioningWindowWithSetupPasscodeDiscriminatorDurationQueueCompletion

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Block_accessibilityActivateBlock_ret, NSObject.Block_accessibilityActivationPointBlock_ret, NSObject.Block_accessibilityAttributedHintBlock_ret, NSObject.Block_accessibilityAttributedLabelBlock_ret, NSObject.Block_accessibilityAttributedUserInputLabelsBlock_ret, NSObject.Block_accessibilityAttributedValueBlock_ret, NSObject.Block_accessibilityContainerTypeBlock_ret, NSObject.Block_accessibilityCustomActionsBlock_ret, NSObject.Block_accessibilityCustomRotorsBlock_ret, NSObject.Block_accessibilityDecrementBlock_ret, NSObject.Block_accessibilityElementsBlock_ret, NSObject.Block_accessibilityElementsHiddenBlock_ret, NSObject.Block_accessibilityFrameBlock_ret, NSObject.Block_accessibilityHeaderElementsBlock_ret, NSObject.Block_accessibilityHintBlock_ret, NSObject.Block_accessibilityIdentifierBlock_ret, NSObject.Block_accessibilityIncrementBlock_ret, NSObject.Block_accessibilityLabelBlock_ret, NSObject.Block_accessibilityLanguageBlock_ret, NSObject.Block_accessibilityMagicTapBlock_ret, NSObject.Block_accessibilityNavigationStyleBlock_ret, NSObject.Block_accessibilityPathBlock_ret, NSObject.Block_accessibilityPerformEscapeBlock_ret, NSObject.Block_accessibilityRespondsToUserInteractionBlock_ret, NSObject.Block_accessibilityShouldGroupAccessibilityChildrenBlock_ret, NSObject.Block_accessibilityTextualContextBlock_ret, NSObject.Block_accessibilityTraitsBlock_ret, NSObject.Block_accessibilityUserInputLabelsBlock_ret, NSObject.Block_accessibilityValueBlock_ret, NSObject.Block_accessibilityViewIsModalBlock_ret, NSObject.Block_automationElementsBlock_ret, NSObject.Block_isAccessibilityElementBlock_ret, NSObject.Block_setAccessibilityActivateBlock, NSObject.Block_setAccessibilityActivationPointBlock, NSObject.Block_setAccessibilityAttributedHintBlock, NSObject.Block_setAccessibilityAttributedLabelBlock, NSObject.Block_setAccessibilityAttributedUserInputLabelsBlock, NSObject.Block_setAccessibilityAttributedValueBlock, NSObject.Block_setAccessibilityContainerTypeBlock, NSObject.Block_setAccessibilityCustomActionsBlock, NSObject.Block_setAccessibilityCustomRotorsBlock, NSObject.Block_setAccessibilityDecrementBlock, NSObject.Block_setAccessibilityElementsBlock, NSObject.Block_setAccessibilityElementsHiddenBlock, NSObject.Block_setAccessibilityFrameBlock, NSObject.Block_setAccessibilityHeaderElementsBlock, NSObject.Block_setAccessibilityHintBlock, NSObject.Block_setAccessibilityIdentifierBlock, NSObject.Block_setAccessibilityIncrementBlock, NSObject.Block_setAccessibilityLabelBlock, NSObject.Block_setAccessibilityLanguageBlock, NSObject.Block_setAccessibilityMagicTapBlock, NSObject.Block_setAccessibilityNavigationStyleBlock, NSObject.Block_setAccessibilityPathBlock, NSObject.Block_setAccessibilityPerformEscapeBlock, NSObject.Block_setAccessibilityRespondsToUserInteractionBlock, NSObject.Block_setAccessibilityShouldGroupAccessibilityChildrenBlock, NSObject.Block_setAccessibilityTextualContextBlock, NSObject.Block_setAccessibilityTraitsBlock, NSObject.Block_setAccessibilityUserInputLabelsBlock, NSObject.Block_setAccessibilityValueBlock, NSObject.Block_setAccessibilityViewIsModalBlock, NSObject.Block_setAutomationElementsBlock, NSObject.Block_setIsAccessibilityElementBlock, NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MTRDevice(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method	Description
static boolean	accessInstanceVariablesDirectly()
static MTRDevice	alloc()
static MTRDevice	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(@NotNull java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(@NotNull java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(@NotNull java.lang.Object aTarget, @NotNull org.moe.natj.objc.SEL aSelector, @Nullable java.lang.Object anArgument)
static @NotNull NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static @NotNull org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static @NotNull MTRDevice	deviceWithNodeIDController(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller)	TODO: Document usage better Directly instantiate a MTRDevice with a MTRDeviceController as a shim.
static @NotNull MTRDevice	deviceWithNodeIDDeviceController(long nodeID, @NotNull MTRDeviceController deviceController)	Deprecated.
@Nullable NSDate	estimatedStartTime()	The estimated device system start time.
static long	hash_static()
MTRDevice	init()
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
void	invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutClientQueueCompletion(@NotNull NSNumber endpointID, @NotNull NSNumber clusterID, @NotNull NSNumber commandID, @NotNull java.lang.Object commandFields, @Nullable NSArray<? extends NSDictionary<java.lang.String,?>> expectedValues, @Nullable NSNumber expectedValueInterval, @Nullable NSNumber timeout, @NotNull dispatch_queue_t queue, @NotNull MTRDevice.Block_invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutClientQueueCompletion completion)	Deprecated.
void	invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutQueueCompletion(@NotNull NSNumber endpointID, @NotNull NSNumber clusterID, @NotNull NSNumber commandID, @NotNull java.lang.Object commandFields, @Nullable NSArray<? extends NSDictionary<java.lang.String,?>> expectedValues, @Nullable NSNumber expectedValueInterval, @Nullable NSNumber timeout, @NotNull dispatch_queue_t queue, @NotNull MTRDevice.Block_invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutQueueCompletion completion)	* Invoke a command with a designated command path * * @param commandFields command fields object.
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static @NotNull NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(@NotNull java.lang.String key)
static MTRDevice	new_objc()
void	openCommissioningWindowWithDiscriminatorDurationQueueCompletion(@NotNull NSNumber discriminator, @NotNull NSNumber duration, @NotNull dispatch_queue_t queue, @NotNull MTRDevice.Block_openCommissioningWindowWithDiscriminatorDurationQueueCompletion completion)	Open a commissioning window on the device, using a random setup passcode.
void	openCommissioningWindowWithSetupPasscodeDiscriminatorDurationQueueCompletion(@NotNull NSNumber setupPasscode, @NotNull NSNumber discriminator, @NotNull NSNumber duration, @NotNull dispatch_queue_t queue, @NotNull MTRDevice.Block_openCommissioningWindowWithSetupPasscodeDiscriminatorDurationQueueCompletion completion)	Open a commissioning window on the device.
@Nullable NSDictionary<java.lang.String,?>	readAttributeWithEndpointIDClusterIDAttributeIDParams(@NotNull NSNumber endpointID, @NotNull NSNumber clusterID, @NotNull NSNumber attributeID, @Nullable MTRReadParams params)	Read attribute in a designated attribute path TODO: Need to document that this returns "the system's best guess" of attribute values.
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setDelegateQueue(@NotNull MTRDeviceDelegate delegate, @NotNull dispatch_queue_t queue)	Set the delegate to receive asynchronous callbacks about the device.
static void	setVersion_static(long aVersion)
long	state()	The current state of the device.
static org.moe.natj.objc.Class	superclass_static()
static boolean	useStoredAccessor()	Deprecated.
static long	version_static()
void	writeAttributeWithEndpointIDClusterIDAttributeIDValueExpectedValueIntervalTimedWriteTimeout(@NotNull NSNumber endpointID, @NotNull NSNumber clusterID, @NotNull NSNumber attributeID, @NotNull java.lang.Object value, @NotNull NSNumber expectedValueInterval, @Nullable NSNumber timeout)	Write to attribute in a designated attribute path

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivateBlock, accessibilityActivationPoint, accessibilityActivationPointBlock, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedHintBlock, accessibilityAttributedLabel, accessibilityAttributedLabelBlock, accessibilityAttributedUserInputLabels, accessibilityAttributedUserInputLabelsBlock, accessibilityAttributedValue, accessibilityAttributedValueBlock, accessibilityContainerType, accessibilityContainerTypeBlock, accessibilityCustomActions, accessibilityCustomActionsBlock, accessibilityCustomRotors, accessibilityCustomRotorsBlock, accessibilityDecrement, accessibilityDecrementBlock, accessibilityDirectTouchOptions, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsBlock, accessibilityElementsHidden, accessibilityElementsHiddenBlock, accessibilityFrame, accessibilityFrameBlock, accessibilityHeaderElementsBlock, accessibilityHint, accessibilityHintBlock, accessibilityIdentifierBlock, accessibilityIncrement, accessibilityIncrementBlock, accessibilityLabel, accessibilityLabelBlock, accessibilityLanguage, accessibilityLanguageBlock, accessibilityMagicTapBlock, accessibilityNavigationStyle, accessibilityNavigationStyleBlock, accessibilityPath, accessibilityPathBlock, accessibilityPerformEscape, accessibilityPerformEscapeBlock, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityRespondsToUserInteractionBlock, accessibilityScroll, accessibilityShouldGroupAccessibilityChildrenBlock, accessibilityTextualContext, accessibilityTextualContextBlock, accessibilityTraits, accessibilityTraitsBlock, accessibilityUserInputLabels, accessibilityUserInputLabelsBlock, accessibilityValue, accessibilityValueBlock, accessibilityViewIsModal, accessibilityViewIsModalBlock, accessibilityZoomInAtPoint, accessibilityZoomOutAtPoint, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, automationElements, automationElementsBlock, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hash, indexOfAccessibilityElement, isAccessibilityElement, isAccessibilityElementBlock, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivateBlock, setAccessibilityActivationPoint, setAccessibilityActivationPointBlock, setAccessibilityAttributedHint, setAccessibilityAttributedHintBlock, setAccessibilityAttributedLabel, setAccessibilityAttributedLabelBlock, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedUserInputLabelsBlock, setAccessibilityAttributedValue, setAccessibilityAttributedValueBlock, setAccessibilityContainerType, setAccessibilityContainerTypeBlock, setAccessibilityCustomActions, setAccessibilityCustomActionsBlock, setAccessibilityCustomRotors, setAccessibilityCustomRotorsBlock, setAccessibilityDecrementBlock, setAccessibilityDirectTouchOptions, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsBlock, setAccessibilityElementsHidden, setAccessibilityElementsHiddenBlock, setAccessibilityFrame, setAccessibilityFrameBlock, setAccessibilityHeaderElementsBlock, setAccessibilityHint, setAccessibilityHintBlock, setAccessibilityIdentifierBlock, setAccessibilityIncrementBlock, setAccessibilityLabel, setAccessibilityLabelBlock, setAccessibilityLanguage, setAccessibilityLanguageBlock, setAccessibilityMagicTapBlock, setAccessibilityNavigationStyle, setAccessibilityNavigationStyleBlock, setAccessibilityPath, setAccessibilityPathBlock, setAccessibilityPerformEscapeBlock, setAccessibilityRespondsToUserInteraction, setAccessibilityRespondsToUserInteractionBlock, setAccessibilityShouldGroupAccessibilityChildrenBlock, setAccessibilityTextualContext, setAccessibilityTextualContextBlock, setAccessibilityTraits, setAccessibilityTraitsBlock, setAccessibilityUserInputLabels, setAccessibilityUserInputLabelsBlock, setAccessibilityValue, setAccessibilityValueBlock, setAccessibilityViewIsModal, setAccessibilityViewIsModalBlock, setAutomationElements, setAutomationElementsBlock, setIsAccessibilityElement, setIsAccessibilityElementBlock, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, storedValueForKey, superclass, takeStoredValueForKey, takeValueForKey, takeValueForKeyPath, takeValuesFromDictionary, unableToSetNilForKey, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, valuesForKeys, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MTRDevice

protected MTRDevice(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MTRDevice alloc()

allocWithZone

public static MTRDevice allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(@NotNull
                                                           @NotNull java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(@NotNull
                                                           @NotNull java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

classFallbacksForKeyedArchiver

@NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

@NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

deviceWithNodeIDController

@NotNull
public static @NotNull MTRDevice deviceWithNodeIDController(@NotNull
                                                            @NotNull NSNumber nodeID,
                                                            @NotNull
                                                            @NotNull MTRDeviceController controller)

TODO: Document usage better Directly instantiate a MTRDevice with a MTRDeviceController as a shim. All device-specific information would be stored on the device controller, and retrieved when performing actions using a combination of MTRBaseDevice and MTRAsyncCallbackQueue. API-Since: 16.4

deviceWithNodeIDDeviceController

@Deprecated
@NotNull
public static @NotNull MTRDevice deviceWithNodeIDDeviceController(long nodeID,
                                                                  @NotNull
                                                                  @NotNull MTRDeviceController deviceController)

Deprecated.

Deprecated MTRDevice APIs. API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use deviceWithNodeID:controller:

estimatedStartTime

@Nullable
public @Nullable NSDate estimatedStartTime()

The estimated device system start time. A device can report its events with either calendar time or time since system start time. When events are reported with time since system start time, this property will return an estimation of the device system start time. Because a device may report timestamps this way due to the lack of a wall clock, system start time can only be estimated based on event receive time and the timestamp value, and this estimation may change over time. Device reboots may also cause the estimated device start time to jump forward. If events are always reported with calendar time, then this property will return nil. API-Since: 16.5

hash_static

public static long hash_static()

init

public MTRDevice init()

Overrides:

init in class NSObject

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutClientQueueCompletion

@Deprecated
public void invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutClientQueueCompletion(@NotNull
                                                                                                                                                 @NotNull NSNumber endpointID,
                                                                                                                                                 @NotNull
                                                                                                                                                 @NotNull NSNumber clusterID,
                                                                                                                                                 @NotNull
                                                                                                                                                 @NotNull NSNumber commandID,
                                                                                                                                                 @NotNull
                                                                                                                                                 @NotNull java.lang.Object commandFields,
                                                                                                                                                 @Nullable
                                                                                                                                                 @Nullable NSArray<? extends NSDictionary<java.lang.String,?>> expectedValues,
                                                                                                                                                 @Nullable
                                                                                                                                                 @Nullable NSNumber expectedValueInterval,
                                                                                                                                                 @Nullable
                                                                                                                                                 @Nullable NSNumber timeout,
                                                                                                                                                 @NotNull
                                                                                                                                                 @NotNull dispatch_queue_t queue,
                                                                                                                                                 @NotNull
                                                                                                                                                 @NotNull MTRDevice.Block_invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutClientQueueCompletion completion)

Deprecated.

API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: Please use invokeCommandWithEndpointID:clusterID:commandID:commandFields:expectedValues:expectedValueInterval:timedInvokeTimeout:queue:completion:

invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutQueueCompletion

public void invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutQueueCompletion(@NotNull
                                                                                                                                           @NotNull NSNumber endpointID,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull NSNumber clusterID,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull NSNumber commandID,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull java.lang.Object commandFields,
                                                                                                                                           @Nullable
                                                                                                                                           @Nullable NSArray<? extends NSDictionary<java.lang.String,?>> expectedValues,
                                                                                                                                           @Nullable
                                                                                                                                           @Nullable NSNumber expectedValueInterval,
                                                                                                                                           @Nullable
                                                                                                                                           @Nullable NSNumber timeout,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull dispatch_queue_t queue,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull MTRDevice.Block_invokeCommandWithEndpointIDClusterIDCommandIDCommandFieldsExpectedValuesExpectedValueIntervalTimedInvokeTimeoutQueueCompletion completion)

* Invoke a command with a designated command path * * @param commandFields command fields object. The object must be a data-value NSDictionary object * as described in the MTRDeviceResponseHandler. * The attribute must be a Structure, i.e., * the NSDictionary MTRTypeKey key must have the value MTRStructureValueType. * * @param expectedValues array of dictionaries containing the expected values in the same format as * attribute read completion handler. Requires MTRAttributePathKey values. * See MTRDeviceResponseHandler definition for dictionary details. * The expectedValues and expectedValueInterval arguments need to be both * nil or both non-nil, or both will be both ignored. * * TODO: document better the expectedValues is how this command is expected to change attributes when read, and that the next * readAttribute will get these values * * @param expectedValueInterval maximum interval in milliseconds during which reads of the attribute will return the value being * written. If the value is less than 1, both this value and expectedValues will be ignored. If this value is greater than UINT32_MAX, it will be clamped to UINT32_MAX. * * @param timeout timeout in milliseconds for timed invoke, or nil. This value must be within [1, UINT16_MAX], and will be clamped * to this range. * * @param completion response handler will receive either values or error. A * path-specific error status from the command invocation * will result in an error being passed to the completion, so * values will only be passed in when the command succeeds. API-Since: 16.4

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

@NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(@NotNull
                                                                                     @NotNull java.lang.String key)

new_objc

public static MTRDevice new_objc()

openCommissioningWindowWithDiscriminatorDurationQueueCompletion

public void openCommissioningWindowWithDiscriminatorDurationQueueCompletion(@NotNull
                                                                            @NotNull NSNumber discriminator,
                                                                            @NotNull
                                                                            @NotNull NSNumber duration,
                                                                            @NotNull
                                                                            @NotNull dispatch_queue_t queue,
                                                                            @NotNull
                                                                            @NotNull MTRDevice.Block_openCommissioningWindowWithDiscriminatorDurationQueueCompletion completion)

Open a commissioning window on the device, using a random setup passcode. On success, completion will be called on queue with the MTRSetupPayload that can be used to commission the device.

Parameters:

discriminator - The discriminator to use for the commissionable advertisement.

duration - Duration, in seconds, during which the commissioning window will be open. API-Since: 17.0

openCommissioningWindowWithSetupPasscodeDiscriminatorDurationQueueCompletion

public void openCommissioningWindowWithSetupPasscodeDiscriminatorDurationQueueCompletion(@NotNull
                                                                                         @NotNull NSNumber setupPasscode,
                                                                                         @NotNull
                                                                                         @NotNull NSNumber discriminator,
                                                                                         @NotNull
                                                                                         @NotNull NSNumber duration,
                                                                                         @NotNull
                                                                                         @NotNull dispatch_queue_t queue,
                                                                                         @NotNull
                                                                                         @NotNull MTRDevice.Block_openCommissioningWindowWithSetupPasscodeDiscriminatorDurationQueueCompletion completion)

Open a commissioning window on the device. On success, completion will be called on queue with the MTRSetupPayload that can be used to commission the device.

Parameters:

setupPasscode - The setup passcode to use for the commissioning window. See MTRSetupPayload's generateRandomSetupPasscode for generating a valid random passcode.

discriminator - The discriminator to use for the commissionable advertisement.

duration - Duration, in seconds, during which the commissioning window will be open. API-Since: 16.2

readAttributeWithEndpointIDClusterIDAttributeIDParams

@Nullable
public @Nullable NSDictionary<java.lang.String,?> readAttributeWithEndpointIDClusterIDAttributeIDParams(@NotNull
                                                                                                              @NotNull NSNumber endpointID,
                                                                                                              @NotNull
                                                                                                              @NotNull NSNumber clusterID,
                                                                                                              @NotNull
                                                                                                              @NotNull NSNumber attributeID,
                                                                                                              @Nullable
                                                                                                              @Nullable MTRReadParams params)

Read attribute in a designated attribute path TODO: Need to document that this returns "the system's best guess" of attribute values.

Returns:

a data-value dictionary of the attribute as described in MTRDeviceResponseHandler

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setDelegateQueue

public void setDelegateQueue(@NotNull
                             @NotNull MTRDeviceDelegate delegate,
                             @NotNull
                             @NotNull dispatch_queue_t queue)

Set the delegate to receive asynchronous callbacks about the device. The delegate will be called on the provided queue, for attribute reports, event reports, and device state changes.

setVersion_static

public static void setVersion_static(long aVersion)

state

public long state()

The current state of the device. The three states: MTRDeviceStateUnknown Unable to determine the state of the device at the moment. MTRDeviceStateReachable Communication with the device is expected to succeed. MTRDeviceStateUnreachable The device is currently unreachable.

superclass_static

public static org.moe.natj.objc.Class superclass_static()

useStoredAccessor

@Deprecated
public static boolean useStoredAccessor()

Deprecated.

version_static

public static long version_static()

writeAttributeWithEndpointIDClusterIDAttributeIDValueExpectedValueIntervalTimedWriteTimeout

public void writeAttributeWithEndpointIDClusterIDAttributeIDValueExpectedValueIntervalTimedWriteTimeout(@NotNull
                                                                                                        @NotNull NSNumber endpointID,
                                                                                                        @NotNull
                                                                                                        @NotNull NSNumber clusterID,
                                                                                                        @NotNull
                                                                                                        @NotNull NSNumber attributeID,
                                                                                                        @NotNull
                                                                                                        @NotNull java.lang.Object value,
                                                                                                        @NotNull
                                                                                                        @NotNull NSNumber expectedValueInterval,
                                                                                                        @Nullable
                                                                                                        @Nullable NSNumber timeout)

Write to attribute in a designated attribute path

Parameters:

value - A data-value NSDictionary object as described in MTRDeviceResponseHandler.

expectedValueInterval - maximum interval in milliseconds during which reads of the attribute will return the value being written. This value must be within [1, UINT32_MAX], and will be clamped to this range. TODO: document that -readAttribute... will return the expected value for the [endpoint,cluster,attribute] until one of the following: 1. Another write for the same attribute happens. 2. expectedValueIntervalMs (clamped) expires. Need to figure out phrasing here. 3. We succeed at writing the attribute. 4. We fail at writing the attribute and give up on the write

timeout - timeout in milliseconds for timed write, or nil. This value must be within [1, UINT16_MAX], and will be clamped to this range. TODO: make timeout arguments uniform