Escapez à l’article

Ecrire avec des scripts

Les scripts sont un mécanisme d'application spécial pour envoyer et traiter des instructions de manière séquentielle. Ils peuvent configurer les paramètres de la carte de codage, lire et écrire dans la mémoire de l'émetteur-récepteur et effectuer d'autres opérations.

Utilisez des scripts lorsqu'un émetteur-récepteur nécessite une procédure de programmation qui diffère de la norme MSA et nécessite une séquence d'instructions spéciales pour enregistrer avec succès les modifications de la mémoire. Les scripts peuvent également automatiser la programmation répétée de différentes zones de mémoire de l'émetteur-récepteur avec une implication minimale de l'opérateur.


Comment utiliser un script ?

  1. Ouvrir le menu Contrôle - Ecrire à l'aide d'un script - Sélectionner un fichier script pour spécifier le chemin du fichier script ;
  2. Assurez-vous que l'éditeur contient le code correct si le script utilise les données de l'éditeur lors de l'exécution ;
  3. Cliquez sur le bouton d'écriture dans la mémoire de l'émetteur-récepteur pour exécuter le script.

Lors de l'exécution d'un script, l'application ignore les paramètres de la zone mémoire actuellement sélectionnée. Les zones de lecture et d'écriture doivent être précisées dans les commandes de script.

Veuillez noter que le logiciel ne vérifie pas si l'écriture a réussi une fois le script terminé.


Comment effacer le script sélectionné ?

Aller dans le menu Contrôle - Ecrire à l'aide d'un script - Réinitialiser le script - pour effacer le script sélectionné et revenir à l'écriture standard.


Comment créer un script ?

La syntaxe des commandes de script est basée sur le protocole de commande SFPTotal.

Exemple :

// Write password AABBCCDD to page A2 at offset 7B
w2A2007B03AABBCCDD
// Write the code from the editor to page A0 at offset 00
w2A000007F{00;7F}
// Write value 80 to page A2 at offset 7F
w2A2007F0080
// Write value 01 to page A2 at offset FF
w2A200FF0001
PAUSE
// Read code from page A0 at offset 00
R2A000007F

Créez un fichier texte et saisissez une instruction par ligne. Enregistrez le fichier de script pour utiliser cette procédure de programmation dans l'application.


Commandes de script supplémentaires

Les commandes supplémentaires suivantes sont traitées par l'application.

PAUSE

Suspendre l'exécution du script. La pause par défaut est de 100 ms.

Un paramètre facultatif fixe la durée de la pause en millisecondes.

PAUSE
Delay 100ms
PAUSE=2000
Delay 2000ms


SETCHECKSUM

Recalculer la somme de contrôle.


SETVAL

Réglez la cellule de l'éditeur au décalage XX sur la valeur YY. Spécifiez les valeurs des paramètres au format majuscule HEX.

Le paramètre offset accepte des valeurs de 00 à 7F.

SETVAL 7F 03


{00;7F}

La macro de substitution {XX;YY} est utilisé dans d'autres commandes pour insérer un segment de code depuis l'éditeur. Lors de l'exécution du script, la macro est automatiquement remplacée par les données actuelles de l'éditeur commençant à l'octet XX et s'étendant sur YY octets.

A noter qu'une valeur de paramètre YY de 00 dans HEX signifie que 1 octet est substitué, tandis qu'une valeur de 7F dans HEX signifie que 128 octets sont substitués. Définissez YY sur la longueur du segment en octets moins un, exprimée en hexadécimal.

Exemple : écriture d'un segment de 128 octets dans la page A2h au décalage 80h.

w2A200807F{00;7F}

Exemple : écriture d'un segment de seuil DDM de 96 octets dans la page A2h au décalage 00h, suivie d'une lecture.

W2A200005F{00;5F}

Exemple : attribuer à une variable le segment de code de 16 octets au décalage 0x44 qui contient le numéro de série.

$VAR2={44;0F}


$VAR1

Variable tampon $VAR1. Utilisez des variables tampon pour stocker les segments de code de l'éditeur et insérer leur contenu pendant l'exécution du script.

L'application prend en charge 10 variables tampon, $VAR0 à $VAR9.

$VAR1={00;43}
$VAR2={44;0F}
$VAR3={54;2B}
$VAR4=002AFE
$VAR5=4F


$YYYY

Insérer l'année en cours dans la commande.


$MM

Insérez le mois en cours dans la commande.


$DD

Insérez le jour en cours dans la commande.


BACKUPTOFILE

Démarrez une sauvegarde du type de module sélectionné dans les paramètres de l'application. L'application lit les pages disponibles de manière séquentielle et enregistre les données dans un fichier. Cette commande équivaut à appeler la fonction depuis le menu de l'application.


