hardware-definition
Importante
Esta es la documentación de Azure Sphere (heredado). Azure Sphere (heredado) se retira el 27 de septiembre de 2027 y los usuarios deben migrar a Azure Sphere (integrado) en este momento. Use el selector de versiones situado encima de la TOC para ver la documentación de Azure Sphere (integrado).
Administra las definiciones de hardware para dispositivos de Azure Sphere.
| Operación | Descripción |
|---|---|
| generate-header | Genera un archivo de encabezado C correspondiente a una definición de hardware y lo coloca en la carpeta inc/hw en relación con el JSON de entrada. |
| test-header | Comprueba que el archivo de encabezado C de la carpeta inc/hw esté actualizado con respecto al JSON de entrada. |
generate-header
Genera un archivo de encabezado C correspondiente a una definición de hardware y lo coloca en la carpeta inc/hw en relación con el JSON de entrada.
Parámetros obligatorios
| Parámetro | Tipo | Descripción |
|---|---|---|
| --hardware-definition-file | Path | Especifica el nombre y la ruta de acceso a un archivo JSON de definición de hardware. Puede proporcionar una ruta de acceso relativa o absoluta. |
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
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
Comprueba que el archivo de encabezado C de la carpeta inc/hw esté actualizado con respecto al JSON de entrada.
Parámetros obligatorios
| Parámetro | Tipo | Descripción |
|---|---|---|
| --hardware-definition-file | Path | Especifica el nombre y la ruta de acceso a un archivo JSON de definición de hardware. La ruta de acceso del archivo puede ser una ruta de acceso absoluta o relativa. |
Parámetros globales
Los siguientes parámetros globales están disponibles para la CLI de Azure Sphere:
| Parámetro | Descripción |
|---|---|
| --debug | Aumenta el nivel de detalle del registro para mostrar todos los registros de depuración. Si encuentra un error, proporcione la salida que se genera con la marca --debug activada al enviar un informe de errores. |
| -h, --help | Imprime información de referencia de la CLI sobre los comandos y sus argumentos y enumera los subgrupos y comandos disponibles. |
| --only-show-errors | Muestra solo errores, supresión de advertencias. |
| -o, --output | Cambia el formato de salida. Los formatos de salida disponibles son json, jsonc (JSON coloreado), tsv (valores separados por tabulaciones), tabla (tablas ASCII legibles) y yaml. De forma predeterminada, la CLI genera table. Para más información sobre los formatos de salida disponibles, consulte Formato de salida para comandos de la CLI de Azure Sphere. |
| --query | Usa el lenguaje de consulta JMESPath para filtrar la salida devuelta desde Servicios de seguridad de Azure Sphere. Consulte el tutorial de JMESPath y consulta la salida del comando de la CLI de Azure para obtener más información y ejemplos. |
| --verbose | Imprime información sobre los recursos creados en Azure Sphere durante una operación y otra información útil. Use --debug para los registros de depuración completos. |
Nota:
Si usa la CLI clásica de Azure Sphere, consulte Parámetros globales para más información sobre las opciones disponibles.
Ejemplo
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