Servicios de administración de contadores
En esta sección, se describen los servicios de administración de contadores del compuesto del arnés de pruebas.
AddMeters
Este servicio web añade un juego de contadores al almacén de datos en memoria. No lo añadirá de forma permanente al fichero de control.
Entrada — AddMetersInput
Parte: payload
Elemento: AddMetersRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El código de identificación para el contador. |
|
macID |
Una dirección de MAC que debe ser única en el sistema. |
|
utility |
Una cadena informativa. |
|
serviceType |
Uno de los valores válidos de ServiceType (ver esquema). "Eléctrico" es la única opción en este momento. |
|
isCommissioned |
Si el contador está o no en estado de comunicación establecida. |
|
loadActionCode |
Uno de los posibles valores de LoadActionCode utilizados en conexión y desconexión (ver esquema). |
|
outageEventType |
Uno de los posibles valores de OutageEventType utilizados en comprobación de estado de dispositivo (ver esquema). |
|
executionStatus |
Uno de los posibles ExecutionStates (ver esquema). Estos valores controlan el modo en que el contador responderá a los comandos. |
|
groupName |
El nombre que enlaza varios contadores juntos en un juego. |
|
jobExecutionStatus |
Uno de los posibles valores del estado de ejecución de tarea (ver esquema). Este atributo determina cómo se realizan las tareas solicitadas. |
|
updateIfExisting |
Si se actualiza o no el contador con los valores indicados si ya existe en el índice. |
|
Comment |
Cadena informativa que describe el objetivo del contador. |
|
Channels |
Lista de unidades de medida que soporta este contador. |
|
uomCode |
Código que describe la unidad de medida para el canal. |
|
uomName |
Cadena corta que contiene el nombre de la unidad de medida. |
|
decimals |
Número de dígitos a la derecha del decimal que deben generarse al leer el contador. |
|
description |
Descripción más larga de la unidad de medida. |
Salida — AddMetersOutput
Parte: payload
Elemento: AddMetersResult
Si se ha añadido o no cada contador al índice.
Fallo — Consulte UtilityFault
RemoveMeter
Este servicio web retira un contador del almacén de datos en memoria. No lo eliminará de forma permanente del fichero de control.
Entrada — RemoveMeterInput
Parte: payload
Elemento: RemoveMeterRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El ID del contador que se va a dar de baja. |
Salida — RemoveMeterOutput
Parte: payload
Elemento: RemoveMeterResult
Si se ha eliminado o no el contador del índice.
Fallo — Consulte UtilityFault. Se emite cuando no se encuentra el ID de contador.
AddMeterChannel
Este servicio web añade un nuevo canal a un solo contador.
Entrada — AddMeterChannelInput
Parte: payload
Elemento: AddMeterChannelRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El código de identificación para el contador. |
|
uomCode |
Código que describe la unidad de medida para el canal. |
|
uomName |
Cadena corta que contiene el nombre de la unidad de medida. |
|
decimals |
Número de dígitos a la derecha del decimal que deben generarse al leer el contador. |
|
description |
Descripción más larga de la unidad de medida. |
Salida — AddMeterChannelOutput
Parte: payload
Elemento: AddMeterChannelResult
Si se ha añadido o no el canal al índice.
Fallo — Consulte UtilityFault. Se emite cuando no se encuentra el ID de contador.
RemoveMeterChannel
Este servicio web elimina un canal de un contador.
Entrada — RemoveMeterChannelInput
Parte: payload
Elemento: RemoveMeterChannelRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
El ID del contador que se va a dar de baja. |
|
uomCode |
Código que describe la unidad de medida para el canal. |
|
uomName |
Cadena corta que contiene el nombre de la unidad de medida. |
Estos tres parámetros se combinan para localizar un canal único.
Salida — RemoveMeterChannelOutput
Parte: payload
Elemento: RemoveMeterChannelResult
Si se ha eliminado o no el canal del contador.
Fallo — Consulte UtilityFault. Se emite cuando no se encuentra el ID de contador.
ReadScalarMeter
Este servicio web genera una lectura escalar para cada canal de un contador concreto.
Entrada — ReadScalarMeterInput
Parte: payload
Elemento: ReadScalarMeterRequest
|
Parámetro |
Descripción |
|---|---|
|
id |
EL ID del contador que se va a leer. |
Salida — ReadScalarMeterOutput
Parte: payload
Elemento: ReadScalarMeterResult
Cero o más lecturas escalares para el contador en cuestión.
|
Parámetro |
Descripción |
|---|---|
|
uomCode |
Código que describe la unidad de medida para el canal. |
|
uomName |
Cadena corta que contiene el nombre de la unidad de medida. |
|
decimals |
Número de dígitos a la derecha del decimal que deben generarse al leer el contador. |
|
description |
Descripción más larga de la unidad de medida. |
|
value |
Un número aleatorio que representa la lectura escalar. |