每個(gè)命令都通過其緊湊的正式描述(稱為“語法表”)進(jìn)行介紹。語法表包含完整的參數(shù)列表及其可能的值和默認(rèn)設(shè)置(如果適用)。
下面以虛構(gòu)的 setCommandName命令為例說明語法表中使用的約定。該命令的語法表是:
圖 1:setCommandName 和 getCommandName 命令的語法表
關(guān)聯(lián)的set - 和get - 命令始終成對(duì)描述,關(guān)聯(lián)的exe - 和get - 命令也是如此。命令名稱及其等效的 3-5 個(gè)字符助記符打印在前兩列中。set 和 get 命令的參數(shù)列表分別列在第一行和第二行中。在我們的示例中,setCommandName最多可以接受 6 個(gè)參數(shù),而getCommandName只接受 1 個(gè)參數(shù)。強(qiáng)制性參數(shù)以粗體顯示。除了強(qiáng)制參數(shù)之外,命令行中還必須至少提供一個(gè)可選參數(shù)。
每個(gè)參數(shù)的可能值列表都打印在每個(gè)參數(shù)的下面。可選參數(shù)的默認(rèn)值帶有下劃線。強(qiáng)制性參數(shù)以粗體突出顯示。語法表下以藍(lán)色打印的鏈接顯示了可以在哪個(gè) GUI 菜單下找到該命令。
上面的虛構(gòu)命令包含所有可能的參數(shù)類型:
-
Cd 用作所有以下參數(shù)的索引。該參數(shù)在set命令中是強(qiáng)制的。可接受的值為COM1、COM2和all,分別對(duì)應(yīng)于第一個(gè)或第二個(gè)串行端口,或分別對(duì)應(yīng)于兩個(gè)串行端口。前兩個(gè)值之前的“+”號(hào)表示可以將它們組合起來以在同一命令中尋址兩個(gè)串行端口。
示例:COM1、COM1+COM2、全部(實(shí)際上是COM1+COM2的別名)。
-
距離是-20 到 20之間的數(shù)字,默認(rèn)值為0,最多 2 位小數(shù)。如果提供更多數(shù)字,則會(huì)返回錯(cuò)誤。“m”表示該值以米表示。請(qǐng)注意,輸入命令時(shí)不應(yīng)鍵入此“m”。
示例:20、10.3、-2.34
-
時(shí)間是1到50之間的數(shù)字,沒有小數(shù)位(即這是一個(gè)整數(shù)值)。該值以秒表示。
示例:1、10
-
消息是一個(gè)最大長度為 120 個(gè)字符的字符串。該參數(shù)的默認(rèn)值為“未知”。當(dāng)必須使用空格時(shí),字符串必須放在引號(hào)之間,并且這些括起來的引號(hào)不被視為字符串的一部分。字符串中允許的字符列表是:
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 !#%@()*+-./:;<=>?[\]^_'{|}~
示例:“Hello World!”
-
密碼是最大長度為 20 個(gè)字符 (40/2) 的密碼參數(shù)。密碼參數(shù)始終命名為Password或Key。密碼總長度中只有一半可供用戶使用,另一半由系統(tǒng)保留。密碼被接收者混淆,因此無法在命令回復(fù)中讀回。除了上面的字符(請(qǐng)參閱Message參數(shù))之外,使用相應(yīng)的轉(zhuǎn)義序列還允許在密碼中使用特殊字符:
-
輸入%%DQ獲取“
-
輸入%%SQ以獲得'
-
輸入%%DL獲取$
-
輸入%%AM獲取&
-
輸入%%CM以獲得,
示例:“ ab%%AM123 ”將是“ab&123”
-
眾數(shù)是一系列無法組合的單個(gè)值(它們前面沒有“+”號(hào))。可以為該參數(shù)選擇off或on ,默認(rèn)值為on。
示例:開
-
PRN 是可以用“ + ”號(hào)組合在一起的一系列值。默認(rèn)值GPS是 G 01+G02+ ... +G32的別名,SBAS 是S120+ ... +S138的別名,所有都是GPS+SBAS的別名。可以在參數(shù)之前設(shè)置“ + ”號(hào),以指示將指定值添加到當(dāng)前列表。如果支持值“ none ”(本例中就是這種情況),則可以在參數(shù)之前設(shè)置“ - ”號(hào)以從當(dāng)前列表中刪除指定的值。可以通過使用“添加”或“減去”來一次添加或刪除多個(gè)值- ”運(yùn)算符。但是,“+”和“-”永遠(yuǎn)不能組合在單個(gè)參數(shù)中。
示例:G01+G02、+G03、GPS+S120、+G04+G05、-S122-S123、-GPS
https://customersupport.septentrio.com/s/article/CLI-syntax-tables