Serviços de Administração do Medidor
Esta seção descreve os serviços de administração de medidor do composto do equipamento de teste.
AddMeters
Esse serviço da Web adiciona um conjunto de medidores ao armazenamento de dados na memória. Isso não o adicionará permanentemente ao arquivo de controle.
Entrada — AddMetersInput
Parte: carga útil
Elemento: AddMetersRequest
Parâmetro |
Descrição |
---|---|
id |
O código de identificação para o medidor. |
macID |
Um endereço MAC que deve ser exclusivo no sistema. |
utility |
Uma sequência de caracteres informativa. |
serviceType |
Um dos valores válidos de ServiceType (consulte o esquema). "Elétrico" é a única opção nesse momento. |
isCommissioned |
Se ou não o medidor está em um estado ativado. |
loadActionCode |
Um dos possíveis valores de LoadActionCode usados em Conexão e Desconexão (consulte o esquema). |
outageEventType |
Um dos possíveis valores de OutageEventType usados em Verificação de Status do Dispositivo (consulte o esquema). |
executionStatus |
Um dos possíveis ExecutionStates (consulte o esquema). Esses valores controlam como o medidor responderá aos comandos. |
groupName |
O nome que vincula vários medidores em um único conjunto. |
jobExecutionStatus |
Um dos possíveis valores de Status de Execução da Tarefa (consulte o esquema). Esse atributo determina o desempenho das tarefas solicitadas. |
updateIfExisting |
Se ou não o medidor deve ser atualizado com os valores fornecidos, se ele já existir no índice. |
Comment |
Uma sequência de caracteres informativa que descreve a finalidade do medidor. |
Channels |
Uma listagem das unidades de medida suportadas por esse medidor. |
uomCode |
Um código que descreve a unidade de medida para o canal. |
uomName |
Uma sequência de caracteres curta que contém o nome da unidade de medida. |
decimals |
O número de dígitos à direita do decimal que deverá ser gerado ao ler o medidor. |
description |
Uma descrição mais longa da unidade de medida. |
Saída — AddMetersOutput
Parte: carga útil
Elemento: AddMetersResult
Se ou não cada medidor foi adicionado ao índice.
Falha — Consulte UtilityFault
RemoveMeter
Esse serviço da Web remove um medidor do armazenamento de dados na memória. Isso não o removerá permanentemente do arquivo de controle.
Entrada — RemoveMeterInput
Parte: carga útil
Elemento: RemoveMeterRequest
Parâmetro |
Descrição |
---|---|
id |
O ID para o medidor a ser removido |
Saída — RemoveMeterOutput
Parte: carga útil
Elemento: RemoveMeterResult
Se ou não o medidor foi removido do índice.
Falha — Consulte UtilityFault. Lançado quando o ID do medidor não é encontrado.
AddMeterChannel
Esse serviço da Web adiciona um novo canal a um único medidor.
Entrada — AddMeterChannelInput
Parte: carga útil
Elemento: AddMeterChannelRequest
Parâmetro |
Descrição |
---|---|
id |
O código de identificação para o medidor. |
uomCode |
Um código que descreve a unidade de medida para o canal. |
uomName |
Uma sequência de caracteres curta que contém o nome da unidade de medida. |
decimals |
O número de dígitos à direita do decimal que deverá ser gerado ao ler o medidor. |
description |
Uma descrição mais longa da unidade de medida. |
Saída — AddMeterChannelOutput
Parte: carga útil
Elemento: AddMeterChannelResult
Se ou não cada canal foi adicionado ao índice.
Falha — Consulte UtilityFault. Lançado quando o ID do medidor não é encontrado.
RemoveMeterChannel
Esse serviço da Web remove um Canal de um medidor.
Entrada — RemoveMeterChannelInput
Parte: carga útil
Elemento: RemoveMeterChannelRequest
Parâmetro |
Descrição |
---|---|
id |
O ID do medidor a ser removido. |
uomCode |
Um código que descreve a unidade de medida para o canal. |
uomName |
Uma sequência de caracteres curta que contém o nome da unidade de medida. |
Esses três parâmetros são combinados para localizar um canal único
Saída — RemoveMeterChannelOutput
Parte: carga útil
Elemento: RemoveMeterChannelResult
Se ou não o canal foi removido do medidor.
Falha — Consulte UtilityFault. Lançado quando o ID do medidor não é encontrado.
ReadScalarMeter
Esse serviço da Web gera uma leitura escalar para cada canal de um determinado medidor.
Entrada — ReadScalarMeterInput
Parte: carga útil
Elemento: ReadScalarMeterRequest
Parâmetro |
Descrição |
---|---|
id |
O ID para o medidor a ser lido |
Saída — ReadScalarMeterOutput
Parte: carga útil
Elemento: ReadScalarMeterResult
Zero ou mais leituras escalares para o medidor especificado.
Parâmetro |
Descrição |
---|---|
uomCode |
Um código que descreve a unidade de medida para o canal. |
uomName |
Uma sequência de caracteres curta que contém o nome da unidade de medida. |
decimals |
O número de dígitos à direita do decimal que deverá ser gerado ao ler o medidor. |
description |
Uma descrição mais longa da unidade de medida. |
value |
Um número aleatório que representa a leitura escalar. |