iOS-App-Entwickler können die Home APIs verwenden, um einen Thread-Border-Router zu verwalten.
Das GoogleBorderRouterDevice wird mit zwei primären Geräte-Traits implementiert:
ThreadNetworkCapabilitiesTrait,
das schreibgeschützte Attribute zur Überprüfung von Border-Router-Funktionen bietet, und
ThreadNetworkManagementTrait,
das Befehle für den Netzwerklebenszyklus und die Freigabe von Anmeldedaten verarbeitet
mithilfe eines temporären vorinstallierten Schlüssels für den Commissioner (Ephemeral Pre-Shared Key for the Commissioner, ePSKc). Internet-Zugriffsrichtlinien auf Strukturebene
werden mit dem
ThreadNetworkSettingsTrait
Trait verwaltet.
Prüfen Sie immer, ob ein Gerät Attribute und Befehle unterstützt, bevor Sie Funktionen verwenden oder versuchen, Attribute zu aktualisieren. Weitere Informationen finden Sie unter Geräte auf iOS steuern.
| Gerätetyp der Home APIs | Traits | Swift-Beispiel-App | Anwendungsfall |
|---|---|---|---|
|
Border-Router
|
Erforderliche Traits google ThreadNetworkCapabilitiesTrait google ThreadNetworkManagementTrait |
Border-Router |
Grundlegende Informationen zu einem Gerät abrufen
Das BasicInformation
Trait enthält Informationen wie den Namen des Anbieters, die Anbieter-ID, die Produkt-ID,
den Produktnamen (einschließlich Modellinformationen) und die Softwareversion für ein Gerät:
let vendorName = basicInfoTrait.attributes.vendorName! let vendorID = basicInfoTrait.attributes.vendorID! let productID = basicInfoTrait.attributes.productID! let productName = basicInfoTrait.attributes.productName! let softwareVersion = basicInfoTrait.attributes.softwareVersion!
Funktionen des Border-Routers prüfen
Mit dem Trait ThreadNetworkCapabilitiesTrait können Sie die schreibgeschützten Funktionen eines Border-Routers prüfen, z. B. die ePSKc-Unterstützung und die Konfiguration der Einstellung für den Internetzugriff.
func checkBorderRouterCapabilities(device: HomeDevice) async {
// Filter for GoogleBorderRouterDevice device type
guard let gtbrDevice = device.type(Google.GoogleBorderRouterDevice.self) else {
print("Device is not a Google border router.")
return
}
// Retrieve the ThreadNetworkCapabilitiesTrait
guard let capabilitiesTrait = gtbrDevice.traits(Google.ThreadNetworkCapabilitiesTrait.self) else {
print("ThreadNetworkCapabilitiesTrait not found on device.")
return
}
do {
let isEpskcSupported = try await capabilitiesTrait.epskcSupported.read()
let internetAccessOption = try await capabilitiesTrait.internetAccessOption.read()
let isIasSupported = internetAccessOption != .none
print("ePSKc Supported: \(isEpskcSupported)")
print("Internet Access Setting Supported: \(isIasSupported)")
} catch {
print("Failed to read capabilities: \(error)")
}
}
Freigabe von Thread-Anmeldedaten verwalten (ePSKc)
Die Freigabe von Thread-Anmeldedaten erfolgt mithilfe eines temporären vorinstallierten Schlüssels für den Commissioner (ePSKc). Im ePSKc-Modus wird ein temporärer, sicherer Passkey generiert, mit dem externe Geräte oder Commissioners das Thread-Netzwerk-Dataset sicher abrufen können.
ePSKc-Modus aktivieren
func startEpskcSession(device: HomeDevice, durationSeconds: Int16) async -> Google.ThreadNetworkManagementTrait.ActivateEpskcModeResponse? {
guard let gtbrDevice = device.type(Google.GoogleBorderRouterDevice.self),
let mgmtTrait = gtbrDevice.traits(Google.ThreadNetworkManagementTrait.self) else {
print("ThreadNetworkManagementTrait not found.")
return nil
}
do {
var request = Google.ThreadNetworkManagementTrait.ActivateEpskcModeRequest()
request.requestedDurationSeconds = durationSeconds
let response = try await mgmtTrait.activateEpskcMode(request)
print("ePSKc Session Activated!")
print("Status: \(response.status)")
print("Ephemeral PSKc: \(response.epskc)")
print("Valid Duration (s): \(response.validDurationSeconds)")
return response
} catch {
print("Failed to activate ePSKc mode: \(error)")
return nil
}
}
ePSKc-Modus deaktivieren
func stopEpskcSession(device: HomeDevice) async {
guard let gtbrDevice = device.type(Google.GoogleBorderRouterDevice.self),
let mgmtTrait = gtbrDevice.traits(Google.ThreadNetworkManagementTrait.self) else {
return
}
do {
try await mgmtTrait.deactivateEpskcMode(Google.ThreadNetworkManagementTrait.DeactivateEpskcModeRequest())
print("ePSKc mode deactivated.")
} catch {
print("Failed to deactivate ePSKc mode: \(error)")
}
}
Ereignisse zur Deaktivierung von ePSKc beobachten
Thread-Border-Router senden Ereignisse aus, wenn eine ePSKc-Sitzung beendet wird, z. B. weil der Schlüssel verwendet wurde, die Sitzung abgelaufen ist oder sie manuell beendet wurde.
func observeEpskcEvents(device: HomeDevice) async {
guard let gtbrDevice = device.type(Google.GoogleBorderRouterDevice.self),
let mgmtTrait = gtbrDevice.traits(Google.ThreadNetworkManagementTrait.self) else {
return
}
do {
for try await event in mgmtTrait.epskcModeDeactivatedEvent.stream() {
print("ePSKc Session Ended. Reason: \(event.reason)")
switch event.reason {
case .keyUsed:
print("Key was successfully used to commission a device.")
case .expired:
print("Session timed out before the key was used.")
case .cancelled:
print("Session was manually cancelled.")
@unknown default:
print("Unknown deactivation reason.")
}
}
} catch {
print("Error streaming ePSKc events: \(error)")
}
}
Thread-Netzwerkmitgliedschaft verwalten
Sie können einen Thread-Border-Router anweisen, einem neuen Thread-Netzwerk beizutreten, indem Sie die aktiven Operational Dataset TLVs angeben, oder ihn anweisen, das aktuelle Netzwerk zu verlassen.
func joinNetwork(device: HomeDevice, datasetTlvs: Data) async {
guard let gtbrDevice = device.type(Google.GoogleBorderRouterDevice.self),
let mgmtTrait = gtbrDevice.traits(Google.ThreadNetworkManagementTrait.self) else {
return
}
do {
var request = Google.ThreadNetworkManagementTrait.JoinNetworkRequest()
request.operationalDatasetTlvs = datasetTlvs
let response = try await mgmtTrait.joinNetwork(request)
print("Join network command sent. Status: \(response.status)")
} catch {
print("Join network failed: \(error)")
}
}
func leaveNetwork(device: HomeDevice) async {
guard let gtbrDevice = device.type(Google.GoogleBorderRouterDevice.self),
let mgmtTrait = gtbrDevice.traits(Google.ThreadNetworkManagementTrait.self) else {
return
}
do {
try await mgmtTrait.leaveNetwork(Google.ThreadNetworkManagementTrait.LeaveNetworkRequest())
print("Leave network command sent successfully.")
} catch {
print("Leave network failed: \(error)")
}
}
Internetzugriff auf Strukturebene konfigurieren
Das Trait ThreadNetworkSettings ist ein aktualisierbares Trait, das an eine Structure angehängt ist (die ein Zuhause oder ein Gebäude darstellt). So können Entwickler die strukturweite Internet-Zugriffsrichtlinie für Thread-Border-Router konfigurieren.
func updateStructureInternetAccess(structure: Structure, enableInternetAccess: Bool) async {
guard let settingsTrait = structure.traits(Google.ThreadNetworkSettingsTrait.self) else {
print("ThreadNetworkSettingsTrait not found on structure.")
return
}
let option: Google.ThreadNetworkSettingsTrait.InternetAccessOption = enableInternetAccess ? .internetAccessOptionAll : .internetAccessOptionNone
do {
try await settingsTrait.update { mutator in
mutator.internetAccessOption = option
}
print("Successfully updated Thread internet access policy.")
} catch {
print("Failed to update Thread internet access policy: \(error)")
}
}