メーター管理サービス

この項では、アダプタ開発キットのテスト・ハーネス・コンポジットのメーター管理サービスについて説明します。

AddMeters

このWebサービスは、一連のメーターをインメモリー・データ・ストアに追加します。これにより、永久に制御ファイルに追加されることはありません。

入力: AddMetersInput

部分: ペイロード

要素: AddMetersRequest


パラメータ	摘要
id	メーターのIDコード。
utility	情報文字列。
serviceType	有効なServiceType値のいずれか(「スキーマ」を参照)。現時点では、Electricが唯一のオプションです。
isCommissioned	メーターがコミッション済状態であるかどうか。
loadActionCode	接続および切断で使用可能なLoadActionCode値のいずれか(「スキーマ」を参照)。
outageEventType	設備ステータス・チェックで使用可能なOutageEventType値のいずれか(「スキーマ」を参照)。
executionStatus	使用可能なExecutionStatesのいずれか(「スキーマ」を参照)。これらの値により、コマンドへのメーターの応答方法が制御されます。
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	メーターのIDコード。
uomCode	チャネルの単位を記述するコード。
uomName	単位の名前が含まれる短い文字列。
decimals	検針時に生成される小数点以下の桁数。
description	単位の詳細な説明。

出力: AddMeterChannelOutput

部分: ペイロード

要素: AddMeterChannelResult

チャネルが索引に追加されたかどうか。

障害: 「UtilityFault」を参照してください。メーターIDが見つからない場合にスローされます。

RemoveMeterChannel

このWebサービスは、チャネルをメーターから削除します。

入力: RemoveMeterChannelInput

部分: ペイロード

要素: RemoveMeterChannelRequest


パラメータ	摘要
id	削除するメーターのID。
uomCode	チャネルの単位を記述するコード。
uomName	単位の名前が含まれる短い文字列。

これらの3つのパラメータを組み合せて一意のチャネルを特定します

出力: RemoveMeterChannelOutput

部分: ペイロード

要素: RemoveMeterChannelResult

チャネルがメーターから削除されたかどうか。

障害: 「UtilityFault」を参照してください。メーターIDが見つからない場合にスローされます。

ReadScalarMeter

このWebサービスは、指定されたメーターの各チャネルのスカラー検針を生成します。

入力: ReadScalarMeterInput

部分: ペイロード

要素: ReadScalarMeterRequest


パラメータ	摘要
id	検針するメーターのID。

出力: ReadScalarMeterOutput

部分: ペイロード

要素: ReadScalarMeterResult

指定されてメーターのゼロ個以上のスカラー検針。


パラメータ	摘要
uomCode	チャネルの単位を記述するコード。
uomName	単位の名前が含まれる短い文字列。
decimals	検針時に生成される小数点以下の桁数。
description	単位の詳細な説明。
value	スカラー検針を表すランダム番号。

障害: 「UtilityFault」を参照してください。メーターIDが見つからない場合にスローされます。