调用参数列表

在“控制器选择”对话框中设置缺省目标地址

使用以下命令将 控制器选择 对话框的目标 IP 地址值设置为指定值。另请参见参数 <TargetAddressURI> 的说明。

对于安全访问，可以使用额外的调用参数开关。

用法： 

ControllerAssistant -connect ip <TargetAddressURI>

示例： 

ControllerAssistant -connect ip 192.168.1.33
ControllerAssistant -connect ip etcp3://192.168.1.33
ControllerAssistant -connect ip etcp2://192.168.1.33
ControllerAssistant -connect ip "enodename3://MyController (192.168.1.33)"

设置文件对话框的缺省路径

使用以下命令将 打开和 保存对话框的缺省路径设置为指定值。

用法： 

ControllerAssistant -file <Path>

示例： 

ControllerAssistant -file C:\Temp\Default.bpd

从控制器加载映像

使用以下命令来启动指定控制器的备份以及将备份保存为映像。该备份的处理顺序会输入指定的日志文件。程序将在不使用图形用户界面的情况下运行。另请参见参数 <TargetAddressURI> 的说明。

对于安全访问，可以使用额外的调用参数开关。

要读取设备用户权限管理，您可以使用可选的命令行参数 -ReadOnlineUserRightsManagement <ignore|read>。要读取设备用户权限管理，还需要使用命令行参数 -UserRightsManagementPassword <MyUserRightsManagementPassword>。有关图形版本和详细说明，请参阅设备用户权限管理。

用法： 

ControllerAssistant [-username <UserName>] [-password <Password>] [-renewalpassword <RenewalPassword>] [-imagedirectory <ImageDirectoryPath>] -loadcontrol <TargetAddressURI> [-ReadOnlineUserRightsManagement <ignore|read> -UserRightsManagementPassword <MyUserRightsManagementPassword>] [<logfile>]

示例： 

ControllerAssistant 
-loadcontrol ip etcp3://190.201.100.100 C:\Temp\Logfile.log
ControllerAssistant 
-imagedirectory c:\Temp\MyImage 
-loadcontrol ip etcp3://190.201.100.100 C:\Temp\Logfile.log
ControllerAssistant -username MyUserName -password MyPassword -renewalpassword MyRenewalPassword -imagedirectory c:\Temp\MyImage -loadcontrol ip etcp4://190.201.100.100 -ReadOnlineUserRightsManagement read -UserRightsManagementPassword MyUserRightsManagementPassword C:\Temp\Logfile.log
注： 如果使用 GUI（图形用户界面）启动 Controller Assistant，还可以设置另外三个参数 - username、-password 和 -renewalpassword。在这种情况下，系统会提示您输入凭据。这些凭据来自参数值。
注： 要将活动映像保存到单个映像文件中（文件扩展名 *.bdp），还需要调用 -savefile。
注： 目标文件夹中的所有原有文件将被删除。
注意
数据丢失
执行命令前，确认命令行参数 -imagedirectory 提供的目录路径。
不遵循上述说明可能导致设备损坏。

将映像保存到控制器

使用以下命令将映像保存在指定控制器中。保存顺序会输入指定的日志文件。程序将在不使用图形用户界面的情况下运行。另请参见参数 <TargetAddressURI> 的说明。

对于安全访问，可以使用额外的调用参数开关。

要写入设备用户权限管理，可以使用可选的命令行参数 -WriteOnlineUserRightsManagement <keep|overwrite|restore>。要覆盖设备用户权限管理，还需要使用命令行参数 -UserRightsManagementPassword <MyUserRightsManagementPassword>。有关图形版本和详细说明，请参阅设备用户权限管理。

用法： 

ControllerAssistant [-username <UserName>] [-password <Password>] [-renewalpassword <RenewalPassword>] [-imagedirectory  <ImageDirectoryPath>] -savecontrol <TargetAddressURI> [-WriteOnlineUserRightsManagement <keep|overwrite|restore> -UserRightsManagementPassword <MyUserRightsManagementPassword>] [<logfile>]

示例： 

