Transformer Real-time Interval Streaming
This API delivers real-time transformer loading and voltage data streams to a customer's business system (such as ADMS). For more information about accessing streaming data products, see Streaming data products.
-
Example use cases. Receiving a continuous data stream within an existing utility business system such as ADMS or DERMS for enhanced visibility into distribution network operations.
Payload example
{
"TransformerMonitoringRealTimeData": [
{
"TransformerId": "TX2",
"IntervalEndTime": "2024-11-05T08:11:00Z",
"ReportingIntervalSeconds": 60,
"PhaseValues": [
{
"AbsolutePhase": "A",
"LoadValues": {
"TotalKw": 0.018073,
"TotalKvar": -0.02852866,
"TotalKva": 0.033771556,
"TotalNetDeliveredKw": 0.018073,
"TotalNetReceivedKw": 0,
"TotalNetDeliveredKvar": 0,
"TotalNetReceivedKvar": 0.02852866,
"TotalNetDeliveredKva": 0.018073,
"TotalNetReceivedKva": 0.02852866,
"PercentPhaseCapacity": 0,
"TotalReportingMeters": 2,
"NumberExpectedMeters": 4,
"DataQuality": 0
},
"VoltageValues": {
"MaxMax1SecVoltage": 0.9441,
"MinMin1SecVoltage": 0.9391,
"AvgAvg1SecVoltage": 0.9418,
"StdAvg1SecVoltage": 0.0018,
"NominalVoltage": 240,
"TotalReportingMeters": 2,
"NumberExpectedMeters": 4,
"DataQuality": 0
}
},
{
"AbsolutePhase": "Total",
"LoadValues": {
"TotalKw": 0.018073,
"TotalKvar": -0.02852866,
"TotalKva": 0.033771556,
"TotalNetDeliveredKw": 0.018073,
"TotalNetReceivedKw": 0,
"TotalNetDeliveredKvar": 0,
"TotalNetReceivedKvar": 0.02852866,
"TotalNetDeliveredKva": 0.018073,
"TotalNetReceivedKva": 0.02852866,
"PercentPhaseCapacity": 0,
"TotalReportingMeters": 2,
"NumberExpectedMeters": 8,
"DataQuality": 0
},
"VoltageValues": {
"MaxMax1SecVoltage": 0.9441,
"MinMin1SecVoltage": 0.9391,
"AvgAvg1SecVoltage": 0.9418,
"StdAvg1SecVoltage": 0.0018,
"NominalVoltage": 240,
"TotalReportingMeters": 2,
"NumberExpectedMeters": 8,
"DataQuality": 0
}
}
]
}
]
}Payload data values
|
Order |
Name |
Definition |
Data type |
Units |
Range |
Format |
Nullable |
Origination |
|---|---|---|---|---|---|---|---|---|
|
1 |
TransformerId |
Unique identifier of the transformer device at the time the data was collected. |
String |
N/A |
N/A |
N/A |
? |
GIS |
|
2 |
IntervalEndTime |
Datetime of the end of the measurement interval period. |
Datetime |
N/A |
N/A |
YYYY-MM-DDTHH:MM:SSZ |
No |
App Platform |
|
3 |
ReportingIntervalSeconds |
Count of seconds the measurement interval covers |
Integer |
N/A |
>=0 |
N |
Yes |
Edge app |
|
4 |
AbsolutePhase |
The identified phase for a transformer's connection referenced to the utility's reference phase. Possible values = A, B, C, AB, BC, CA, -A, -B, -C, -AB, -BC, -CA, unknown |
String |
N/A |
possible values = A, B, C, AB, BC, CA, -A, -B, -C, -AB, -BC, -CA, unknown |
N or N/N/N |
Yes. Null if Txfmr not included in Recommendation Type |
|
|
5 |
TotalKw |
Sum of minute-level Transformer kW values where Transformer kW is positive |
Float |
kW |
N/A |
N.NN |
Yes |
Edge app |
|
6 |
TotalKvar |
Sum of minute-level Transformer kVAR where Transformer KVAR is positive |
Float |
kVARh |
N/A |
N.NN |
Yes |
Edge app |
|
7 |
TotalKva |
Sum of minute-level Transformer kVA where Transformer KVA is positive |
Float |
kVAh |
N/A |
N.NN |
Yes |
Edge app |
|
8 |
TotalNetDeliveredKw |
Sum of minute-level Transformer kW values where Transformer kW is positive |
Float |
kW |
N/A |
N.NN |
Yes |
Edge app |
|
9 |
TotalNetReceivedKw |
Sum of minute-level Transformer kW values where Transformer kW is negative |
Float |
kW |
N/A |
N.NN |
Yes |
Edge app |
|
10 |
TotalNetDeliveredKvar |
Sum of minute-level Transformer kVAR where Transformer KVAR is positive |
Float |
kVAr |
N/A |
N.NN |
Yes |
Edge app |
|
11 |
TotalNetReceivedKvar |
Sum of minute-level Transformer kVAR where Transformer KVAR is negative |
Float |
kVAr |
N/A |
N.NN |
Yes |
Edge app |
|
12 |
TotalNetDeliveredKva |
Sum of minute-level Transformer kVA where Transformer KVA is positive |
Float |
kVA |
N/A |
N.NN |
Yes |
Edge app |
|
13 |
TotalNetReceivedKva |
Sum of minute-level Transformer kVA where Transformer KVA is negative |
Float |
kVA |
N/A |
N.NN |
Yes |
Edge app |
|
14 |
PercentPhaseCapacity |
Percent of transformer phase capacity |
Float |
% |
>=0 |
N.NN |
Yes |
Edge app |
|
15 |
TotalReportingMeters |
The total number of meters currently reporting as being fed by this transformer. |
Integer |
N/A |
>=0 |
N |
Yes |
Edge app |
|
16 |
NumberExpectedMeters |
The total number of meters expected as being fed by this transformer. |
Integer |
N/A |
>=0 |
N |
Yes |
Edge app |
|
17 |
DataQuality |
A numeric value indicating the quality of the data. Quality rules:
|
Float |
N/A |
|
|
|
|
|
18 |
MaxMax1SecVoltage |
Maximum 1 Second Individual Meter Voltage |
Float |
Volts |
N/A |
N.NN |
Yes |
Edge app |
|
19 |
MinMin1SecVoltage |
Minimum 1 Second Individual Meter Voltage |
Float |
Volts |
N/A |
N.NN |
Yes |
Edge app |
|
20 |
AvgAvg1SecVoltage |
Standard Deviation 1 Second Average Transformer Voltage |
Float |
Volts |
N/A |
N.NN |
Yes |
Edge app |
|
21 |
StdAvg1SecVoltage |
Standard Deviation 1 Second Average Transformer Voltage |
Float |
Volts |
N/A |
N.NN |
Yes |
Edge app |
|
22 |
NominalVoltage |
The mode of individual meter nominal voltages. |
Integer |
Volts |
N/A |
NNN |
Yes |
Edge app |
Payload schema
{
"type": "record",
"namespace": "Itron.Shared.Contracts.DistributedIntelligence.ActiveTransformerMonitoring",
"name": "TransformerMonitoringRealTimeDataCollection",
"doc": "Collection of Real-time Transformer Load and Voltage Monitoring Data published to DPSS.",
"fields": [
{
"doc": "Collection of real-time Transformer data.",
"name": "TransformerMonitoringRealTimeData",
"type": [
"null",
{
"type": "array",
"items": {
"type": "record",
"name": "TransformerMonitoringRealTimeData",
"doc": "Real-time Load and Voltage data for a Transformer.",
"fields": [
{
"doc": "A unique identifier of the transformer.",
"name": "TransformerId",
"type": "string"
},
{
"doc": "Reporting interval End Time.",
"name": "IntervalEndTime",
"type": {
"type": "long",
"logicalType": "timestamp-millis"
}
},
{
"doc": "Reporting interval in seconds.",
"name": "ReportingIntervalSeconds",
"type": "int"
},
{
"doc": "Collection of Individual Transformer Phases.",
"name": "PhaseValues",
"type": [
"null",
{
"type": "array",
"items": {
"type": "record",
"name": "PhaseData",
"doc": "Real-time Load and Voltage Data for Individual Transformer Phases.",
"fields": [
{
"doc": "Absolute Phase.",
"name": "AbsolutePhase",
"type": "string"
},
{
"doc": "Real-time Transformer Load Data.",
"name": "LoadValues",
"type": [
"null",
{
"type": "record",
"name": "LoadData",
"doc": "Real-time Transformer Load Data.",
"fields": [
{
"doc": "Total transformer kW (signed)",
"name": "TotalKw",
"type": [ "null", "float" ]
},
{
"doc": "Total transformer kVAR (signed)",
"name": "TotalKvar",
"type": [ "null", "float" ]
},
{
"doc": "Total transformer kVA (signed)",
"name": "TotalKva",
"type": [ "null", "float" ]
},
{
"doc": "Total net delivered kW behind transformer",
"name": "TotalNetDeliveredKw",
"type": [ "null", "float" ]
},
{
"doc": "Total net received kW behind transformer",
"name": "TotalNetReceivedKw",
"type": [ "null", "float" ]
},
{
"doc": "Total net delivered kVAR behind transformer",
"name": "TotalNetDeliveredKvar",
"type": [ "null", "float" ]
},
{
"doc": "Total net received kVAR behind transformer",
"name": "TotalNetReceivedKvar",
"type": [ "null", "float" ]
},
{
"doc": "Total net delivered kVA behind transformer",
"name": "TotalNetDeliveredKva",
"type": [ "null", "float" ]
},
{
"doc": "Total net received kVA behind transformer",
"name": "TotalNetReceivedKva",
"type": [ "null", "float" ]
},
{
"doc": "Percent of Transformer Phase Capacity",
"name": "PercentPhaseCapacity",
"type": [ "null", "int" ]
},
{
"doc": "Total Number of Meters reporting for this period",
"name": "TotalReportingMeters",
"type": [ "null", "int" ]
},
{
"doc": "Total Number of Expected Meters reporting for this period",
"name": "NumberExpectedMeters",
"type": [ "null", "int" ]
},
{
"doc": "Transformer Load Data Quality Indicator",
"name": "DataQuality",
"type": [ "null", "float" ]
}
]
}
]
},
{
"doc": "Real-time Transformer Voltage Data.",
"name": "VoltageValues",
"type": [
"null",
{
"type": "record",
"name": "VoltageData",
"doc": "Real-time Transformer Voltage Data.",
"fields": [
{
"doc": "Transformer Maximum of Max 1 Second Voltage from individual meter values",
"name": "MaxMax1SecVoltage",
"type": [ "null", "float" ]
},
{
"doc": "Transformer Minimum of Min 1 Second Voltage from individual meter values",
"name": "MinMin1SecVoltage",
"type": [ "null", "float" ]
},
{
"doc": "Transformer Avg of Avg 1 Second Voltage from individual meter values",
"name": "AvgAvg1SecVoltage",
"type": [ "null", "float" ]
},
{
"doc": "Transformer Standard Deviation of Avg 1 Second Voltage from individual meter values",
"name": "StdAvg1SecVoltage",
"type": [ "null", "float" ]
},
{
"doc": "Mode of meter nominal voltages",
"name": "NominalVoltage",
"type": [ "null", "float" ]
},
{
"doc": "Total Number of Meters reporting for this period",
"name": "TotalReportingMeters",
"type": [ "null", "int" ]
},
{
"doc": "Total Number of Expected Meters reporting for this period",
"name": "NumberExpectedMeters",
"type": [ "null", "int" ]
},
{
"doc": "Transformer Voltage Data Quality Indicator",
"name": "DataQuality",
"type": [ "null", "float" ]
}
]
}
]
}
]
}
}
]
}
]
}
}
]
}
]
}