get-supported-device-properties command - Manual - Hardware Compiler - The AX Hardware Compiler - Hardware Compiler (hwc),tool

Hardware Compiler CLI Tool (hwc)

Portfolio
SIMATIC AX
Product
Hardware Compiler
Software version
1.1.154
Edition
07/2024
Language
English (original)
Package Name
@ax/hwc
apax hwc get-supported-device-properties {-o <OrderNumber> -v <Version> | -f <GsdFileName> -g <GsdId>} [-p <ProjectDirectory>]

Gets all supported properties with default values for a given hardware device. Supports queries for a single device either with Order Number and Firmware Version or Gsd Filename and Gsd Id. The path to an apax project directory can be added to also include installed GSD files in the output. If no projectDirectory parameter is given, it will search in the current execution directory for a project directory.

Options

compile Parameters
-o, --orderNumber Order number of device or module.
-v, --version Firmware version of device or module.
-f, --fileName File name of the imported GSD containing the device or module.
-g, --gsdID GSD ID of the device or module.
-p, --projectDirectory Project reference path to consider imported GSDs.

Return codes

The following return codes are possible:

  • 0 - Properties of Device were queried successfully.
  • ≠0 - An error occurred while querying properties.