BaseData Unified Schema
Whatever vendor the data comes from, you get the same fields, units, and precision. Parse 50+ fields once — new vendors require no changes to your code.
Device metadata
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| deviceType | string | — | Device type (inverter / camera) | inverter | Universal |
| CollectorSN | string | — | Collector serial number | C1234567890 | Universal |
| InverterSN | string | — | Inverter serial number (vendor-native) | INV20250526001 | apsystemsgoodwehikvisionhuaweikehua+8 |
| DBSource | integer | — | Data source identifier | 1 | Universal |
| DataSources | string | — | Source vendor (matches /protocols matrix) | goodwe | Universal |
| Timezone | string | — | Timezone, e.g. GMT+8 | GMT+8 | Universal |
| Datetime | long | s | Sample timestamp (Unix seconds) | 1748246400 | Universal |
| currentDateTime | string | — | Human-readable sample time | 2026-05-26 12:00:00 | Universal |
State & alarms
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| Alert | string | — | Alert flag | 0 | Universal |
| AlertType | string | — | Alert type | null | Universal |
| State | string | — | Inverter state code | 1 | Universal |
| StateDesc | string | — | State description | 正常发电 | Universal |
| InverterRunningStateTwo | integer | — | Secondary running state code | 0 | Universal |
| AlertArray | array | — | Alarm array (passed through as-is) | [] | apsystemshikvisionhuaweikehuamaitian+7 |
| WarnArray | array | — | Warning array (passed through as-is) | [] | Universal |
| StatusArray | array | — | Status array (passed through as-is) | [] | Universal |
Energy
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| EDay | double | kWh | Daily energy production | 35.6 | apsystemsgoodwehuaweikehuamaitian+7 |
| ETotal | double | kWh | Platform cumulative total energy | 128500.8 | apsystemsgoodwehuaweikehuamaitian+7 |
| EAccumulate | double | kWh | Accumulated energy | 128500.8 | Universal |
| HTotal | double | h | Cumulative generation hours | 18650.0 | Universal |
Meter
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| ElectricMeterPower | double | kW | Meter power | 5.2 | Universal |
| ElectricMeterTotalPurchase | double | kWh | Total purchased energy | 1200.5 | Universal |
| ElectricMeterTotalSales | double | kWh | Total sold energy | 98000.3 | Universal |
Power
AC (three-phase)
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| FrqAC | double | Hz | Frequency | 50.01 | goodwehuaweikehuamaitiansofar+4 |
| FrqAC1 | double | Hz | Frequency (phase 1) | 50.01 | Universal |
| FrqAC2 | double | Hz | Frequency (phase 2) | 50.0 | Universal |
| FrqAC3 | double | Hz | Frequency (phase 3) | 50.02 | Universal |
| IAC1 | double | A | AC current (phase 1) | 12.6 | goodwehuaweimaitiansungrowyuexiang |
| IAC2 | double | A | AC current (phase 2) | 12.4 | goodwemaitianyuexiang |
| IAC3 | double | A | AC current (phase 3) | 12.5 | goodwemaitianyuexiang |
| UAC1 | double | V | AC voltage (phase 1) | 231.5 | goodwehuaweimaitiansungrowxinyaoyun+1 |
| UAC2 | double | V | AC voltage (phase 2) | 230.8 | goodwemaitianxinyaoyunyuexiang |
| UAC3 | double | V | AC voltage (phase 3) | 232.1 | goodwemaitianxinyaoyunyuexiang |
DC / PV strings
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| IPV1 | double | A | PV string DC current 1 | 9.8 | Universal |
| IPV2 | double | A | PV string DC current 2 | 9.7 | Universal |
| IPV3 | double | A | PV string DC current 3 | 9.6 | Universal |
| IPV4 | double | A | PV string DC current 4 | 9.5 | Universal |
| UPV1 | double | V | PV string DC voltage 1 | 620.5 | Universal |
| UPV2 | double | V | PV string DC voltage 2 | 618.3 | Universal |
| UPV3 | double | V | PV string DC voltage 3 | 619.1 | Universal |
| UPV4 | double | V | PV string DC voltage 4 | 617.8 | Universal |
| IDC1 | double | A | DC string current 1 | 9.8 | maitianxinyaoyun |
| IDC2 | double | A | DC string current 2 | 9.7 | xinyaoyun |
| IDC3 | double | A | DC string current 3 | 9.6 | xinyaoyun |
| IDC4 | double | A | DC string current 4 | 9.5 | Universal |
MPPT
| Field | Type | Unit | Description | Example | Mapped vendors |
|---|---|---|---|---|---|
| I_MPPT_1 | double | A | MPPT current 1 | 9.8 | Universal |
| I_MPPT_2 | double | A | MPPT current 2 | 9.7 | Universal |
| U_MPPT_1 | double | V | MPPT voltage 1 | 620.5 | Universal |
| U_MPPT_2 | double | V | MPPT voltage 2 | 618.3 | Universal |
Misc
Want a specific vendor's field mapping?
How each vendor's API fields map to BaseData is documented in the protocol matrix. Contact us for integration support.