schema-aggregator

EnergyResourceGenerator v1.0

Schema ID: https://schema.nfh.global/EnergyResourceGenerator/v1.0 CIM: cim:GeneratingUnit and subtypes (IEC 61970-301/302) Status: Current


Overview

EnergyResourceGenerator is the typed attribute schema for generation DER energy resources. It covers solar PV, wind, hydro, biogas, CHP, and fuel cell assets.

This schema is one of seven composable EnergyResource kinds in ElectricityCredential/v1.2.


Files

File Description
attributes.yaml OpenAPI 3.1.1 schema — EnergyResourceGenerator and its Attributes object
context.jsonld JSON-LD 1.1 context mapping terms to semantic IRIs
vocab.jsonld RDF vocabulary — class and property definitions with CIM seeAlso links

Type Discriminator

type value CIM class Notes
SOLAR_PV cim:PhotovoltaicUnit Preferred value
SOLAR cim:PhotovoltaicUnit Deprecated alias for SOLAR_PV
WIND cim:WindGeneratingUnit  
HYDRO cim:HydroGeneratingUnit  
BIOGAS cim:ThermalGeneratingUnit  
CHP cim:ThermalGeneratingUnit Combined heat and power
FUEL_CELL IEC 62933-2 fuel cell unit  

Attributes

Common attributes (EnergyResourceCommonAttributes — all kinds)

Field Type CIM Description
make string Manufacturer
model string Model number
ratedPowerKw number ≥ 0 GeneratingUnit.maxOperatingP Rated peak power, kW
maxExportKw number ≥ 0 Maximum grid export capacity, kW
maxImportKw number ≥ 0 Maximum grid import capacity, kW
telemetryProvider string Telemetry vendor / API identifier
commissioningDate string (ISO 8601 date) Date commissioned
location object {geo: GeoJSONGeometry, address: Address}

Generator-specific attributes

Field Type CIM Description
nominalPowerKw number ≥ 0 GeneratingUnit.nominalP Nameplate nominal power, kW
efficiency number 0–100 Conversion efficiency %, esp. for FUEL_CELL/CHP

Minimal valid example

{
  "id": "did:web:bescom.karnataka.gov.in:assets:solar:SOL-001",
  "type": "SOLAR_PV",
  "attributes": {
    "make": "Waaree",
    "model": "WS-440",
    "ratedPowerKw": 5,
    "nominalPowerKw": 5,
    "commissioningDate": "2023-06-15T00:00:00+05:30",
    "location": {"geo": {"type": "Point", "coordinates": [77.5946, 12.9716]}},
    "telemetryProvider": "SolarEdge"
  },
  "parentResources": ["did:web:bescom.karnataka.gov.in:assets:meter:MET-001"]
}