跳到文章

用脚本编写

脚本是用于顺序发送和处理指令的特殊应用机制。 他们可以配置编程板设置、读写收发器内存以及执行其他操作。

当收发器需要不同于MSA标准的编程过程并且需要一系列特殊指令来成功保存存储器改变时,使用脚本。 脚本还可以自动对不同收发器存储区域进行重复编程,而操作员的参与最少。


如何使用脚本?

  1. 打开菜单 控制-使用脚本写入-选择脚本文件 指定脚本文件路径;
  2. 如果脚本在执行期间使用编辑器数据,请确保编辑器包含正确的代码;
  3. 单击收发器存储器写入按钮来运行脚本。

当运行脚本时,应用程序忽略当前选择的存储区域设置。 必须在脚本命令中指定读取和写入区域。

请注意,在脚本完成后,软件不会验证写入是否成功。


如何清除选定的脚本?

进入菜单 控制-使用脚本写入-重置脚本 清除所选脚本并返回到标准书写。


如何创建脚本?

脚本命令语法基于SFPTotal命令协议。

示例:

// 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

创建文本文件并每行输入一条指令。 保存脚本文件以在应用程序中使用此编程过程。


附加脚本命令

以下附加命令由应用程序处理。

PAUSE

暂停脚本执行。 默认暂停时间为 100 毫秒。

可选参数设置以毫秒为单位的暂停持续时间。

PAUSE
Delay 100ms
PAUSE=2000
Delay 2000ms


SETCHECKSUM

重新计算校验和。


SETVAL

将偏移 XX 处的编辑器单元设置为值 YY。 以大写 HEX 格式指定参数值。

偏移参数接受从00到7F的值。

SETVAL 7F 03


{00;7F}

替换宏 {XX;YY} 在其他命令内部使用以从编辑器插入代码段。 在脚本执行期间,宏将自动替换为从字节 XX 开始并跨越 YY 字节的当前编辑器数据。

注意,YY参数值 00 HEX中的表示替换了1个字节,而值为 7F HEX中的表示替换了128字节。 将 YY 设置为以字节为单位的段长度减一,以十六进制表示。

示例:将128字节段写入页A2h偏移量80h处。

w2A200807F{00;7F}

示例:将96字节DDM阈值段写入页A2h偏移量00h处,然后进行读取。

W2A200005F{00;5F}

示例:将包含序列号的偏移量0x44处的16字节代码段分配给变量。

$VAR2={44;0F}


$VAR1

缓冲区变量$VAR1。 使用缓冲区变量存储编辑器中的代码段并在脚本执行期间插入其内容。

应用程序支持10个缓冲器变量,$VAR0-$VAR9。

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


$YYYY

将当前年份插入命令中。


$MM

将当前月份插入命令中。


$DD

将当前日期插入命令中。


BACKUPTOFILE

开始对应用程序设置中选择的模块类型进行备份。 应用程序按顺序读取可用页面并将数据保存到文件中。 该命令相当于从应用程序菜单中调用该功能。


BACKUPDIR

设置备份目录。 附加参数可用于创建具有特定名称的目录。

示例:创建名称中包含日期的备份目录。

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


IMPORTFILE

将HEX代码从二进制文件导入到编辑器中。

IMPORTFILE=\catalog\filename.bin


IMPORTHEX

将HEX代码导入编辑器。

示例:将128字节的代码段导入到编辑器中。

IMPORTHEX=030407100000000000000006670000000802001E4F454D2020202020202020202020202000000B4053465031302D535220202020202020204120202003520091001A000058473936535230313020202020202020303830393236202068F0031200001111A8DD05AA642FAA6F5A64DAF3285A9D000000000000000000F05E482F

通过连接缓冲区变量将代码导入到编辑器中。

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


INCREMENT

增加包含代码的十六进制表示的变量的值,使得其文本表示末尾的数字增加1。

例如,变量的文本表示 SN129YY00201 转换为 SN129YY00202.

如果数字部分之前有零,则当递增的数字需要附加数字时,应用程序尝试保留原始字符串长度,从而将值向左移动。 因此,值 SN129YY00999 转换为 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

用零填充编辑器中的供应商特定区域。


COUNTER

脚本迭代计数器。

将此命令放置在循环运行的脚本文件的开头。 当前迭代计数可通过 $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 ...

比较值。 使用此结构比较 A 和 B,如果指定条件为 true,则执行 THEN 之后的命令。

// 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

重复脚本。 将此命令放在脚本文件的末尾,以告诉应用程序再次运行该过程。 UNLOOP 命令取消 LOOP。 使用条件退出循环并避免无休止的重复。

具有条件的示例。

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

如果脚本进入无限循环,请使用<工具-中断进程>中的全局中断命令来停止它。


STRTOHEX

将运算符后面的文本转换为HEX字符串。

$VAR9=STRTOHEX QSFP28-SR4 
MSGBOX $VAR9


HEXTOSTR

将运算符后面的HEX字符串转换为文本。

$VAR9=HEXTOSTR 5153465032382D535234202020202020
MSGBOX $VAR9


PADRIGHTHEX

用代码为YY的字符填充右侧$VAR1中的十六进制值,直到其文本表示的长度达到XX。

命令格式:

PADRIGHTHEX XX YY $VAR1

  • XX 指定HEX字符串的文本表示的长度的十进制数;
  • YY 用于将字符串填充到所需长度的字符的HEX代码;
  • $VAR1 包含要转换的HEX字符串的变量。
// 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

当将文本分配给变量并将其转换为特定长度的HEX字符串时,该命令很有用。


PADLEFTHEX

与 PADRIGHTHEX 类似。 用代码为YY的字符填充左侧$VAR1中的十六进制值,直到其文本表示的长度达到XX。


SAVECODEDIR

设置自动保存代码文件的路径,无需对话框。

示例:设置代码输出路径为以代码中序号命名的目录:

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


SAVEFILE

将代码保存到由 SAVECODEDIR 设置的路径上的文件。 该应用程序根据所选择的模块类型和页面自动创建文件名。

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


SIGNATURE

用预设参数运行发生器。

该特征需要应用程序中的扩展生成器许可证,其不包括在标准包中。


外部API处理程序

APIURL

设置用于调用外部API处理程序的URL。

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

APICALL

调用外部API处理程序。 这相当于单击主应用程序窗口中的 API 按钮。

调用 APIURL 的 POST 请求格式

POST Fields: code=0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000&module_type=1&table=A0&offset=00
  • code 代码:256个字符的字符串(HEX,大写);
  • module_type 模块类型 (0 — GBIC, 1 — SFP, 2 — SFP-DD, 3 — XFP, 4 — QSFP, 5 — QSFP-DD, 6 — OSFP);
  • table 表地址(HEX,大写;例如:A0、A2);
  • offset 表偏移量(HEX,大写;例如:00、80)。

服务器必须返回 JSON 字符串:

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

服务器响应必须包含以下参数:

  • status 处理状态:1——导入并执行脚本; 0 — 显示消息而不导入代码;
  • script 导入代码后执行的脚本文本; 如果未指定脚本,则留空;
  • message 返回消息,status=0时显示;
  • code 返回码:256个字符的字符串(HEX,大写);
  • module_type 模块类型 (0 — GBIC, 1 — SFP, 2 — SFP-DD, 3 — XFP, 4 — QSFP, 5 — QSFP-DD, 6 — OSFP);
  • table 表地址(HEX,大写;例如:A0、A2);
  • offset 表偏移量(HEX,大写;例如:00、80)。


算术运算

脚本处理器通过以下方式支持加法、减法、乘法和除法: MATH.

命令格式:

MATH Value1 %Operator Value2

支持的算术运算符:

  • + -添加;
  • - -减法;
  • * —乘法;
  • / -分部;
COUNTER
$VAR0=MATH 10 - $COUNTER
ECHO $VAR0
// Repeat the script while the condition is true
IF $VAR0 > 0 THEN LOOP


用户文件

用于处理用户文件的命令。

USERFILEPATH

设置用户文件路径。

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

GETUSERFILESTRING

从用户文件中读取指定行。

GETUSERFILESTRING 10

SAVETOUSERFILE

将数据保存到用户文件。

示例:

// 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

该值包含用户文件中的行数。

// 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
更新: