1. Telemetry & Data Acquisition
FoxCloud OpenAPI
Vpp Flow
  • Vpp Flow
  • Full API Reference
  • What's New & Milestones
  • Getting Started
    • 1. Overview & Integration Scope
    • 2. Environments & Prerequisites
  • End-User Enrollment & OAuth Flow
    • 0. Introduction
    • 1. The User Authorization Journey
    • 2. OAuth Token Operating Model
    • 3. Implementation Guide
  • API Technical Specifications
    • 1. Universal Request Rules
    • 2. Rate Limiting Strategy
    • 3. Response Structure
    • 4. Error Code Reference
  • Telemetry & Data Acquisition
    • 1. Data Pipeline & Scaling Strategy
    • 2. Telemetry Data Query (Real-time)
    • 4. Telemetry Variable Dictionary
    • 5. System Performance & SLA
    • 3. Device Configuration & Settings: Pre-Dispatch State Awareness
  • Control Commands & Dispatch
    • 1. Core Dispatch Architecture: Scheduler V3
    • 2. Scheduler V3 Operations
    • 3. Real-time Device Settings
    • 4. Strategic Roadmap: Scaling for Massive Fleets
  • FAQ
    • Troubleshooting Quick Guide
  1. Telemetry & Data Acquisition

4. Telemetry Variable Dictionary

The table presented below offers a comprehensive overview of the variables that can be accessed through the API. It is important to note that the availability of these variables may differ depending on the specific device being utilized. Therefore, the variables listed in the table are subject to change based on the device in use.

5.1 Photovoltaic (PV)#

Metrics related to solar panel input and string-level diagnostics.
Variable KeyUnitBusiness MeaningESUGrid-Tied
pvPowerkWTotal PV input power✓✓
todayYieldkWEnergy generated today✓✓
PVEnergyTotalkWhTotal lifetime PV generation (DC side)✓✓
pv1Volt - pv24VoltVVoltage of individual PV string✓✓
pv1Current - pv24CurrentACurrent of individual PV string✓✓
pv1Power - pv24PowerkWPower of individual PV string✓✓

5.2 Grid Interaction & Utility#

Data points for monitoring grid connection, power exchange, and quality.
Variable KeyUnitBusiness MeaningESUGrid-Tied
RVolt - TVoltVGrid phase voltage (R/S/T)✓✓
RCurrent - TCurrentAGrid phase current (R/S/T)✓✓
RFreq - TFreqHzGrid phase frequency (R/S/T)✓✓
RPower - TPowerkWGrid phase active power (R/S/T)✓✓
feedinPowerkWActive power exported to the grid✓✓
gridConsumptionPowerkWActive power drawn from the grid✓✓
generationkWhCumulative AC output energy (inverter side)✓✓
gridConsumption - gridConsumption3kWhCumulative grid electricity consumption (Meter 1-3)✓✓
feedin - feedin2kWhCumulative feed-in energy (Meter 1-2)✓✓
meter3ExportkWhCumulative feed-in energy (Meter 3)✓✓
meter3ImportkWhCumulative grid import energy (Meter 3)✓✓
ReactivePowerkVarReactive power✓✓
PowerFactor-Power factor✓✓

5.3 Local Loads & Consumption#

Metrics for monitoring internal power consumption within the household or site.
Variable KeyUnitBusiness MeaningESUGrid-Tied
loadsPowerkWTotal load power consumption✓✓
loadsPowerR - loadsPowerTkWLoad power per phase (R/S/T)✓✓
loadskWhCumulative load energy consumption✓✓

5.4 Inverter Status & Health#

System-level metrics for monitoring inverter operation state and thermal conditions.
Variable KeyUnitBusiness MeaningESUGrid-Tied
invTemperation℃Inverter internal temperature✓✓
ambientTemperation℃Ambient temperature✓✓
boostTemperation℃Boost circuit temperature✓✓
chargeTemperature℃Charging module temperature✓✓
dspTemperature℃DSP chip temperature✓✓
generationPowerkWTotal AC output power✓✓
runningState-Operational state code (e.g., on-grid, fault)✓✓
currentFault-Current active fault code✓✓
currentFaultCount-Count of current faults✓✓
Enum Reference: runningState
160: Self-test
161: Waiting
162: Checking
163: On-grid (Normal operation)
164: Off-grid
165: Fault
166: Permanent Fault
167: Standby
168: Upgrading
169: FCT (Factory Test)
170: Illegal

5.5 Battery Management System (BMS)#

Critical variables for monitoring energy storage status, health, and power flow.
Variable KeyUnitBusiness MeaningESUGrid-Tied
SoC%State of Charge (Current battery level)✓✗
SOH%State of Health (Battery degradation)✓✗
batVoltVBattery voltage✓✗
batCurrentABattery current✓✗
invBatVoltVInverter-side battery voltage✓✓
invBatCurrentAInverter-side battery current✓✗
invBatPowerkWInverter-side battery power (±)✓✗
batChargePowerkWBattery charge power✓✗
batDischargePowerkWBattery discharge power✓✗
batTemperature℃Battery temperature✓✗
maxChargeCurrentAMaximum allowed charge current✓✗
maxDischargeCurrentAMaximum allowed discharge current✓✗
remainCapacityAhRemaining capacity✓✗
ResidualEnergykWhRemaining energy in battery✓✗
batCycleCount-Number of charge/discharge cycles✓✗
totalDischargeKWkWhTotal discharge energy (lifetime)✓✗
chargeEnergyToTalkWhTotal charge energy (lifetime)✓✗
dischargeEnergyToTalkWhTotal discharge energy (lifetime)✓✗
batChargeEnergyToTalkWhTotal charge energy (Battery Side) (lifetime)✓✗
batDischargeEnergyToTalkWhTotal discharge energy (Battery Side) (lifetime)✓✗
energyThroughputkWhTotal energy cycled (lifetime)✓✗
EventNumber-Adverse event count✓✗