ControllerAssistant 
-savecontrol ip etcp3://190.201.100.100 C:\Temp\Logfile.log
ControllerAssistant -imagedirectory c:\Temp\MyImage 
-savecontrol ip etcp3://190.201.100.100 C:\Temp\Logfile.log
ControllerAssistant -username MyUserName -password MyPassword -renewalpassword MyRenewalPassword -imagedirectory c:\Temp\MyImage -savecontrol ip etcp4://190.201.100.100 -WriteOnlineUserRightsManagement overwrite -UserRightsManagementPassword MyUserRightsManagementPassword C:\Temp\Logfile.log
注： 如果使用 GUI（图形用户界面）启动 Controller Assistant，还可以设置另外三个参数 - username、-password 和 -renewalpassword。在这种情况下，系统会提示您输入凭据。这些凭据来自参数值。
注： 对于 -savecontrol 命令行参数，将在执行命令时覆盖控制器的文件系统，没有任何提示，然后控制器复位。
 警告
数据丢失和可能的意外设备操作
确认活动映像（连同其程序、配置和存储器）对应于机器或过程内的控制器功能。
未按说明操作可能导致人身伤亡或设备损坏等严重后果。

要从单个映像文件加载活动映像（文件扩展名 *.bdp），请先调用 -loadfile。

从映像文件加载映像

要作为映像来加载指定的 *.bpd 文件，请使用以下命令。加载顺序会输入指定的日志文件。程序将在不使用图形用户界面的情况下运行。

用法： 

ControllerAssistant [-imagedirectory <ImageDirectoryPath>]
-loadfile <ImageFilePath> [<logfile>]

示例： 

ControllerAssistant -loadfile C:\Temp\Default.bpd C:\Temp\Logfile.log
ControllerAssistant -imagedirectory c:\Temp\MyImage
-loadfile C:\Temp\Default.bpd C:\Temp\Logfile.log

将映像保存到映像文件

要以指定的 *.bpd 文件保存映像，请使用以下命令。保存顺序会输入指定的日志文件。程序将在不使用图形用户界面的情况下运行。

用法： 

ControllerAssistant [-imagedirectory <ImageDirectoryPath>]
-savefile <ImageFilePath> [<logfile>]

示例： 

ControllerAssistant -savefile C:\Temp\Default.bpd C:\Temp\Logfile.log
ControllerAssistant -imagedirectory c:\Temp\MyImage
-savefile C:\Temp\Default.bpd C:\Temp\Logfile.log

获取已安装固件的版本

使用以下命令可在结果路径中保存一个 XML 文件，其中包含在该 PC 上可以找到的给定控制器类型的固件版本列表。该结果提供可在图形用户界面内获得的相同信息。

设置开关 -ProductName 和 -ProductVersion 后，XML 文件仅包含给定产品名称和产品版本的结果。

用法： 

ControllerAssistant
-getinstalledfirmwareversionsXml <ControllerType> <ResultPath>  [-ProductName <ProductName>]
[-ProductVersion <ProductVersion>] [<logfile>]

示例： 

ControllerAssistant
-getinstalledfirmwareversionsXml LMC058 c:\Temp\MyVersions.xml
ControllerAssistant
-getinstalledfirmwareversionsXml M241 c:\Temp\MyVersions.xml -ProductName SoMachineSoftware -ProductVersion V4.3
ControllerAssistant
-getinstalledfirmwareversionsXml M262 c:\Temp\MyVersions.xml -ProductName EcoStruxureMachineExpert

获取控制器所有 Sercos 设备的固件版本

使用以下命令可在结果路径中保存一个 XML 文件，其中包含在该 PC 上可以找到的给定控制器类型的所有 Sercos 设备的固件版本列表。该结果提供可在图形用户界面内获得的相同信息。

用法： 

ControllerAssistant
- getinstalledsercosfirmwareversionsXml <ControllerType> <ResultPath>
[<logfile>]

示例： 

ControllerAssistant
- getinstalledsercosfirmwareversionsXml LMC600C c:\Temp\MyVersions.xml

创建新映像

