NLWeaveDeviceManager

Summary

Inheritance

Inherits from: NSObject

Properties
`BleConnectionPreparationCompleteHandler`	`PreparationCompleteHandler`
`blePeripheral`	`CBPeripheral *`
`name`	`NSString *`
`owner`	`id`
`resultCallbackQueue`	`dispatch_queue_t`

Public functions
`Close:failure:(WDMCompletionBlock completionHandler, WDMFailureBlock failureHandler)`	`virtual void` Close all connections gracifully.
`GetDeviceAddress:(NSMutableString *strAddr)`	`virtual WEAVE_ERROR`
`GetDeviceId:(uint64_t *deviceId)`	`virtual WEAVE_ERROR`
`GetDeviceMgrPtr:(long long *deviceMgrPtr)`	`virtual WEAVE_ERROR`
`NS_UNAVAILABLE()`	`virtual instancetype` Disable default initializer inherited from NSObject.
`Shutdown:(WDMCompletionBlock completionHandler)`	`virtual void` Forcifully release all resources and destroy all references.
`addNetwork:completion:failure:(NLNetworkInfo *nlNetworkInfo, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`armFailSafe:failSafeToken:completion:failure:(uint8_t armMode, uint32_t failSafeToken, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`connectBle:completion:failure:(CBPeripheral *peripheral, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`connectBleWithDeviceAccessToken:accessToken:completion:failure:(CBPeripheral peripheral, NSString accessToken, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`connectBleWithPairingCode:pairingCode:completion:failure:(CBPeripheral peripheral, NSString pairingCode, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`connectDevice:deviceAddress:completion:failure:(uint64_t deviceId, NSString *deviceAddress, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`createFabric:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`disableConnectionMonitor:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`disableNetwork:completion:failure:(NLNetworkID networkId, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`disarmFailSafe:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`enableConnectionMonitor:timeout:completion:failure:(NSInteger intervalMs, NSInteger timeoutMs, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`enableNetwork:completion:failure:(NLNetworkID networkId, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`getCameraAuthData:completion:failure:(NSString *nonce, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`getFabricConfig:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`getLastNetworkProvisioningResult:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`getNetworks:completion:failure:(uint8_t flags, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`getRendezvousMode:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`getWirelessRegulatoryConfig:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`identifyDevice:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`init:weaveWorkQueue:appCallbackQueue:exchangeMgr:securityMgr:(NSString name, dispatch_queue_t weaveWorkQueue, dispatch_queue_t appCallbackQueue, nl::Weave::WeaveExchangeManager exchangeMgr, nl::Weave::WeaveSecurityManager *NS_DESIGNATED_INITIALIZER)`	`virtual instancetype`
`isConnected()`	`virtual BOOL`
`isValidPairingCode:(NSString *pairingCode)`	`virtual BOOL`
`joinExistingFabric:completion:failure:(NSData *fabricConfig, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`leaveFabric:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`pairToken:completion:failure:(NSData *pairingToken, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`passiveRendezvousWithCompletion:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`passiveRendezvousWithDeviceAccessToken:completion:failure:(NSString *accessToken, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`passiveRendezvousWithDevicePairingCode:completion:failure:(NSString *pairingCode, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`ping:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`reconnectDevice:failure:(WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`registerServicePairAccount:completion:failure:(NLServiceInfo *nlServiceInfo, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`remotePassiveRendezvousWithDevicePairingCode:IPAddress:rendezvousTimeout:inactivityTimeout:completion:failure:(NSString pairingCode, NSString IPAddress, uint16_t rendezvousTimeoutSec, uint16_t inactivityTimeoutSec, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`removeNetwork:completion:failure:(NLNetworkID networkId, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`rendezvousWithDeviceAccessToken:identifyDeviceCriteria:completion:failure:(NSString accessToken, NLIdentifyDeviceCriteria identifyDeviceCriteria, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`rendezvousWithDevicePairingCode:completion:failure:(NSString *pairingCode, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`rendezvousWithDevicePairingCode:identifyDeviceCriteria:completion:failure:(NSString pairingCode, NLIdentifyDeviceCriteria identifyDeviceCriteria, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`resetConfig:completion:failure:(uint16_t resetFlags, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`scanNetworks:completion:failure:(NLNetworkType networkType, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`setAutoReconnect:(BOOL autoReconnect)`	`virtual WEAVE_ERROR`
`setRendezvousAddress:(NSString *aRendezvousAddress)`	`virtual NSInteger`
`setRendezvousMode:completion:failure:(uint16_t rendezvousFlags, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`setWirelessRegulatoryConfig:completion:failure:(NLWirelessRegConfig *nlWirelessRegConfig, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`startDeviceEnumerationWithIdentifyDeviceCriteria:completion:failure:(NLIdentifyDeviceCriteria *identifyDeviceCriteria, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`startSystemTest:testId:completion:failure:(uint32_t profileId, uint32_t testId, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`statusReportToString:statusCode:(NSUInteger profileId, NSInteger statusCode)`	`virtual NSString *`
`stopDeviceEnumeration()`	`virtual void`
`testNetworkConnectivity:completion:failure:(NLNetworkID networkId, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`toErrorString:(WEAVE_ERROR err)`	`virtual NSString *`
`unregisterService:completion:failure:(uint64_t serviceId, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`updateNetwork:completion:failure:(NLNetworkInfo *netInfo, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`
`updateService:completion:failure:(NLServiceInfo *nlServiceInfo, WDMCompletionBlock completionBlock, WDMFailureBlock failureBlock)`	`virtual void`

Properties

BleConnectionPreparationCompleteHandler

PreparationCompleteHandler BleConnectionPreparationCompleteHandler

blePeripheral

CBPeripheral * blePeripheral

name

NSString * name

owner

id owner

resultCallbackQueue

dispatch_queue_t resultCallbackQueue

Public functions

Close:failure:

virtual void Close:failure:(
  WDMCompletionBlock completionHandler,
  WDMFailureBlock failureHandler
)

Close all connections gracifully.

The device manager would be ready for another connection after completion.

GetDeviceAddress:

virtual WEAVE_ERROR GetDeviceAddress:(
  NSMutableString *strAddr
)

GetDeviceId:

virtual WEAVE_ERROR GetDeviceId:(
  uint64_t *deviceId
)

GetDeviceMgrPtr:

virtual WEAVE_ERROR GetDeviceMgrPtr:(
  long long *deviceMgrPtr
)

NS_UNAVAILABLE

virtual instancetype NS_UNAVAILABLE()

Disable default initializer inherited from NSObject.

Shutdown:

virtual void Shutdown:(
  WDMCompletionBlock completionHandler
)

Forcifully release all resources and destroy all references.

There is no way to revive this device manager after this call.

addNetwork:completion:failure:

virtual void addNetwork:completion:failure:(
  NLNetworkInfo *nlNetworkInfo,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

armFailSafe:failSafeToken:completion:failure:

virtual void armFailSafe:failSafeToken:completion:failure:(
  uint8_t armMode,
  uint32_t failSafeToken,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

connectBle:completion:failure:

virtual void connectBle:completion:failure:(
  CBPeripheral *peripheral,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

connectBleWithDeviceAccessToken:accessToken:completion:failure:

virtual void connectBleWithDeviceAccessToken:accessToken:completion:failure:(
  CBPeripheral *peripheral,
  NSString *accessToken,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

connectBleWithPairingCode:pairingCode:completion:failure:

virtual void connectBleWithPairingCode:pairingCode:completion:failure:(
  CBPeripheral *peripheral,
  NSString *pairingCode,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

connectDevice:deviceAddress:completion:failure:

virtual void connectDevice:deviceAddress:completion:failure:(
  uint64_t deviceId,
  NSString *deviceAddress,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

createFabric:failure:

virtual void createFabric:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

disableConnectionMonitor:failure:

virtual void disableConnectionMonitor:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

disableNetwork:completion:failure:

virtual void disableNetwork:completion:failure:(
  NLNetworkID networkId,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

disarmFailSafe:failure:

virtual void disarmFailSafe:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

enableConnectionMonitor:timeout:completion:failure:

virtual void enableConnectionMonitor:timeout:completion:failure:(
  NSInteger intervalMs,
  NSInteger timeoutMs,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

enableNetwork:completion:failure:

virtual void enableNetwork:completion:failure:(
  NLNetworkID networkId,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

getCameraAuthData:completion:failure:

virtual void getCameraAuthData:completion:failure:(
  NSString *nonce,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

getFabricConfig:failure:

virtual void getFabricConfig:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

getLastNetworkProvisioningResult:failure:

virtual void getLastNetworkProvisioningResult:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

getNetworks:completion:failure:

virtual void getNetworks:completion:failure:(
  uint8_t flags,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

getRendezvousMode:failure:

virtual void getRendezvousMode:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

getWirelessRegulatoryConfig:failure:

virtual void getWirelessRegulatoryConfig:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

identifyDevice:failure:

virtual void identifyDevice:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

init:weaveWorkQueue:appCallbackQueue:exchangeMgr:securityMgr:

virtual instancetype init:weaveWorkQueue:appCallbackQueue:exchangeMgr:securityMgr:(
  NSString *name,
  dispatch_queue_t weaveWorkQueue,
  dispatch_queue_t appCallbackQueue,
  nl::Weave::WeaveExchangeManager *exchangeMgr,
  nl::Weave::WeaveSecurityManager *NS_DESIGNATED_INITIALIZER
)

isConnected

virtual BOOL isConnected()

isValidPairingCode:

virtual BOOL isValidPairingCode:(
  NSString *pairingCode
)

joinExistingFabric:completion:failure:

virtual void joinExistingFabric:completion:failure:(
  NSData *fabricConfig,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

leaveFabric:failure:

virtual void leaveFabric:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

pairToken:completion:failure:

virtual void pairToken:completion:failure:(
  NSData *pairingToken,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

passiveRendezvousWithCompletion:failure:

virtual void passiveRendezvousWithCompletion:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

passiveRendezvousWithDeviceAccessToken:completion:failure:

virtual void passiveRendezvousWithDeviceAccessToken:completion:failure:(
  NSString *accessToken,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

passiveRendezvousWithDevicePairingCode:completion:failure:

virtual void passiveRendezvousWithDevicePairingCode:completion:failure:(
  NSString *pairingCode,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

ping:failure:

virtual void ping:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

reconnectDevice:failure:

virtual void reconnectDevice:failure:(
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

registerServicePairAccount:completion:failure:

virtual void registerServicePairAccount:completion:failure:(
  NLServiceInfo *nlServiceInfo,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

remotePassiveRendezvousWithDevicePairingCode:IPAddress:rendezvousTimeout:inactivityTimeout:completion:failure:

virtual void remotePassiveRendezvousWithDevicePairingCode:IPAddress:rendezvousTimeout:inactivityTimeout:completion:failure:(
  NSString *pairingCode,
  NSString *IPAddress,
  uint16_t rendezvousTimeoutSec,
  uint16_t inactivityTimeoutSec,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

removeNetwork:completion:failure:

virtual void removeNetwork:completion:failure:(
  NLNetworkID networkId,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

rendezvousWithDeviceAccessToken:identifyDeviceCriteria:completion:failure:

virtual void rendezvousWithDeviceAccessToken:identifyDeviceCriteria:completion:failure:(
  NSString *accessToken,
  NLIdentifyDeviceCriteria *identifyDeviceCriteria,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

rendezvousWithDevicePairingCode:completion:failure:

virtual void rendezvousWithDevicePairingCode:completion:failure:(
  NSString *pairingCode,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

rendezvousWithDevicePairingCode:identifyDeviceCriteria:completion:failure:

virtual void rendezvousWithDevicePairingCode:identifyDeviceCriteria:completion:failure:(
  NSString *pairingCode,
  NLIdentifyDeviceCriteria *identifyDeviceCriteria,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

resetConfig:completion:failure:

virtual void resetConfig:completion:failure:(
  uint16_t resetFlags,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

scanNetworks:completion:failure:

virtual void scanNetworks:completion:failure:(
  NLNetworkType networkType,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

setAutoReconnect:

virtual WEAVE_ERROR setAutoReconnect:(
  BOOL autoReconnect
)

setRendezvousAddress:

virtual NSInteger setRendezvousAddress:(
  NSString *aRendezvousAddress
)

setRendezvousMode:completion:failure:

virtual void setRendezvousMode:completion:failure:(
  uint16_t rendezvousFlags,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

setWirelessRegulatoryConfig:completion:failure:

virtual void setWirelessRegulatoryConfig:completion:failure:(
  NLWirelessRegConfig *nlWirelessRegConfig,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

startDeviceEnumerationWithIdentifyDeviceCriteria:completion:failure:

virtual void startDeviceEnumerationWithIdentifyDeviceCriteria:completion:failure:(
  NLIdentifyDeviceCriteria *identifyDeviceCriteria,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

startSystemTest:testId:completion:failure:

virtual void startSystemTest:testId:completion:failure:(
  uint32_t profileId,
  uint32_t testId,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

statusReportToString:statusCode:

virtual NSString * statusReportToString:statusCode:(
  NSUInteger profileId,
  NSInteger statusCode
)

stopDeviceEnumeration

virtual void stopDeviceEnumeration()

testNetworkConnectivity:completion:failure:

virtual void testNetworkConnectivity:completion:failure:(
  NLNetworkID networkId,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

toErrorString:

virtual NSString * toErrorString:(
  WEAVE_ERROR err
)

unregisterService:completion:failure:

virtual void unregisterService:completion:failure:(
  uint64_t serviceId,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

updateNetwork:completion:failure:

virtual void updateNetwork:completion:failure:(
  NLNetworkInfo *netInfo,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)

updateService:completion:failure:

virtual void updateService:completion:failure:(
  NLServiceInfo *nlServiceInfo,
  WDMCompletionBlock completionBlock,
  WDMFailureBlock failureBlock
)