5.6 External Meters#

Data from external CT meters for granular energy flow monitoring.
Variable KeyUnitBusiness MeaningESUGrid-Tied
meterPower - meterPower2kWTotal active power (Meter 1/2)✓✓
meterPowerR - meterPowerTkWPhase-specific active power (Meter 1)✓✓
meter3Status-Operational status of Meter 3✓✓

5.7 EPS (Emergency Power Supply)#

Metrics for monitoring backup power circuits during grid outages.
Variable KeyUnitBusiness MeaningESUGrid-Tied
epsPowerkWEPS total output power✓✗
epsVoltR - epsVoltTVEPS phase voltage✓✗
epsCurrentR - epsCurrentTAEPS phase current✓✗
epsPowerR - epsPowerTkWEPS phase power✓✗

5.8 Heat Pump (Kafka Only)#

Hardware, status, and operational metrics specific to Heat Pump systems.
Variable KeyBusiness MeaningCategory
indoorDeviceTypeModel NameHeat PumpHardware Identification (Static Data)
capacityPower ClassHeat PumpHardware Identification (Static Data)
snOutdoor Unit S/NHeat PumpHardware Identification (Static Data)
indoorSNIndoor Unit S/N & Gateway S/NHeat PumpHardware Identification (Static Data)
systemFunctionDomestic Hot Water installedDevice Details(Semi Static Data)
Z1ZoneSwitchHeating CircuitsDevice Details(Semi Static Data)
Z2ZoneSwitchHeating CircuitsDevice Details(Semi Static Data)
Z3ZoneSwitchHeating CircuitsDevice Details(Semi Static Data)
Z1ZoneEmitterTypeHeating Circuit TypeDevice Details(Semi Static Data)
Z1ZoneMaxWaterTempHeating Circuit TypeDevice Details(Semi Static Data)
Z2ZoneEmitterTypeHeating Circuit TypeDevice Details(Semi Static Data)
Z2ZoneMaxWaterTempHeating Circuit TypeDevice Details(Semi Static Data)
Z3ZoneEmitterTypeHeating Circuit TypeDevice Details(Semi Static Data)
Z3ZoneMaxWaterTempHeating Circuit TypeDevice Details(Semi Static Data)
currentRunModeSystem StatusStatus (Dynamicon Change)
heatPumpConnectivityStatusConnectivity StatusStatus (Dynamicon Change)
sgReadyEnableSmart Grid StatusStatus (Dynamicon Change)
sgReadyMode§14a statusStatus (Dynamicon Change)
sgTclmin§14a dimming targetStatus (Dynamicon Change)
sgThtmax§14a dimming targetStatus (Dynamicon Change)
sgTwmax§14a dimming targetStatus (Dynamicon Change)
outdoorAirTempOutdoor temperatureused for weather curve?Metrics(Dynamic Time series)
dcWaterPumpOFFFlowRateHydraulics station flow speedMetrics(Dynamic Time series)
outletWaterTempHydraulic station flow temperatureMetrics(Dynamic Time series)
returnWaterTempHydraulic station return temperatureMetrics(Dynamic Time series)
Z1ZoneTempFlow temperature of each heating circuitMetrics(Dynamic Time series)
Z2ZoneTempFlow temperature of each heating circuitMetrics(Dynamic Time series)
Z3ZoneTempFlow temperature of each heating circuitMetrics(Dynamic Time series)
dcFanOFFSpeedVentilator RPMMetrics(Dynamic Time series)
dcFanMaxSpeedVentilator max RPMMetrics(Dynamic Time series)
bufferTankTempBuffer tank temperatureMetrics(Dynamic Time series)
SolenoidThree-wayValveStatus3-way-valve positionMetrics(Dynamic Time series)
flowPressureTechnical Water PressureMetrics(Dynamic Time series)
waterTankTempDomestic hot water actual temperatureMetrics(Dynamic Time series)
heatingSetTempDomestic hot water target temperatureMetrics(Dynamic Time series)
heatingRealTimeConsumptionPower consumption heatingMetrics(Dynamic Time series)
dhwRealTimeConsumptionPower consumption heating domestic hot waterMetrics(Dynamic Time series)
totalIndoorConsumptionPower consumption heating rod heatingMetrics(Dynamic Time series)
heatingRealTimeProductionGenerated heat heatingMetrics(Dynamic Time series)
dhwRealTimeProductionGenerated heat domestic hot waterMetrics(Dynamic Time series)
currentFaultError CodeErrors & Warnings
Modified at 2026-09-22 05:58:47
Previous
2. Telemetry Data Query (Real-time)
Next
5. System Performance & SLA
Built with