主页 > 技术支持 > CLI 第 6 章:命令语法表

问题解答

CLI 第 6 章:命令语法表

每个命令都通过其紧凑的正式描述(称为“语法表”)进行介绍。语法表包含完整的参数列表及其可能的值和默认设置(如果适用)。 

下面以虚构的 setCommandName命令为例说明语法表中使用的约定。该命令的语法表是:

图 1:setCommandName 和 getCommandName 命令的语法表
关联的set - 和get - 命令始终成对描述,关联的exe - 和get - 命令也是如此命令名称及其等效的 3-5 个字符助记符打印在前两列中。set 和 get 命令的参数列表分别列在第一行和第二行中。在我们的示例中,setCommandName最多可以接受 6 个参数,而getCommandName只接受 1 个参数。强制性参数以粗体显示。除了强制参数之外,命令行中还必须至少提供一个可选参数。

每个参数的可能值列表都打印在每个参数的下面。可选参数的默认值带有下划线。强制性参数以粗体突出显示。语法表下以蓝色打印的链接显示了可以在哪个 GUI 菜单下找到该命令。

上面的虚构命令包含所有可能的参数类型:
 
  • Cd 用作所有以下参数的索引。该参数在set命令中是强制的。可接受的值为COM1、COM2all,分别对应于第一个或第二个串行端口,或分别对应于两个串行端口。前两个值之前的“+”号表示可以将它们组合起来以在同一命令中寻址两个串行端口。
示例:COM1、COM1+COM2、全部(实际上是COM1+COM2的别名)。
 
  • 距离是-20 到 20之间的数字,默认值为0,最多 2 位小数。如果提供更多数字,则会返回错误。“m”表示该值以米表示。请注意,输入命令时不应键入此“m”。
示例:20、10.3、-2.34
 
  • 时间是150之间的数字,没有小数位(即这是一个整数值)。该值以秒表示。
示例:1、10
 
  • 消息是一个最大长度为 120 个字符的字符串。该参数的默认值为“未知”。当必须使用空格时,字符串必须放在引号之间,并且这些括起来的引号不被视为字符串的一部分。字符串中允许的字符列表是:
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 !#%@()*+-./:;<=>?[\]^_'{|}~

示例:“Hello World!”
 
  • 密码是最大长度为 20 个字符 (40/2) 的密码参数。密码参数始终命名为PasswordKey密码总长度中只有一半可供用户使用,另一半由系统保留。密码被接收者混淆,因此无法在命令回复中读回。除了上面的字符(请参阅Message参数)之外,使用相应的转义序列还允许在密码中使用特殊字符:
    • 输入%%DQ获取
    • 输入%%SQ以获得'
    • 输入%%DL获取$
    • 输入%%AM获取&
    • 输入%%CM以获得,
示例:“ ab%%AM123 ”将是“ab&123”
 
  • 众数是一系列无法组合的单个值(它们前面没有“+”号)。可以为该参数选择offon 默认值为on
示例:
 
  • PRN 是可以用“ + ”号组合在一起的一系列值默认值GPS是 G 01+G02+ ... +G32的别名,SBAS 是S120+ ... +S138的别名所有都是GPS+SBAS的别名可以在参数之前设置“ + ”号,以指示将指定值添加到当前列表。如果支持值“ none ”(本例中就是这种情况),则可以在参数之前设置“ - ”号以从当前列表中删除指定的值。可以通过使用“添加”或“减去”来一次添加或删除多个值- ”运算符。但是,“+”和“-”永远不能组合在单个参数中。

示例:G01+G02、+G03、GPS+S120、+G04+G05、-S122-S123、-GPS



https://customersupport.septentrio.com/s/article/CLI-syntax-tables

     企业微信

    

我司企业微信 Close
the qr code