計量表管理服務

本節描述測試控制工具複合的計量表管理服務。

AddMeters

此 Web 服務會將一組計量表新增到記憶體內的資料存放區中。這不會將計量表永久新增至控制檔中。

輸入 - AddMetersInput

組件：承載

元素：AddMetersRequest


參數	描述
id	計量表的識別代碼。
macID	MAC 位址在系統中必須是唯一的。
utility	資訊字串。
serviceType	其中一個有效的 ServiceType 值 (請參閱結構)。「電力」是此時唯一的選項。
isCommissioned	計量表是否處於開始通訊狀態。
loadActionCode	用於「連接」及「斷接」的其中一個可能的 LoadActionCode 值 (請參閱結構)。
outageEventType	用於「裝置狀態檢查」的其中一個可能的 OutageEventType 值 (請參閱結構)。
executionStatus	其中一個可能的 ExecutionStates (請參閱結構)。這些值會控制計量表回應指令的方式。
groupName	將多個計量表連結到某個集合的名稱。
jobExecutionStatus	其中一個可能的「工作執行狀態」值 (請參閱結構)。此屬性會決定受要求之工作的執行方式。
updateIfExisting	如果索引中已經有該計量表，是否要用提供的值更新該計量表。
Comment	描述計量表用途的資訊字串。
Channels	此計量表支援的計量單位列表。
uomCode	描述管道之計量單位的代碼。
uomName	包含計量單位名稱的短字串。
decimals	抄表時，應在小數點右側產生的位數。
description	較長的計量單位描述。

輸出 - AddMetersOutput

組件：承載

元素：AddMetersResult

是否已將每個計量表新增至索引。

錯誤 - 請參閱 UtilityFault

RemoveMeter

此 Web 服務會移除記憶體內資料存放區中的計量表。這不會將計量表永久從控制檔中移除。

輸入 - RemoveMeterInput

組件：承載

元素：RemoveMeterRequest


參數	描述
id	要移除之計量表的 ID

輸出 - RemoveMeterOutput

組件：承載

元素：RemoveMeterResult

是否已將該計量表從索引中移除。

錯誤 - 請參閱 UtilityFault。找不到計量表 ID 時，就會擲回錯誤。

AddMeterChannel

此 Web 服務會將新的管道新增至單一計量表。

輸入 - AddMeterChannelInput

組件：承載

元素：AddMeterChannelRequest


參數	描述
id	計量表的識別代碼。
uomCode	描述管道之計量單位的代碼。
uomName	包含計量單位名稱的短字串。
decimals	抄表時，應在小數點右側產生的位數。
description	較長的計量單位描述。

輸出 - AddMeterChannelOutput

組件：承載

元素：AddMeterChannelResult

是否已將該管道新增至索引。

錯誤 - 請參閱 UtilityFault。找不到計量表 ID 時，就會擲回錯誤。

RemoveMeterChannel

此 Web 服務會從計量表中移除「管道」。

輸入 - RemoveMeterChannelInput

組件：承載

元素：RemoveMeterChannelRequest


參數	描述
id	要移除之計量表的 ID。
uomCode	描述管道之計量單位的代碼。
uomName	包含計量單位名稱的短字串。

系統會結合這三個參數來尋找唯一的管道

輸出 - RemoveMeterChannelOutput

組件：承載

元素：RemoveMeterChannelResult

是否已將該管道從計量表中移除。

錯誤 - 請參閱 UtilityFault。找不到計量表 ID 時，就會擲回錯誤。

ReadScalarMeter

此 Web 服務會針對指定計量表的每個管道來產生定量抄表值。

輸入 - ReadScalarMeterInput

組件：承載

元素：ReadScalarMeterRequest


參數	描述
id	要抄表之計量表的 ID

輸出 - ReadScalarMeterOutput

組件：承載

元素：ReadScalarMeterResult

指定計量表的零或多個定量抄表值。


參數	描述
uomCode	描述管道之計量單位的代碼。
uomName	包含計量單位名稱的短字串。
decimals	抄表時，應在小數點右側產生的位數。
description	較長的計量單位描述。
value	代表定量抄表值的隨機數字。