Merge pull request #291 from WillowInc/2023-11-22-solar-sample

Update solar, battery capabilities and example
WillowInc · Dec 2, 2023 · 18f5f77 · 18f5f77
2 parents 19f54e5 + 9b4fa29
commit 18f5f77
Show file tree

Hide file tree

Showing 22 changed files with 363 additions and 1 deletion.
diff --git a/...rgySensor/Electrical/Active/Export/Battery/BatteryExportActiveElectricalEnergySensor.json b/...rgySensor/Electrical/Active/Export/Battery/BatteryExportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:BatteryExportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Battery Export Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The cummulative active electrical energy being discharged from the battery system."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...rgySensor/Electrical/Active/Export/Renewable/SolarExportActiveElectricalEnergySensor.json b/...rgySensor/Electrical/Active/Export/Renewable/SolarExportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:SolarExportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Solar Export Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The cummulative active electrical energy being generated by solar photovoltaic"},
+  "extends" : [
+    "dtmi:com:willowinc:RenewableExportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...rgySensor/Electrical/Active/Export/Utility/UtilityExportActiveElectricalEnergySensor.json b/...rgySensor/Electrical/Active/Export/Utility/UtilityExportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:UtilityExportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Utility Export Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The cummulative active electrical energy being exported from the site when power is being sent to the utility grid (a negative utility import power)."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...rgySensor/Electrical/Active/Import/Battery/BatteryImportActiveElectricalEnergySensor.json b/...rgySensor/Electrical/Active/Import/Battery/BatteryImportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:BatteryImportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Battery Import Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The cummulative active electrical energy being charged by the battery system."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalImportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...or/EnergySensor/Electrical/Active/Import/Load/LoadImportActiveElectricalEnergySensor.json b/...or/EnergySensor/Electrical/Active/Import/Load/LoadImportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:LoadImportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Load Import Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The active electrical Energy being imported and consumed by the load, typically from an inverter."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalImportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...rgySensor/Electrical/Active/Import/Renewable/SolarImportActiveElectricalEnergySensor.json b/...rgySensor/Electrical/Active/Import/Renewable/SolarImportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:SolarImportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Solar Import Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The cummulative active electrical energy being consumed by solar photovoltaic"},
+  "extends" : [
+    "dtmi:com:willowinc:RenewableImportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...rgySensor/Electrical/Active/Import/Utility/UtilityImportActiveElectricalEnergySensor.json b/...rgySensor/Electrical/Active/Import/Utility/UtilityImportActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:UtilityImportActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Utility Import Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The cummulative active electrical energy being consumed by the site when power is being imported from the utility grid."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalImportActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...or/EnergySensor/Electrical/Active/Net/Battery/BatteryNetActiveElectricalEnergySensor.json b/...or/EnergySensor/Electrical/Active/Net/Battery/BatteryNetActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:BatteryNetActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Battery Net Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The net active electrical energy being consumed by the battery system which is the difference between import and export."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalNetActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...or/EnergySensor/Electrical/Active/Net/Renewable/SolarNetActiveElectricalEnergySensor.json b/...or/EnergySensor/Electrical/Active/Net/Renewable/SolarNetActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:SolarNetActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Solar Net Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The net active electrical energy being consumed by the solar pholtatic which is the difference between the import and export.)"},
+  "extends" : [
+    "dtmi:com:willowinc:RenewableNetActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...or/EnergySensor/Electrical/Active/Net/Utility/UtilityNetActiveElectricalEnergySensor.json b/...or/EnergySensor/Electrical/Active/Net/Utility/UtilityNetActiveElectricalEnergySensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:UtilityNetActiveElectricalEnergySensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Utility Net Active Electrical Energy Sensor"
+  },
+  "description": {"en": "The net active electrical energy being consumed by the site which is the difference between the Net and export."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalNetActiveElectricalEnergySensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...owerSensor/Electrical/Active/Export/Battery/BatteryExportActiveElectricalPowerSensor.json b/...owerSensor/Electrical/Active/Export/Battery/BatteryExportActiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:BatteryExportActiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Battery Export Active Electrical Power Sensor"
+  },
+  "description": {"en": "The active electrical power being discharged by a battery system"},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportActiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...owerSensor/Electrical/Active/Export/Renewable/SolarExportActiveElectricalPowerSensor.json b/...owerSensor/Electrical/Active/Export/Renewable/SolarExportActiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:SolarExportActiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Solar Export Active Electrical Power Sensor"
+  },
+  "description": {"en": "The active electrical power being generated by solar photovoltaic"},
+  "extends" : [
+    "dtmi:com:willowinc:RenewableExportActiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...nsor/PowerSensor/Electrical/Active/Import/Load/LoadImportActiveElectricalPowerSensor.json b/...nsor/PowerSensor/Electrical/Active/Import/Load/LoadImportActiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:LoadImportActiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Load Import Active Electrical Power Sensor"
+  },
+  "description": {"en": "The active electrical power being imported by the load, typically from an inverter."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalImportActiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...owerSensor/Electrical/Active/Import/Utility/UtilityImportActiveElectricalPowerSensor.json b/...owerSensor/Electrical/Active/Import/Utility/UtilityImportActiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:UtilityImportActiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Utility Import Active Electrical Power Sensor"
+  },
+  "description": {"en": "The active electrical power being imported from the utility grid. A positive value indicates net site consumption whereas a negative number indicates net site export."},
+  "extends" : [
+    "dtmi:com:willowinc:TotalImportActiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...Sensor/Electrical/Apparent/Export/Battery/BatteryExportApparentElectricalPowerSensor.json b/...Sensor/Electrical/Apparent/Export/Battery/BatteryExportApparentElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:BatteryExportApparentElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Battery Export Apparent Electrical Power Sensor"
+  },
+  "description": {"en": "The apparent electrical power being discharged by a battery system"},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportApparentElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...or/Electrical/Apparent/Export/Renewable/RenewableExportApparentElectricalPowerSensor.json b/...or/Electrical/Apparent/Export/Renewable/RenewableExportApparentElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:RenewableExportApparentElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Renewable Export Apparent Electrical Power Sensor"
+  },
+  "description": {"en": "The apparent electrical power feedback from a sensor associated with renewable export"},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportApparentElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...Sensor/Electrical/Apparent/Export/Renewable/SolarExportApparentElectricalPowerSensor.json b/...Sensor/Electrical/Apparent/Export/Renewable/SolarExportApparentElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:SolarExportApparentElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Solar Export Apparent Electrical Power Sensor"
+  },
+  "description": {"en": "The apparent electrical power being generated by solar photovoltaic"},
+  "extends" : [
+    "dtmi:com:willowinc:RenewableExportApparentElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...Sensor/Electrical/Reactive/Export/Battery/BatteryExportReactiveElectricalPowerSensor.json b/...Sensor/Electrical/Reactive/Export/Battery/BatteryExportReactiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:BatteryExportReactiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Battery Export Reactive Electrical Power Sensor"
+  },
+  "description": {"en": "The reactive electrical power being discharged by a battery system"},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportReactiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...or/Electrical/Reactive/Export/Renewable/RenewableExportReactiveElectricalPowerSensor.json b/...or/Electrical/Reactive/Export/Renewable/RenewableExportReactiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:RenewableExportReactiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Renewable Export Reactive Electrical Power Sensor"
+  },
+  "description": {"en": "The reactive electrical power feedback from a sensor associated with renewable export"},
+  "extends" : [
+    "dtmi:com:willowinc:TotalExportReactiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/...Sensor/Electrical/Reactive/Export/Renewable/SolarExportReactiveElectricalPowerSensor.json b/...Sensor/Electrical/Reactive/Export/Renewable/SolarExportReactiveElectricalPowerSensor.json
@@ -0,0 +1,17 @@
+{
+  "@id": "dtmi:com:willowinc:SolarExportReactiveElectricalPowerSensor;1",
+  "@type": "Interface",
+  "displayName": {
+    "en": "Solar Export Reactive Electrical Power Sensor"
+  },
+  "description": {"en": "The reactive electrical power being generated by solar photovoltaic"},
+  "extends" : [
+    "dtmi:com:willowinc:RenewableExportReactiveElectricalPowerSensor;1"
+  ],
+  "contents": [
+
+  ],
+  "@context": [
+    "dtmi:dtdl:context;3"
+  ]
+}
diff --git a/Samples/04-Electrical.md b/Samples/04-Electrical.md
@@ -16,4 +16,26 @@ Electrical systems have common equipment found various sites but vary widely in
 
 4. In this example, we show one of those 1-Pole Electrical Circuits feeding a Fan Powered Box and Exhaust Fan.
 
-5. In many instances, the exact circuit assignment of an equipment may be unknown but the panel from which it is fed is known based on the electrical design. In this example, we show a Luminaire which is fed by an Electrical Panelboard.
+5. In many instances, the exact circuit assignment of an equipment may be unknown but the panel from which it is fed is known based on the electrical design. In this example, we show a Luminaire which is fed by an Electrical Panelboard.
+
+## Solar and Battery
+
+![Electrical-Example2](Images/Electrical-Example2.png)
+
+This electrical active efficiency scenario depicts a common setup where a Solar Inverter is the central hub for managing incoming power generation from a PV Array, incoming/outgoing power to a battery system, and then importing/exporting power from the grid to send to downstream loads.
+
+1. The Photovoltaic Array (PV Array) is a collection which includes many individual PV Panels. The quantity and layout of individual panels may not always be known so having the PV Panel twins is considered optional. When a solar system provides a trend of the DC power generation from the PV Array, we add an Active Electrical Power Sensor capability to the PV Array.
+
+2. An “is fed by” relationship from the Solar Inverter to the PV Array indicates that positive power generation flows from the PV Array to the Solar Inverter. Note that the substance property on the relationship is defined as DCElec. 
+
+3. The Solar Inverter also receives ACElec power from the utility grid. In this example, we have a Switchboard which serves as the site utility service, but this could be another type of Electrical Distribution Equipment.
+
+4. The Solar Inverter then sends power to the downstream loads at the site. This example shows an Electrical Panelboard, but this could be another type of Electrical Distribution Equipment. Notice the direction of the “is fed by” relationship. This indicates that a positive power indicates flow from the Solar Inverter to the Electrical Panelboard.
+
+5. Three capabilities for Solar Export Active Electrical Power Sensor, Solar Import Active Electrical Energy Sensor, and Solar Export Active Electrical Energy Sensor indicate the AC power and energy that the inverter has generated from the DC power coming from the PV Array. The solar export power and export energy are commonly reported as the solar power and energy production at a site. The solar import energy is less common but indicates energy consumed by the PV array when there is no production.
+
+6. Similarly, three capabilities for the Battery system indicate the power and energy that the battery has discharged. A positive power value indicates the battery discharging while a negative value indicates the battery charging. The export energy accumulates the energy while the battery is discharging while the import energy accumulates the energy while the battery is charging.
+
+7. The Utility import power, import energy, and export energy indicate the AC power and energy that is coming from the grid. In this case, they indicate what is being received by the Switchboard. If the power is positive, that indicates an import of power from the grid. If it is negative, that indicates an export of power when an excess of power is being produced onsite and being sent to the grid. The import energy accumulates energy being consumed by the site while the export energy accumulates energy being exported to the grid.
+
+8. The Load import power and import energy indicate the AC power and energy that is being consumed by the loads. In this case, they indicate what is being sent to the Electrical Panelboard. These values must be positive since loads can only consume energy.
diff --git a/Samples/Images/Electrical-Example2.png b/Samples/Images/Electrical-Example2.png