Skip to content

Commit

Permalink
[e3dc] documentation fix (openhab#10337)
Browse files Browse the repository at this point in the history 
* Fixed mixed up description in thing.xmls, readme.de and translation

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>

* spotless run

Signed-off-by: Bernd Weymann <bernd.weymann@gmail.com>
  • Loading branch information
@weymann @thinkingstone
weymann authored and thinkingstone committed Nov 7, 2021
1 parent 1d720a1 commit 870cf30
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 40 deletions.
72 changes: 36 additions & 36 deletions bundles/org.openhab.binding.modbus.e3dc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,32 +85,32 @@ The E3DC device offers quite an amount of channels. For clustering 4 Channel Gro

### Channel Group _Power Block_

| Channel Label | Channel Group ID | Channel ID | Type | Description |
|-------------------------------|-------------------|------------------------------|------------------------|------------------------------|
| PV Output | power | pv-power-supply | Number:Power | Photovoltaic Power Production |
| Battery Discharge | power | battery-power-supply | Number:Power | Battery discharges and provides Power |
| Battery Charge | power | battery-power-consumption | Number:Power | Battery charges and consumes Power |
| Household Consumption | power | household-power-consumption | Number:Power | Household consuming Power |
| Grid Power Consumption | power | grid-power-consumption | Number:Power | Grid Power is needed in order to satisfy your overall Power consumption |
| Grid Power Supply | power | grid-power-supply | Number:Power | More Photovoltaic Power is produced than needed. Additional Power is provided towards the Grid |
| External Power Supply | power | external-power-supply | Number:Power | Power produced by an external device which is attached to your E3DC device |
| Wallbox Power Consumption | power | wallbox-power-consumption | Number:Power | Power consumption of attached Wallboxes |
| Wallbox PV Power Consumption | power | wallbox-pv-power-consumption | Number:Power | Photovoltaic Power consumption (PV plus Battery) of attached Wallboxes |
| Autarky | power | autarky-channel | Number:Dimensionless | Your current Autarky Level in Percent |
| Self Consumption | power | self-consumption | Number:Dimensionless | Your current Photovoltaic Self Consumption Level in Percent |
| Battery State Of Charge | power | battery-soc | Number:Dimensionless | Charge Level of your attached Battery in Percent |
| Channel Label | Channel Group ID | Channel ID | Type | Description |
|-------------------------------|-------------------|------------------------------|------------------------|----------------------------------------------------------------------------------------|
| PV Output | power | pv-power-supply | Number:Power | Photovoltaic Power Production |
| Battery Discharge | power | battery-power-supply | Number:Power | Battery discharges and provides Power |
| Battery Charge | power | battery-power-consumption | Number:Power | Battery charges and consumes Power |
| Household Consumption | power | household-power-consumption | Number:Power | Household consuming Power |
| Grid Power Consumption | power | grid-power-consumption | Number:Power | More Photovoltaic Power is produced than needed. Additional Power is consumed by Grid |
| Grid Power Supply | power | grid-power-supply | Number:Power | Grid Power is needed in order to satisfy your overall Power consumption |
| External Power Supply | power | external-power-supply | Number:Power | Power produced by an external device which is attached to your E3DC device |
| Wallbox Power Consumption | power | wallbox-power-consumption | Number:Power | Power consumption of attached Wallboxes |
| Wallbox PV Power Consumption | power | wallbox-pv-power-consumption | Number:Power | Photovoltaic Power consumption (PV plus Battery) of attached Wallboxes |
| Autarky | power | autarky-channel | Number:Dimensionless | Your current Autarky Level in Percent |
| Self Consumption | power | self-consumption | Number:Dimensionless | Your current Photovoltaic Self Consumption Level in Percent |
| Battery State Of Charge | power | battery-soc | Number:Dimensionless | Charge Level of your attached Battery in Percent |


### Channel Group _String Details Block_

| Channel Label | Channel Group ID | Channel ID | Type | Description |
|-----------------------|------------------|--------------------|---------------------------|------------------------------|
| String 1 Potential | strings | string1-dc-voltage | Number:ElectricPotential | Voltage on String 1 |
| String 2 Potential | strings | string2-dc-voltage | Number:ElectricPotential | Voltage on String 2 |
| String 3 Potential | strings | string3-dc-voltage | Number:ElectricPotential | Voltage on String 3 |
| String 1 Current | strings | string1-dc-current | Number:ElectricCurrent | Current on String 1 |
| String 2 Current | strings | string2-dc-current | Number:ElectricCurrent | Current on String 2 |
| String 3 Current | strings | string3-dc-current | Number:ElectricCurrent | Current on String 3 |
| Channel Label | Channel Group ID | Channel ID | Type | Description |
|-----------------------|------------------|--------------------|---------------------------|----------------------------|
| String 1 Potential | strings | string1-dc-voltage | Number:ElectricPotential | Voltage on String 1 |
| String 2 Potential | strings | string2-dc-voltage | Number:ElectricPotential | Voltage on String 2 |
| String 3 Potential | strings | string3-dc-voltage | Number:ElectricPotential | Voltage on String 3 |
| String 1 Current | strings | string1-dc-current | Number:ElectricCurrent | Current on String 1 |
| String 2 Current | strings | string2-dc-current | Number:ElectricCurrent | Current on String 2 |
| String 3 Current | strings | string3-dc-current | Number:ElectricCurrent | Current on String 3 |
| String 1 Power | strings | string1-dc-output | Number:Power | Power produced by String 1 |
| String 2 Power | strings | string2-dc-output | Number:Power | Power produced by String 2 |
| String 3 Power | strings | string3-dc-output | Number:Power | Power produced by String 3 |
Expand Down Expand Up @@ -175,18 +175,18 @@ String E3DC_ModelName "E3DC Model" (e3dc)
String E3DC_Firmware "E3DC Modbus ID" (e3dc) { channel="modbus:e3dc:device:powerplant:info#firmware-release" }
String E3DC_SerialNumber "E3DC Modbus ID" (e3dc) { channel="modbus:e3dc:device:powerplant:info#serial-number" }
Number:Power E3DC_PVPower "E3DC PV Power" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#pv-power-supply" }
Number:Power E3DC_BatteryDischarge "E3DC Battery Discharge" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#battery-power-supply" }
Number:Power E3DC_BatteryCharge "E3DC Battery Charge" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#battery-power-consumption" }
Number:Power E3DC_Household "E3DC Household Consumption" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#household-power-consumption" }
Number:Power E3DC_GridConsumption "E3DC Grid Consumption" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#grid-power-consumption" }
Number:Power E3DC_GridSupply "E3DC Grid Supply " (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#grid-power-supply" }
Number:Power E3DC_ExternalSupply "E3DC External Supply" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#external-power-supply" }
Number:Power E3DC_WallboxConsumption "E3DC Wallbox Consumption" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#wallbox-power-consumption" }
Number:Power E3DC_WallboxPVConsumption "E3DC Wallbox PV Consumption" (e3dc) { channel="modbus:e3dc:device:powerplant:power#wallbox-pv-power-consumption" }
Number:Dimensionless E3DC_AutarkyLevel "E3DC Autarky Level" (e3dc) { channel="modbus:e3dc:device:powerplant:power#autarky" }
Number:Dimensionless E3DC_SelfConsumptionLevel "E3DC Self Consumption Level" (e3dc) { channel="modbus:e3dc:device:powerplant:power#self-consumption" }
Number:Dimensionless E3DC_BatterySOC "E3DC Battery SOC" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#battery-soc" }
Number:Power E3DC_PVPower "E3DC PV Power" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#pv-power-supply" }
Number:Power E3DC_BatteryDischarge "E3DC Battery Discharge" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#battery-power-supply" }
Number:Power E3DC_BatteryCharge "E3DC Battery Charge" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#battery-power-consumption" }
Number:Power E3DC_Household "E3DC Household Consumption" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#household-power-consumption" }
Number:Power E3DC_GridConsumption "E3DC Power to Grid" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#grid-power-consumption" }
Number:Power E3DC_GridSupply "E3DC Power from Grid" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#grid-power-supply" }
Number:Power E3DC_ExternalSupply "E3DC External Supply" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#external-power-supply" }
Number:Power E3DC_WallboxConsumption "E3DC Wallbox Consumption" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#wallbox-power-consumption" }
Number:Power E3DC_WallboxPVConsumption "E3DC Wallbox PV Consumption" (e3dc) { channel="modbus:e3dc:device:powerplant:power#wallbox-pv-power-consumption" }
Number:Dimensionless E3DC_AutarkyLevel "E3DC Autarky Level" (e3dc) { channel="modbus:e3dc:device:powerplant:power#autarky" }
Number:Dimensionless E3DC_SelfConsumptionLevel "E3DC Self Consumption Level" (e3dc) { channel="modbus:e3dc:device:powerplant:power#self-consumption" }
Number:Dimensionless E3DC_BatterySOC "E3DC Battery SOC" (e3dc,persist) { channel="modbus:e3dc:device:powerplant:power#battery-soc" }
Switch E3DC_WB_Available "E3DC WB available" (e3dc) { channel="modbus:e3dc-wallbox:device:powerplant:wallbox0:wb-available" }
Switch E3DC_WB_Sunmode "E3DC WB Sunmode" (e3dc) { channel="modbus:e3dc-wallbox:device:powerplant:wallbox0:wb-sunmode" }
Expand Down Expand Up @@ -332,7 +332,7 @@ I like the Grafana approach and I used the [InfluxDB & Grafana Tutorial](https:/
from the Community to set this up.
I prepared my machine and I'm quite pleased with the results.

<img style="float: right;" src="doc/GrafanaPV.png">
<img align="right" src="./doc/GrafanaPV.png"/>

In the above picture there are two graphs

Expand Down Expand Up @@ -368,6 +368,6 @@ Items {

Having these values in the timeline you're able to cross check how the forecast influences the Photovoltaic Production.

<img style="float: right;" src="doc/GrafanaCloudiness.png">
<img align="right" src="./doc/GrafanaCloudiness.png"/>

I personally would like to have more steering control of the E3DC to react on such forecast e.g. "stop charging the car if it gets too cloudy"
4 changes: 2 additions & 2 deletions bundles/org.openhab.binding.modbus.e3dc/src/main/resources/OH-INF/i18n/e3dc_de.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ channel-type.modbus.pv-power-supply-channel.label = Photovoltaik Leistung
channel-type.modbus.battery-power-supply-channel.label = Batterie Entladen
channel-type.modbus.battery-power-consumption-channel.label = Batterie Laden
channel-type.modbus.household-power-consumption-channel.label = Haushalt Verbrauch
channel-type.modbus.grid-power-consumption-channel.label = Stromnetz Verbrauch
channel-type.modbus.grid-power-supply-channel.label = Stromnetz Einspeisung
channel-type.modbus.grid-power-consumption-channel.label = Stromnetz Einspeisung
channel-type.modbus.grid-power-supply-channel.label = Stromnetz Verbrauch
channel-type.modbus.external-power-supply-channel.label = Externer Stromproduzent
channel-type.modbus.wallbox-power-consumption-channel.label = Wallbox Ladestrom
channel-type.modbus.wallbox-pv-power-consumption-channel.label = Wallbox Photovoltaik Ladestrom
Expand Down
4 changes: 2 additions & 2 deletions ...s/org.openhab.binding.modbus.e3dc/src/main/resources/OH-INF/thing/power-channel-types.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@
<channel-type id="grid-power-consumption-channel">
<item-type>Number:Power</item-type>
<label>Grid Power Consumption</label>
<description>Grid Power is needed in order to satisfy your overall Power consumption</description>
<description>More Photovoltaic Power is produced than needed. Additional Power is consumed by Grid</description>
</channel-type>
<channel-type id="grid-power-supply-channel">
<item-type>Number:Power</item-type>
<label>Grid Power Supply</label>
<description>More Photovoltaic Power is produced than needed. Additional Power is provided towards the Grid</description>
<description>Grid Power is needed in order to satisfy your overall Power consumption</description>
</channel-type>
<channel-type id="external-power-supply-channel">
<item-type>Number:Power</item-type>
Expand Down

0 comments on commit 870cf30

Please sign in to comment.