nl::Weave::DeviceManager::WeaveDeviceManager

總結

繼承

沿用來源： nl::Weave::Profiles::Security::CASE::WeaveCASEAuthDelegate

建構函式和解構程式
WeaveDeviceManager()

公開類型
@366 列舉

公開屬性
AddNetwork
AddNetworkCompleteFunct
AppState
void *
DeviceEnumeration
DeviceEnumerationResponseFunct
General
CompleteFunct
GetCameraAuthData
GetCameraAuthDataCompleteFunct
GetFabricConfig
GetFabricConfigCompleteFunct
GetNetworks
GetNetworksCompleteFunct
GetRendezvousMode
GetRendezvousModeCompleteFunct
GetWirelessRegulatoryConfig
GetWirelessRegulatoryConfigCompleteFunct
IdentifyDevice
IdentifyDeviceCompleteFunct
PairToken
PairTokenCompleteFunct
ScanNetworks
NetworkScanCompleteFunct
State
enum nl::Weave::DeviceManager::WeaveDeviceManager::@366
UnpairToken
UnpairTokenCompleteFunct

公開函式
AddNetwork(const NetworkInfo *netInfo, void *appReqState, AddNetworkCompleteFunct onComplete, ErrorFunct onError)
ArmFailSafe(uint8_t armMode, uint32_t failSafeToken, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
Close()
void
Close(bool graceful)
void
CloseDeviceConnection()
void
CloseDeviceConnection(bool graceful)
void
ConfigureBinding(Binding *const apBinding)
ConnectDevice(uint64_t deviceId, IPAddress deviceAddr, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
ConnectDevice(uint64_t deviceId, IPAddress deviceAddr, const char *pairingCode, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
ConnectDevice(uint64_t deviceId, IPAddress deviceAddr, const uint8_t *accessToken, uint32_t accessTokenLen, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
CreateFabric(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
DisableConnectionMonitor(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
DisableNetwork(uint32_t networkId, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
DisarmFailSafe(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
EnableConnectionMonitor(uint16_t interval, uint16_t timeout, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
EnableNetwork(uint32_t networkId, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
GetCameraAuthData(const char *nonce, void *appReqState, GetCameraAuthDataCompleteFunct onComplete, ErrorFunct onError)
GetDeviceAddress(IPAddress & deviceAddr)
GetDeviceId(uint64_t & deviceId)
GetFabricConfig(void *appReqState, GetFabricConfigCompleteFunct onComplete, ErrorFunct onError)
GetLastNetworkProvisioningResult(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
GetNetworks(uint8_t flags, void *appReqState, GetNetworksCompleteFunct onComplete, ErrorFunct onError)
GetRendezvousMode(void *appReqState, GetRendezvousModeCompleteFunct onComplete, ErrorFunct onError)
GetWirelessRegulatoryConfig(void *appReqState, GetWirelessRegulatoryConfigCompleteFunct onComplete, ErrorFunct onError)
IdentifyDevice(void *appReqState, IdentifyDeviceCompleteFunct onComplete, ErrorFunct onError)
Init(WeaveExchangeManager *exchangeMsg, WeaveSecurityManager *securityMgr)
IsConnected() const
bool
JoinExistingFabric(const uint8_t *fabricConfig, uint32_t fabricConfigLen, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
LeaveFabric(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
PairToken(const uint8_t *pairingToken, uint32_t pairingTokenLen, void *appReqState, PairTokenCompleteFunct onComplete, ErrorFunct onError)
PassiveRendezvousDevice(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
PassiveRendezvousDevice(const char *pairingCode, void *appReqState, CompleteFunct onComplete, ErrorFunct onError, StartFunct onStart)
PassiveRendezvousDevice(const uint8_t *accessToken, uint32_t accessTokenLen, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
Ping(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
Ping(void *appReqState, int32_t payloadSize, CompleteFunct onComplete, ErrorFunct onError)
ReconnectDevice(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RegisterServicePairAccount(uint64_t serviceId, const char *accountId, const uint8_t *serviceConfig, uint16_t serviceConfigLen, const uint8_t *pairingToken, uint16_t pairingTokenLen, const uint8_t *pairingInitData, uint16_t pairingInitDataLen, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RemotePassiveRendezvous(const IPAddress rendezvousDeviceAddr, const uint8_t *accessToken, uint32_t accessTokenLen, const uint16_t rendezvousTimeoutSec, const uint16_t inactivityTimeoutSec, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RemotePassiveRendezvous(const IPAddress rendezvousDeviceAddr, const char *pairingCode, const uint16_t rendezvousTimeoutSec, const uint16_t inactivityTimeoutSec, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RemotePassiveRendezvous(const IPAddress rendezvousDeviceAddr, const uint16_t rendezvousTimeoutSec, const uint16_t inactivityTimeoutSec, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RemoveNetwork(uint32_t networkId, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RendezvousDevice(const IdentifyDeviceCriteria & deviceCriteria, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RendezvousDevice(const char *pairingCode, const IdentifyDeviceCriteria & deviceCriteria, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RendezvousDevice(const uint8_t *accessToken, uint32_t accessTokenLen, const IdentifyDeviceCriteria & deviceCriteria, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
RendezvousDevice(const char *pairingCode, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
ResetConfig(uint16_t resetFlags, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
ScanNetworks(NetworkType networkType, void *appReqState, NetworkScanCompleteFunct onComplete, ErrorFunct onError)
SetAutoReconnect(bool autoReconnect)
SetConnectTimeout(uint32_t timeoutMS)
SetConnectionClosedCallback(ConnectionClosedFunc onConnecionClosedFunc, void *onConnecionClosedAppReq)
void
SetRendezvousAddress(IPAddress addr)
SetRendezvousAddress(IPAddress addr, InterfaceId rendezvousIntf)
SetRendezvousLinkLocal(bool RendezvousLinkLocal)
SetRendezvousMode(uint16_t modeFlags, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
SetUseAccessToken(bool useAccessToken)
SetWiFiRendezvousAddress(IPAddress addr)
SetWirelessRegulatoryConfig(const WirelessRegConfig *regConfig, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
Shutdown()
StartDeviceEnumeration(void *appReqState, const IdentifyDeviceCriteria & deviceCriteria, DeviceEnumerationResponseFunct onResponse, ErrorFunct onError)
StartSystemTest(void *appReqState, uint32_t profileId, uint32_t testId, CompleteFunct onComplete, ErrorFunct onError)
StopDeviceEnumeration()
void
StopSystemTest(void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
TestNetworkConnectivity(uint32_t networkId, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
UnpairToken(void *appReqState, UnpairTokenCompleteFunct onComplete, ErrorFunct onError)
UnregisterService(uint64_t serviceId, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
UpdateNetwork(const NetworkInfo *netInfo, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)
UpdateService(uint64_t serviceId, const uint8_t *serviceConfig, uint16_t serviceConfigLen, void *appReqState, CompleteFunct onComplete, ErrorFunct onError)

公開的靜態函式
AddNodeToList(uint64_t nodeId, uint64_t *& list, uint32_t & listLen, uint32_t & listMaxLen, uint32_t initialMaxLen)
IsNodeInList(uint64_t nodeId, uint64_t *list, uint32_t listLen)
bool
IsValidPairingCode(const char *pairingCode)
bool

公開類型

@366

 @366

公開屬性

新增網路

AddNetworkCompleteFunct AddNetwork

應用程式狀態

void * AppState

裝置設備數

DeviceEnumerationResponseFunct DeviceEnumeration

一般

CompleteFunct General

取得相機驗證資料

GetCameraAuthDataCompleteFunct GetCameraAuthData

GetFabricConfig

GetFabricConfigCompleteFunct GetFabricConfig

取得網路

GetNetworksCompleteFunct GetNetworks

GetRendezvousMode

GetRendezvousModeCompleteFunct GetRendezvousMode

取得 WirelessRegulatoryConfig

GetWirelessRegulatoryConfigCompleteFunct GetWirelessRegulatoryConfig

識別裝置

IdentifyDeviceCompleteFunct IdentifyDevice

配對憑證

PairTokenCompleteFunct PairToken

掃描網路

NetworkScanCompleteFunct ScanNetworks

狀態

enum nl::Weave::DeviceManager::WeaveDeviceManager::@366 State

解除配對憑證

UnpairTokenCompleteFunct UnpairToken

公開函式

新增網路

WEAVE_ERROR AddNetwork(
  const NetworkInfo *netInfo,
  void *appReqState,
  AddNetworkCompleteFunct onComplete,
  ErrorFunct onError
)

ArmFailSafe

WEAVE_ERROR ArmFailSafe(
  uint8_t armMode,
  uint32_t failSafeToken,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

關閉

void Close()

關閉

void Close(
  bool graceful
)

關閉裝置連線

void CloseDeviceConnection()

關閉裝置連線

void CloseDeviceConnection(
  bool graceful
)

設定繫結

WEAVE_ERROR ConfigureBinding(
  Binding *const apBinding
)

連結裝置

WEAVE_ERROR ConnectDevice(
  uint64_t deviceId,
  IPAddress deviceAddr,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

連結裝置

WEAVE_ERROR ConnectDevice(
  uint64_t deviceId,
  IPAddress deviceAddr,
  const char *pairingCode,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

連結裝置

WEAVE_ERROR ConnectDevice(
  uint64_t deviceId,
  IPAddress deviceAddr,
  const uint8_t *accessToken,
  uint32_t accessTokenLen,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

CreateFabric

WEAVE_ERROR CreateFabric(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

停用連線監控

WEAVE_ERROR DisableConnectionMonitor(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

停用網路

WEAVE_ERROR DisableNetwork(
  uint32_t networkId,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

DisarmFailSafe

WEAVE_ERROR DisarmFailSafe(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

啟用連線監控

WEAVE_ERROR EnableConnectionMonitor(
  uint16_t interval,
  uint16_t timeout,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

啟用網路

WEAVE_ERROR EnableNetwork(
  uint32_t networkId,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

取得相機驗證資料

WEAVE_ERROR GetCameraAuthData(
  const char *nonce,
  void *appReqState,
  GetCameraAuthDataCompleteFunct onComplete,
  ErrorFunct onError
)

取得裝置位址

WEAVE_ERROR GetDeviceAddress(
  IPAddress & deviceAddr
)

取得裝置 ID

WEAVE_ERROR GetDeviceId(
  uint64_t & deviceId
)

GetFabricConfig

WEAVE_ERROR GetFabricConfig(
  void *appReqState,
  GetFabricConfigCompleteFunct onComplete,
  ErrorFunct onError
)

取得最終網路佈建結果

WEAVE_ERROR GetLastNetworkProvisioningResult(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

取得網路

WEAVE_ERROR GetNetworks(
  uint8_t flags,
  void *appReqState,
  GetNetworksCompleteFunct onComplete,
  ErrorFunct onError
)

GetRendezvousMode

WEAVE_ERROR GetRendezvousMode(
  void *appReqState,
  GetRendezvousModeCompleteFunct onComplete,
  ErrorFunct onError
)

取得 WirelessRegulatoryConfig

WEAVE_ERROR GetWirelessRegulatoryConfig(
  void *appReqState,
  GetWirelessRegulatoryConfigCompleteFunct onComplete,
  ErrorFunct onError
)

識別裝置

WEAVE_ERROR IdentifyDevice(
  void *appReqState,
  IdentifyDeviceCompleteFunct onComplete,
  ErrorFunct onError
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMsg,
  WeaveSecurityManager *securityMgr
)

已連線

bool IsConnected() const

加入現有組合

WEAVE_ERROR JoinExistingFabric(
  const uint8_t *fabricConfig,
  uint32_t fabricConfigLen,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

退出頻道

WEAVE_ERROR LeaveFabric(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

配對憑證

WEAVE_ERROR PairToken(
  const uint8_t *pairingToken,
  uint32_t pairingTokenLen,
  void *appReqState,
  PairTokenCompleteFunct onComplete,
  ErrorFunct onError
)

PassiveRendezvousDevice

WEAVE_ERROR PassiveRendezvousDevice(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

PassiveRendezvousDevice

WEAVE_ERROR PassiveRendezvousDevice(
  const char *pairingCode,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError,
  StartFunct onStart
)

PassiveRendezvousDevice

WEAVE_ERROR PassiveRendezvousDevice(
  const uint8_t *accessToken,
  uint32_t accessTokenLen,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

乒乓

WEAVE_ERROR Ping(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

乒乓

WEAVE_ERROR Ping(
  void *appReqState,
  int32_t payloadSize,
  CompleteFunct onComplete,
  ErrorFunct onError
)

重新連線裝置

WEAVE_ERROR ReconnectDevice(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

註冊服務配對帳戶

WEAVE_ERROR RegisterServicePairAccount(
  uint64_t serviceId,
  const char *accountId,
  const uint8_t *serviceConfig,
  uint16_t serviceConfigLen,
  const uint8_t *pairingToken,
  uint16_t pairingTokenLen,
  const uint8_t *pairingInitData,
  uint16_t pairingInitDataLen,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

遠端傳遞

WEAVE_ERROR RemotePassiveRendezvous(
  const IPAddress rendezvousDeviceAddr,
  const uint8_t *accessToken,
  uint32_t accessTokenLen,
  const uint16_t rendezvousTimeoutSec,
  const uint16_t inactivityTimeoutSec,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

遠端傳遞

WEAVE_ERROR RemotePassiveRendezvous(
  const IPAddress rendezvousDeviceAddr,
  const char *pairingCode,
  const uint16_t rendezvousTimeoutSec,
  const uint16_t inactivityTimeoutSec,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

遠端傳遞

WEAVE_ERROR RemotePassiveRendezvous(
  const IPAddress rendezvousDeviceAddr,
  const uint16_t rendezvousTimeoutSec,
  const uint16_t inactivityTimeoutSec,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

移除網路

WEAVE_ERROR RemoveNetwork(
  uint32_t networkId,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

蘭迪斯沃斯 (RendezvousDevice)

WEAVE_ERROR RendezvousDevice(
  const IdentifyDeviceCriteria & deviceCriteria,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

蘭迪斯沃斯 (RendezvousDevice)

WEAVE_ERROR RendezvousDevice(
  const char *pairingCode,
  const IdentifyDeviceCriteria & deviceCriteria,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

蘭迪斯沃斯 (RendezvousDevice)

WEAVE_ERROR RendezvousDevice(
  const uint8_t *accessToken,
  uint32_t accessTokenLen,
  const IdentifyDeviceCriteria & deviceCriteria,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

蘭迪斯沃斯 (RendezvousDevice)

WEAVE_ERROR RendezvousDevice(
  const char *pairingCode,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

重設設定

WEAVE_ERROR ResetConfig(
  uint16_t resetFlags,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

掃描網路

WEAVE_ERROR ScanNetworks(
  NetworkType networkType,
  void *appReqState,
  NetworkScanCompleteFunct onComplete,
  ErrorFunct onError
)

設定自動重新連線

WEAVE_ERROR SetAutoReconnect(
  bool autoReconnect
)

SetConnectTimeout

WEAVE_ERROR SetConnectTimeout(
  uint32_t timeoutMS
)

SetConnectionClosedCallback

void SetConnectionClosedCallback(
  ConnectionClosedFunc onConnecionClosedFunc,
  void *onConnecionClosedAppReq
)

SetRendezvousAddress

WEAVE_ERROR SetRendezvousAddress(
  IPAddress addr
)

SetRendezvousAddress

WEAVE_ERROR SetRendezvousAddress(
  IPAddress addr,
  InterfaceId rendezvousIntf
)

SetRendezvousLinkLocal

WEAVE_ERROR SetRendezvousLinkLocal(
  bool RendezvousLinkLocal
)

SetRendezvousMode

WEAVE_ERROR SetRendezvousMode(
  uint16_t modeFlags,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

SetUseAccessToken

WEAVE_ERROR SetUseAccessToken(
  bool useAccessToken
)

設定 WiFiRendezvousAddress

WEAVE_ERROR SetWiFiRendezvousAddress(
  IPAddress addr
)

SetWirelessRegulatoryConfig

WEAVE_ERROR SetWirelessRegulatoryConfig(
  const WirelessRegConfig *regConfig,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

停用

WEAVE_ERROR Shutdown()

啟動裝置裝置數

WEAVE_ERROR StartDeviceEnumeration(
  void *appReqState,
  const IdentifyDeviceCriteria & deviceCriteria,
  DeviceEnumerationResponseFunct onResponse,
  ErrorFunct onError
)

開始系統測試

WEAVE_ERROR StartSystemTest(
  void *appReqState,
  uint32_t profileId,
  uint32_t testId,
  CompleteFunct onComplete,
  ErrorFunct onError
)

StopDeviceEnumeration

void StopDeviceEnumeration()

停止系統測試

WEAVE_ERROR StopSystemTest(
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

測試網路連線

WEAVE_ERROR TestNetworkConnectivity(
  uint32_t networkId,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

解除配對憑證

WEAVE_ERROR UnpairToken(
  void *appReqState,
  UnpairTokenCompleteFunct onComplete,
  ErrorFunct onError
)

取消註冊註冊服務

WEAVE_ERROR UnregisterService(
  uint64_t serviceId,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

更新網路

WEAVE_ERROR UpdateNetwork(
  const NetworkInfo *netInfo,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

UpdateService

WEAVE_ERROR UpdateService(
  uint64_t serviceId,
  const uint8_t *serviceConfig,
  uint16_t serviceConfigLen,
  void *appReqState,
  CompleteFunct onComplete,
  ErrorFunct onError
)

WeaveDeviceManager

 WeaveDeviceManager()

公開的靜態函式

新增 NodeToList

WEAVE_ERROR AddNodeToList(
  uint64_t nodeId,
  uint64_t *& list,
  uint32_t & listLen,
  uint32_t & listMaxLen,
  uint32_t initialMaxLen
)

IsNodeInList

bool IsNodeInList(
  uint64_t nodeId,
  uint64_t *list,
  uint32_t listLen
)

是有效的配對碼

bool IsValidPairingCode(
  const char *pairingCode
)