BACKUPDIR

Définissez le répertoire de sauvegarde. Des paramètres supplémentaires peuvent être utilisés pour créer un répertoire avec un nom particulier.

Exemple : création d'un répertoire de sauvegarde avec la date dans son nom.

$VAR5=SOMETEXT
BACKUPDIR=\$YYYY-$MM-$DD_$VAR5\
BACKUPTOFILE


IMPORTFILE

Importer le code HEX depuis un fichier binaire dans l'éditeur.

IMPORTFILE=\catalog\filename.bin


IMPORTHEX

Importer le code HEX dans l'éditeur.

Exemple : importer un segment de code de 128 octets dans l'éditeur.

IMPORTHEX=030407100000000000000006670000000802001E4F454D2020202020202020202020202000000B4053465031302D535220202020202020204120202003520091001A000058473936535230313020202020202020303830393236202068F0031200001111A8DD05AA642FAA6F5A64DAF3285A9D000000000000000000F05E482F

Importez du code dans l'éditeur en concaténant les variables du tampon.

$VAR1={00;43}
$VAR2={44;0F}
$VAR3={54;2B}
IMPORTHEX=$VAR1$VAR2$VAR3


INCREMENT

Incrémentez la valeur d'une variable contenant une représentation hexadécimale de code pour que le nombre à la fin de sa représentation textuelle augmente de un.

Par exemple, la représentation textuelle de la variable SN129YY00201 est converti en SN129YY00202.

Si des zéros précèdent la partie numérique, l'application tente de conserver la longueur de chaîne d'origine lorsque le nombre incrémenté nécessite un chiffre supplémentaire, en décalant la valeur vers la gauche. Ainsi, la valeur SN129YY00999 est converti en SN129YY01000.

$VAR1={00;43}
// Assign the code area containing the serial number to a variable
$VAR2={44;0F}
$VAR3={54;2B}
INCREMENT $VAR2
IMPORTHEX=$VAR1$VAR2$VAR3


ERASEVENDORCODE

Remplissez la zone spécifique au fournisseur dans l'éditeur avec des zéros.


COUNTER

Compteur d'itérations de script.

Placez cette commande au début d'un fichier script qui s'exécute en boucle. Le nombre d'itérations actuel est disponible via la variable $COUNTER.

// Invoke the iteration counter
COUNTER
// Assign the current counter value to a variable
$VAR0=$COUNTER
// Display the counter value
ECHO $COUNTER


IF A ... B THEN ...

Comparez les valeurs. Utilisez cette construction pour comparer A et B et exécutez la commande suivant ALORS si la condition spécifiée est vraie.

// Assign numeric values to variables
$VAR1=10
$VAR2=20
// Display a message box if the condition is true.
IF $VAR1 < $VAR2 THEN MSGBOX HELLO WORLD!


LOOP

Répétez le script. Placez cette commande à la fin du fichier de script pour indiquer à l'application de réexécuter la procédure. La commande UNLOOP annule LOOP. Utilisez une condition pour sortir de la boucle et éviter les répétitions sans fin.

Exemple avec une condition.

COUNTER
...
R1A000007F
...
// Repeat the script until 10 iterations have completed
IF $COUNTER < 10 THEN LOOP

Si un script entre dans une boucle infinie, arrêtez-le à l'aide de la commande d'interruption globale dans <Outils - Processus d'interruption>.


STRTOHEX

Convertissez le texte suivant l'opérateur en une chaîne HEX.

$VAR9=STRTOHEX QSFP28-SR4 
MSGBOX $VAR9


HEXTOSTR

Convertissez la chaîne HEX suivant l'opérateur en texte.

$VAR9=HEXTOSTR 5153465032382D535234202020202020
MSGBOX $VAR9


PADRIGHTHEX

Complétez la valeur hexadécimale dans $VAR1 à droite avec le caractère dont le code est YY jusqu'à ce que la longueur de sa représentation textuelle atteigne XX.

Format de commande :

PADRIGHTHEX XX YY $VAR1

  • XX - un nombre décimal spécifiant la longueur de la représentation textuelle de la chaîne HEX ;
  • YY - le code HEX du caractère utilisé pour remplir la chaîne à la longueur requise ;
  • $VAR1 - la variable contenant la chaîne HEX à convertir.
// Convert text to a HEX string and store it in a variable
$VAR9=STRTOHEX QSFP28-SR4 
// Pad the variable on the right with spaces (HEX code 0x20) to 16 bytes 
$VAR8=PADRIGHTHEX 16 20 $VAR9
ECHO $VAR8

