hardware-definition
Wichtig
Dies ist die Dokumentation zu Azure Sphere (Legacy). Azure Sphere (Legacy) wird am 27. September 2027 eingestellt, und Benutzer müssen bis zu diesem Zeitpunkt zu Azure Sphere (integriert) migrieren. Verwenden Sie die Versionsauswahl oberhalb des Inhaltsverzeichniss, um die Dokumentation zu Azure Sphere (Integriert) anzuzeigen.
Dient zum Verwalten von Hardwaredefinitionen für Azure Sphere-Geräte.
| Vorgang | Beschreibung |
|---|---|
| generate-header | Generiert eine C-Headerdatei, die einer Hardwaredefinition entspricht, und platziert sie im Ordner "inc/hw" relativ zum Eingabe-JSON. |
| test-header | Testet, dass die C-Headerdatei im Ordner "inc/hw" im Hinblick auf die Eingabe-JSON auf dem neuesten Stand ist. |
generate-header
Generiert eine C-Headerdatei, die einer Hardwaredefinition entspricht, und platziert sie im Ordner "inc/hw" relativ zum Eingabe-JSON.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| --hardware-definition-file | Pfad | Gibt den Namen und Pfad zu einer JSON-Datei der Hardwaredefinition an. Sie können einen relativen oder absoluten Pfad angeben. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere hardware-definition generate-header --hardware-definition-file C:\AppSamples\HardwareDefinitions\seeed_mt3620_mdb\sample_appliance.json
Generated header file at C:/AppSamples/HardwareDefinitions/seeed_mt3620_mdb/inc/hw/sample_appliance.h based on hardware definition at C:\AppSamples\HardwareDefinitions\seeed_mt3620_mdb\sample_appliance.json
test-header
Testet, dass die C-Headerdatei im Ordner "inc/hw" im Hinblick auf die Eingabe-JSON auf dem neuesten Stand ist.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| --hardware-definition-file | Pfad | Gibt den Namen und Pfad zu einer JSON-Datei der Hardwaredefinition an. Der Dateipfad kann ein absoluter oder relativer Pfad sein. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere hardware-definition test-header --hardware-definition-file "C:\Program Files (x86)\Microsoft Azure Sphere SDK\HardwareDefinitions\mt3620.json"
Hardware definition at C:\Program Files (x86)\Microsoft Azure Sphere SDK\HardwareDefinitions\mt3620.json is consistent with header at C:/Program Files (x86)/Microsoft Azure Sphere SDK/HardwareDefinitions/inc/hw/mt3620.h