Partager via


hardware-definition

Important

Il s’agit de la documentation Azure Sphere (héritée). Azure Sphere (hérité) prend sa retraite le 27 septembre 2027 et les utilisateurs doivent migrer vers Azure Sphere (intégré) pour l’instant. Utilisez le sélecteur de version situé au-dessus du TOC pour afficher la documentation Azure Sphere (intégrée).

Gère les définitions matérielles pour les appareils Azure Sphere.

Operation Description
generate-header Génère un fichier d’en-tête C correspondant à une définition matérielle et le place dans le dossier inc/hw par rapport au JSON d’entrée.
test-header Teste que le fichier d’en-tête C dans le dossier inc/hw est à jour par rapport au JSON d’entrée.

generate-header

Génère un fichier d’en-tête C correspondant à une définition matérielle et le place dans le dossier inc/hw par rapport au JSON d’entrée.

Paramètres obligatoires

Paramètre Type Description
--hardware-definition-file Chemin d’accès Spécifie le nom et le chemin d’accès à un fichier JSON de définition matérielle. Vous pouvez fournir un chemin relatif ou absolu.
Paramètres globaux

Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :

Paramètre Description
--debug Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue.
-h, --help Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes.
--only-show-errors Affiche uniquement les erreurs, en supprimant les avertissements.
-o, --output Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere.
--query Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI.
--verbose Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets.

Remarque

Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.

Exemple

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

Teste que le fichier d’en-tête C dans le dossier inc/hw est à jour par rapport au JSON d’entrée.

Paramètres obligatoires

Paramètre Type Description
--hardware-definition-file Chemin d’accès Spécifie le nom et le chemin d’accès à un fichier JSON de définition matérielle. Le chemin d’accès au fichier peut être un chemin absolu ou relatif.
Paramètres globaux

Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :

Paramètre Description
--debug Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue.
-h, --help Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes.
--only-show-errors Affiche uniquement les erreurs, en supprimant les avertissements.
-o, --output Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere.
--query Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI.
--verbose Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets.

Remarque

Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.

Exemple

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