经由命令行进行的调用通过给定控制器类型或系列以及给定版本创建映像。图形用户界面中也提供了相同的功能。

用法： 

ControllerAssistant -createimage <ControllerType> <FirmwareVersion> [<logfile path>] [imagepath=<image path>]

示例： 

ControllerAssistant -createimage LMC400C 1.50.1.3 c:\Temp\MyLogfile.log
注： 用于创建控制器固件的 XML 命令提供了其他功能。

更新活动映像的固件版本

经由命令行进行的调用可按照给定版本更新活动映像的固件。图形用户界面中也提供了相同的功能。控制器类型和固件版本由现有映像目录提供。如果检测到兼容版本，则会在不删除现有应用程序的情况下执行更新。

用法： 

ControllerAssistant [-imagedirectory <ImageDirectoryPath>]
-updateimage <FirmwareVersion> [<LogFile>]

示例： 

ControllerAssistant -updateimage 1.50.1.3 c:\Temp\MyLogfile.log
ControllerAssistant -imagedirectory c:\Temp\MyImage
-updateimage 1.50.1.3 c:\Temp\MyLogfile.log

更新通讯设置

经由命令行进行的调用可按照给定的通讯设置更新现有映像中控制器的通讯设置。图形用户界面中也提供了相同的功能。

用法： 

ControllerAssistant [-imagedirectory <ImageDirectoryPath>]
-updatecommunicationsettings <IPaddress>
<SubnetMask> <Gateway> <IPMode(fixed | bootp | dhcp)> <DeviceName>
[<logfile path>]

DeviceName 与 IPMode dhcp 配合使用。在某些控制器上，将忽略 IPMode 和 DeviceName。

示例： 

ControllerAssistant 
-updatecommunicationsettings 10.128.111.222 255.255.255.0 10.128.111.1 fixed "" c:\temp\version.log
ControllerAssistant -imagedirectory "c:\temp\MyImage"
-updatecommunicationsettings 10.128.111.222 255.255.255.0 10.128.111.1 dhcp "MyDeviceName" c:\temp\version.log

获取程序版本

使用以下命令来检索 Controller Assistant 应用程序的版本号。可选的日志文件 <LogFile> 用于记录结果和检测到的错误。另请参见可选值和缺省值的描述。

用法： 

ControllerAssistant -getProgramVersion [<logfile>]

示例： 

ControllerAssistant -getProgramVersion c:\temp\version.log

在闪存盘上创建包含特定数据的用户文件夹

使用以下命令向控制器映像中添加特定文件。

用法： 

ControllerAssistant [-imagedirectory <ImageDirectoryPath>]
-addCustomFiles <sourcePath> [<relativeDestinationPath>]
[logfile=<logfile>]

文件夹 SourcePath 包含复制到控制器映像的文件。此路径还可以包含子目录结构。RelativeDestinationPath 为可选，指定控制器映像内用于存储文件的子文件夹。子文件夹或子文件夹的结构与 imagepath 的根文件夹有关。

示例： 

ControllerAssistant -addCustomFiles "c:\temp\MyRecipes"
ControllerAssistant -imagedirectory "c:\Temp\MyImage"
-addCustomFiles "c:\temp\MyRecipes" "MyFiles\MyRecipes" logfile=c:\temp\MyLogfile.log

复制应用程序文件以及将应用程序添加到控制器的配置文件

使用以下命令向现有控制器映像中添加应用程序。例如，对于 LMC•0•C 控制器系列，*.app 以及对应的 *.crc 文件将复制到映像文件夹，并且会修改 *sysc3.cfg 文件的 CmpApp 一节。

注： 部分控制器类型不支持此命令。

用法： 

ControllerAssistant [-imagedirectory <ImageDirectoryPath>]
-addapplication <ApplicationPath> <ApplicationName>
[logfile=<logfile>]

示例： 

ControllerAssistant -imagedirectory c:\temp\MyImage
-addapplication c:\temp\MyApplicationFolderPath
MyApplicationName logfile=c:\temp\version.log

文件夹 ApplicationPath 包含 *.app 以及对应的 *.crc 文件。ApplicationName 是 *.app 文件的名称（不含扩展名的文件名）。

显示支持的命令

使用以下命令可在控制台上列出可能的命令及其参数。

用法： 

ControllerAssistant -help

示例： 

ControllerAssistant -help

建立静态远程连接

使用 CreateRemoteConnection 命令与通过 IP 地址和端口指定的控制器建立静态远程连接。

语法： 

-CreateRemoteConnection <ipAddressAndOptionalPort> [<RetryIfConnectionBreaks>]

参数

描述 

<ipAddressAndOptionalPort>

IP 地址和可选端口，使用 :（冒号）字符分隔。 

<RetryIfConnectionBreaks>

定义连接中断情况下的行为的可选参数：

  • 0（缺省值）

    连接中断时，不会尝试自动重连。

  • 1

    连接中断时，会尝试自动重连。重连尝试次数不受限制。

示例： 

ControllerAssistant -CreateRemoteConnection 192.168.2.50
ControllerAssistant -createremoteconnection 192.168.2.50:1105
ControllerAssistant -createRemoteConnection 192.168.2.50:1105 1

连接状态：

在执行了 CreateRemoteConnection 命令后，将显示 远程连接对话框：

  • 它提供与远程连接的状态有关的信息。

  • 您可以单击确定，终止连接。

  • 如果连接无法建立或已终止，则会进一步提供有关可能原因的信息。

  • 该信息会通知您已执行自动重连尝试，从而指示您是否激活了 <RetryIfConnectionBreaks> 参数。

应用示例：

您可以在例如 OPC 服务器应用程序中使用 CreateRemoteConnection 命令。如果 OPC 服务器安装在 PC 上并且要与驻留在另一子网中的控制器建立连接（远程连接），则这个命令非常有用。在这种情况下，应在启动服务器之前，利用此命令建立远程连接桥。然后可以通过本地网关扫描远程控制器。停止服务器之后，应终止连接。

停止指定控制器的应用程序

使用 StopAllApplications 命令停止指定控制器的应用程序。

对于安全访问，可以使用额外的调用参数开关。

用法： 

ControllerAssistant [-username <UserName>] [-password <Password>] [-renewalpassword <RenewalPassword>] -stopallapplications <TargetAddressURI> [<logfile>]

示例： 

ControllerAssistant -StopAllApplications etcp3://192.168.2.50
ControllerAssistant -StopAllApplications "enodename3://MyController (192.168.2.50)" "C:\Temp\Logfile.log"
ControllerAssistant -username MyUserName -password MyPassword -renewalpassword MyRenewalPassword -StopAllApplications "enodename3://MyController (192.168.2.50)" "C:\Temp\Logfile.log"
注： 如果使用 GUI（图形用户界面）启动 Controller Assistant，还可以设置另外三个参数 - username、-password 和 -renewalpassword。在这种情况下，系统会提示您输入凭据。这些凭据来自参数值。

CNC 文件的行为

CNC 文件存储在控制器内部存储器中的文件夹 <root>/MECNC 中。

可以通过固件创建或更新过程，使用 cncsettings 调用参数开关设置 CNC 文件的行为。

  • dontcreate （缺省设置）：通过固件创建或更新过程删除文件夹 <root>/MECNC 中的文件。

  • path <PathToZippedFile>：ZIP 文件（包括子文件夹）中的文件将复制到文件夹 <root>/MECNC 中。

  • preserve：通过固件创建或更新过程保留文件夹 <root>/MECNC 中的文件。

注： CNC 许可证存储在文件夹 <root>/MECNC/License 中，且不会被固件创建或更新过程修改。

用法： 

ControllerAssistant -cncsettings [dontcreate|path <PathToZippedFile>|preserve]

示例： 

ControllerAssistant -cncsettings path C:\Temp\CNCfilesUpdate.zip

设备标识

请参见网络设备标识调用参数，了解 Network Device Identification 专用的其他命令行调用。

XML 命令

请参见 XML 命令，了解在 XML 格式文件中定义的其他命令。