setup-secure-communication 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 setup-secure-communication --name <PLC_NAME> --input <HARDWARE_DECLARATION> --password <PASSWORD>
  • Generates the security configuration file named "PLCName".SecurityConfiguration.json inside the same folder where hardware declaration exists.
    • The security configuration file contains key-value pairs, where keys are human-readable strings and values are machine-readable byte arrays.
    • The security configuration file is used to enable secure communication between AX and the configured PLC.
    • The security configuration file is a mandatory input file for a successful compile of S7-1500 PLCs, therefore setup-secure-communication command must be run at least once prior to execution of hwc compile command for S7-1500 PLCs. Security configuration file must be checked into source control (along with hardware declaration) and must not be edited manually.

Options

Option Description
-i, --input Path to directory or file of the textual hardware declaration for compile. Mandatory.
This parameter can be specified multiple times.
-n, --name Unique name of a PLC, which must already be existing in the hardware declaration. Mandatory
-p, --password PLC master password for encryption. You will be prompted for a password if option is not set.

Return codes

The following return codes are possible:

  • 0 - Security configuration file was created successfully.
  • ≠0 - An error occurred during creation of security data.