Cette commande est utile lors de l'attribution d'un texte à une variable et de sa conversion en une chaîne HEX d'une longueur spécifique.


PADLEFTHEX

Fonctionne comme PADRIGHTHEX. Remplissez la valeur hexadécimale dans $VAR1 à gauche avec le caractère dont le code est YY jusqu'à ce que la longueur de sa représentation textuelle atteigne XX.


SAVECODEDIR

Définissez le chemin d'enregistrement automatique d'un fichier de code sans boîte de dialogue.

Exemple : définition du chemin de sortie du code vers un répertoire nommé d'après le numéro de série dans le code :

$VAR4=HEXTOSTR {44;0F}
SAVECODEDIR=C:\Users\DemoUser\Desktop\Codes\$VAR4


SAVEFILE

Enregistrer le code à un fichier sur le chemin établi par SAVECODEDIR. L'application génère automatiquement le nom du fichier selon le type et la page du module sélectionné.

$VAR4=HEXTOSTR {44;0F}
SAVECODEDIR=C:\Users\DemoUser\Desktop\Codes\$VAR4
SAVEFILE


SIGNATURE

Faites fonctionner le générateur avec des paramètres prédéfinis.

Cette fonctionnalité nécessite une licence de générateur étendue dans l'application, qui n'est pas incluse dans le package standard.


Gestionnaire API externe

APIURL

Définissez l'URL utilisée pour appeler le gestionnaire externe API.

APIURL=http://localhost/example/api.php

APICALL

Appelez le gestionnaire externe API. Cela équivaut à cliquer sur le bouton API dans la fenêtre principale de l'application.

Format de requête POST pour les appels à APIURL

POST Fields: code=0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000&module_type=1&table=A0&offset=00
  • code code : une chaîne de 256 caractères (HEX, majuscule) ;
  • module_type type de module (0 — GBIC, 1 — SFP, 2 — SFP-DD, 3 — XFP, 4 — QSFP, 5 — QSFP-DD, 6 — OSFP);
  • table - adresse de table (HEX, majuscule ; par exemple : A0, A2) ;
  • offset - décalage de table (HEX, majuscule ; par exemple : 00, 80).

Le serveur doit retourner une chaîne JSON :

{"status":1,"script":"R1A000007F\r\nW1A000007F{00;7F}\r\n","message":"","code":"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","module_type":"1","table":"A0","offset":"00"}

La réponse du serveur doit contenir les paramètres suivants :

  • status état de traitement : 1 - importer et exécuter le script ; 0 — afficher un message sans importer de code ;
  • script - texte de script à exécuter après importation du code ; laisser vide si aucun script n'est spécifié ;
  • message message renvoyé, affiché lorsque status=0 ;
  • code code renvoyé : une chaîne de 256 caractères (HEX, majuscule) ;
  • module_type type de module (0 — GBIC, 1 — SFP, 2 — SFP-DD, 3 — XFP, 4 — QSFP, 5 — QSFP-DD, 6 — OSFP);
  • table - adresse de table (HEX, majuscule ; par exemple : A0, A2) ;
  • offset - décalage de table (HEX, majuscule ; par exemple : 00, 80).


Opérations arithmétiques

Le processeur de script prend en charge l'addition, la soustraction, la multiplication et la division via le MATH.

Format de commande :

MATH Value1 %Operator Value2

Opérateurs arithmétiques pris en charge :

  • + - ajout ;
  • - - soustraction ;
  • * - multiplications ;
  • / - division ;
COUNTER
$VAR0=MATH 10 - $COUNTER
ECHO $VAR0
// Repeat the script while the condition is true
IF $VAR0 > 0 THEN LOOP


Fichier utilisateur

Commandes pour travailler avec un fichier utilisateur.

USERFILEPATH

Définissez le chemin du fichier utilisateur.

USERFILEPATH=C:\Users\User\Desktop\user-file.txt

GETUSERFILESTRING

Lire la ligne spécifiée dans le fichier utilisateur.

GETUSERFILESTRING 10

SAVETOUSERFILE

Enregistrez les données dans le fichier utilisateur.

Exemple :

// Store the serial number in a variable
$VAR2={44;0F}
// Save the variable value to the user file
SAVETOUSERFILE HEXTOSTR $VAR2
// Add a line feed and carriage return
SAVETOUSERFILE HEXTOSTR 0D0A

$STRCOUNTUSERFILE

Cette valeur contient le nombre de lignes dans le fichier utilisateur.

// Find the inserted line's position by subtracting the script iteration count from the file's line count 
$VAR0=MATH $STRCOUNTUSERFILE - $COUNTER
ECHO $VAR0
// Read the most recently inserted line from the file
GETUSERFILESTRING $VAR0
Mise à jour: