Liste de paramètres d'appel

Définition de l'adresse cible par défaut dans la boîte de dialogue de sélection du contrôleur

Utilisez la commande suivante pour définir la valeur Adresse IP cible de la boîte de dialogue Sélection du contrôleur. Consultez également la description du paramètre <TargetAddressURI>.

Pour un accès sécurisé, vous pouvez utiliser des commutateurs de paramètres d'appel supplémentaires.

Utilisation : 

ControllerAssistant -connect ip <TargetAddressURI>

Exemples : 

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)"

Définition du chemin par défaut des boîtes de dialogue Fichier

Utilisez la commande suivante pour définir le chemin par défaut des boîtes de dialogue Ouvrir et Enregistrer.

Utilisation : 

ControllerAssistant -file <Path>

Exemple : 

ControllerAssistant -file C:\Temp\Default.bpd

Chargement d'image à partir d'un contrôleur

Utilisez la commande suivante pour créer une sauvegarde du contrôleur spécifié et enregistrer celle-ci en tant qu'image. La séquence de traitement de cette sauvegarde est inscrite dans le fichier journal spécifié. Le programme s'exécute entièrement sans aucune interface utilisateur. Consultez également la description du paramètre <TargetAddressURI>.

Pour un accès sécurisé, vous pouvez utiliser des commutateurs de paramètres d'appel supplémentaires.

Pour lire la gestion des droits utilisateur de l'équipement, vous pouvez utiliser l'argument de ligne de commande facultatif -ReadOnlineUserRightsManagement <ignore|read>. Si vous souhaitez lire la gestion des droits utilisateur de l'équipement, vous devez ajouter l'argument de ligne de commande -UserRightsManagementPassword <MyUserRightsManagementPassword>. Pour la version graphique et une explication détaillée, voir Gestion des droits utilisateur de l'équipement.

Utilisation : 

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

Exemples : 

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
NOTE : Si vous démarrez le Controller Assistant avec l'interface utilisateur graphique (GUI - Graphical User Interface), vous pouvez également définir les trois arguments - username, -password et -renewalpassword. Dans ce cas, vous n'êtes pas invité à entrer les identifiants. Ils sont extraits des valeurs des arguments.
NOTE : Pour enregistrer l'image active dans un seul fichier image (extension de fichier *.bdp), appelez également -savefile.
NOTE : Tous les fichiers présents dans le dossier cible seront supprimés.
AVIS
PERTE DE DONNEES
Avant d'exécuter la commande, vérifiez le chemin du répertoire fourni par l'argument -imagedirectory.
Le non-respect de ces instructions peut provoquer des dommages matériels.

Enregistrement d'image sur un contrôleur

Utilisez la commande suivante pour enregistrer l'image sur un contrôleur particulier. La séquence d'enregistrement est entrée dans le fichier journal (Logfile) indiqué. Le programme s'exécute sans aucune interface graphique. Consultez également la description du paramètre <TargetAddressURI>.

Pour un accès sécurisé, vous pouvez utiliser des commutateurs de paramètres d'appel supplémentaires.

Pour écrire la gestion des droits utilisateur de l'équipement, vous pouvez utiliser l'argument de ligne de commande facultatif -WriteOnlineUserRightsManagement <keep|overwrite|restore>. Si vous souhaitez remplacer la gestion des droits utilisateur de l'équipement, vous devez ajouter l'argument de ligne de commande -UserRightsManagementPassword <MyUserRightsManagementPassword>. Pour la version graphique et une explication détaillée, voir Gestion des droits utilisateur de l'équipement.

Utilisation : 

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

Exemples : 

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
NOTE : Si vous démarrez le Controller Assistant avec l'interface utilisateur graphique (GUI - Graphical User Interface), vous pouvez également définir les trois arguments - username, -password et -renewalpassword. Dans ce cas, vous n'êtes pas invité à entrer les identifiants. Ils sont extraits des valeurs des arguments.
NOTE : Pour l'argument de ligne de commande -savecontrol, le système de fichiers du contrôleur est écrasé sans invite au moment de l'exécution de la commande, puis le contrôleur est réinitialisé.
 AVERTISSEMENT
PERTE DE DONNEES ET FONCTIONNEMENT IMPRÉVU DE L'EQUIPEMENT POSSIBLE
Vérifiez que l'image active, avec son programme, sa configuration et sa mémoire, correspond à la fonction du contrôleur dans votre machine ou votre processus.
Le non-respect de ces instructions peut provoquer la mort, des blessures graves ou des dommages matériels.

Pour charger l'image active à partir d'un fichier image (extension *.bdp), appelez -loadfile auparavant.

Chargement d'image à partir d'un fichier .bpd

Pour charger un fichier *.bpd comme image, utilisez la commande suivante. La séquence de chargement est entrée dans le fichier journal (Logfile) indiqué. Le programme s'exécute sans aucune interface graphique.

Utilisation : 

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

Exemples : 

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

Enregistrement d'une image dans un fichier *.bpd

Pour enregistrer l'image dans un fichier *bpd particulier, utilisez la commande suivante. La séquence d'enregistrement est entrée dans le fichier journal (Logfile) indiqué. Le programme s'exécute sans aucune interface graphique.

Utilisation : 

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

Exemples : 

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

Affichage des versions de micrologiciel installées

Utilisez la commande suivante pour enregistrer un fichier XML avec une liste de versions de micrologiciels d'un type de contrôleur donné qui peut être trouvé sur ce PC dans le chemin du résultat. Ce résultat fournit les mêmes informations que celles disponibles dans l'interface graphique.

Si les commutateurs -ProductName et -ProductVersion sont définis, le fichier XML contient uniquement les résultats correspondant au nom et à la version de produit spécifiés.

Utilisation : 

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

Exemple : 

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

Récupération des versions de micrologiciels de tous les périphériques Sercos d'un contrôleur

Utilisez la commande suivante pour enregistrer un fichier XML avec une liste de toutes les versions de micrologiciels de tous les périphériques Sercos d'un type de contrôleur donné qui peut être trouvé sur ce PC dans le chemin du résultat. Ce résultat fournit les mêmes informations que celles disponibles dans l'interface graphique.

Utilisation : 

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

Exemple : 

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

Création d'une image

L'appel via la ligne de commande crée l'image avec le type ou la famille de contrôleur donné(e) et la version indiquée. Les mêmes fonctionnalités sont également disponibles dans l'interface utilisateur graphique.

Utilisation : 

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

Exemple : 

ControllerAssistant -createimage LMC400C 1.50.1.3 c:\Temp\MyLogfile.log
NOTE : La commande XML de création du micrologiciel du contrôleur offre des fonctionnalités supplémentaires.

Mise à jour de la version du micrologiciel de l'image active

L'appel via la ligne de commande met à jour le micrologiciel de l'image active à la version indiquée. Les mêmes fonctionnalités sont également disponibles dans l'interface utilisateur graphique. Le type de contrôleur et la version de micrologiciel sont donnés par le répertoire d'images existant. Si une version compatible est détectée, la mise à jour s'effectue sans supprimer l'application existante.

Utilisation : 

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

Exemples : 

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

Mise à jour des paramètres de communication

L'appel via la ligne de commande met à jour les paramètres de communication d'un contrôleur au sein d'une image existante en les remplaçant par les paramètres indiqués. Les mêmes fonctionnalités sont également disponibles dans l'interface utilisateur graphique.

Utilisation : 

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

Le paramètre DeviceName est utilisé avec IPMode dhcp. Sur certains contrôleurs, IPMode et DeviceName sont ignorées.

Exemples : 

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

Obtention de la version du programme

Utilisez la commande suivante pour obtenir le numéro de version de l'application Controller Assistant. Le fichier journal facultatif <LogFile> est utilisé pour consigner le résultat et les erreurs détectées. Voir aussi la description des valeurs facultatives et valeurs par défaut.

Utilisation : 

ControllerAssistant -getProgramVersion [<logfile>]

Exemple : 

ControllerAssistant -getProgramVersion c:\temp\version.log

Création d'un dossier utilisateur avec des données spécifiques sur le disque flash

Utilisez la commande suivante pour ajouter des fichiers spécifiques dans une image de contrôleur.

Utilisation : 

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

SourcePath désigne un dossier contenant les fichiers copiés dans l'image de contrôleur. Ce chemin peut également comprendre des sous-répertoires. RelativeDestinationPath est facultatif et désigne un sous-dossier de l'image de contrôleur où les fichiers sont stockés. Ce sous-dossier (ou cette structure de sous-dossiers) est rattaché(e) au dossier racine de imagepath.

Exemples : 

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

Copie de fichiers d'application et ajout d'une application au fichier de configuration du contrôleur

Utilisez la commande suivante pour ajouter une application à une image de contrôleur. Par exemple, pour la famille de contrôleurs LMC•0•C, les fichiers *.app et les fichiers *.crc correspondants sont copiés dans le dossier d'image et la section CmpApp du fichier *sysc3.cfg est modifiée.

NOTE : Cette commande n'est pas prise en charge par certains types de contrôleur.

Utilisation : 

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

Exemple : 

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

ApplicationPath est le dossier contenant les fichiers *.app et *.crc correspondants. ApplicationName est le nom du fichier *.app (nom de fichier sans extension).

Affichage des commandes prises en charge

Utilisez la commande suivante pour afficher la liste des commandes possibles avec leurs arguments sur la console.

Utilisation : 

ControllerAssistant -help

Exemple : 

ControllerAssistant -help

Etablissement d'une connexion à distance classique

Utilisez la commande CreateRemoteConnection pour établir une connexion distante statique à un contrôleur spécifié par une adresse IP et un port.

Syntaxe : 

-CreateRemoteConnection <ipAddressAndOptionalPort> [<RetryIfConnectionBreaks>]

Paramètre

Description 

<ipAddressAndOptionalPort>

Adresse IP et port (facultatif), séparés par un caractère : (deux-points). 

<RetryIfConnectionBreaks>

Paramètre facultatif qui définit le comportement en cas d'interruption de la connexion :

  • 0 (valeur par défaut)

    Lorsque la connexion est interrompue, aucune tentative de reconnexion n'a lieu.

  • 1

    Lorsque la connexion est interrompue, des tentatives de reconnexion automatique ont lieu. Leur nombre est illimité.

Exemples : 

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

Etat de la connexion :

Après avoir exécuté la commande CreateRemoteConnection, vous obtenez une boîte de dialogue Connexion distante :

  • Elle fournit des informations sur l'état de la connexion distante.

  • Elle vous permet de mettre fin à la connexion en cliquant sur OK.

  • Si la connexion ne peut pas être établie ou si elle est interrompue, elle fournit des informations sur les raisons possibles.

  • Elle indique si vous avez activé le paramètre <RetryIfConnectionBreaks> en vous signalant que des tentatives de reconnexion automatique ont lieu.

Exemple d'application :

Vous pouvez utiliser la commande CreateRemoteConnection, par exemple, dans les applications de serveur OPC. Elle est utile si le serveur OPC est installé sur un PC et prévoit de se connecter à un contrôleur situé dans un autre sous-réseau (connexion distante). Dans ce cas, établissez la connexion distante avec cette commande avant de démarrer le serveur. La passerelle locale peut ensuite scruter le contrôleur distant. Mettez fin à la connexion après avoir arrêté le serveur.

Arrêt des applications d'un contrôleur spécifié

Utilisez la commande StopAllApplications pour arrêter les applications du contrôleur spécifié.

Pour un accès sécurisé, vous pouvez utiliser des commutateurs de paramètres d'appel supplémentaires.

Utilisation : 

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

Exemples : 

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"
NOTE : Si vous démarrez le Controller Assistant avec l'interface utilisateur graphique (GUI - Graphical User Interface), vous pouvez également définir les trois arguments - username, -password et -renewalpassword. Dans ce cas, vous n'êtes pas invité à entrer les identifiants. Ils sont extraits des valeurs des arguments.

Comportement relatif aux les fichiers CNC

Les fichiers CNC sont stockés dans la mémoire interne du contrôleur, dans le dossier <root>/MECNC.

Le commutateur de paramètre d'appel cncsettings peut être utilisé pour définir le comportement relatif aux fichiers CNC lors du processus de création ou de mise à jour du micrologiciel.

  • dontcreate (paramètre par défaut) : Les fichiers du dossier <root>/MECNC sont supprimés lors du processus de création ou de mise à jour du micrologiciel.

  • path <PathToZippedFile> : Les fichiers du fichier ZIP (sous-dossiers compris) sont copiés dans le dossier <root>/MECNC.

  • preserve : Les fichiers du dossier <root>/MECNC sont conservés lors du processus de création ou de mise à jour du micrologiciel.

NOTE : Les licences CNC sont stockées dans le dossier <root>/MECNC/License et ne sont pas modifiés lors du processus de création ou de mise à jour du micrologiciel.

Utilisation : 

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

Exemples : 

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

Identification d’équipement

Consultez Paramètres d'appel d'identification des équipements réseau pour plus d'informations sur les appels de ligne de commande propres à Network Device Identification.

Commandes XML

Consultez Commandes XML pour plus d'informations sur les commandes supplémentaires définies dans des fichiers au format XML.