fsantini / python-e3dc

Python API for querying E3/DC systems through the manufacturer's portal
MIT License
72 stars 23 forks source link

installedBatteryCapacity documentation wrong (Ah instead of W) #100

Open eikowagenknecht opened 11 months ago

eikowagenknecht commented 11 months ago

In the documentation it says:

...
                    "installedBatteryCapacity": <installed Battery Capacity in W>,
...

Battery capacities are never measured in W, it should be Wh, kWh or Ah.

My system reports

get_system_info():
{
  "installedBatteryCapacity": 33,
}

So at least for the S10XCOMPACT14 it is 33 Ah.

With a voltage of around 400V (this might not be exactly the right number to use, but in the right range) this seems to result in 13,2 kWh, which is at least in the range of the official (net / "usable energy") value of 11,2kWh.

The docs for the battery values contain no units at all:

                    "designCapacity": <design capacity>,
                    "deviceConnected": <device connected>,
                    "deviceInService": <device in service>,
                    "deviceName": <device name>,
                    "deviceWorking": <device working>,
                    "eodVoltage": <eod voltage>,
                    "errorCode": <error code>,
                    "fcc": <full charge capacity>,
                    "index": <batIndex>,
                    "maxBatVoltage": <max battery voltage>,
                    "maxChargeCurrent": <max charge current>,
                    "maxDischargeCurrent": <max discharge current>,
                    "maxDcbCellTemp": <max DCB cell temp>,
                    "minDcbCellTemp": <min DCB cell temp>,
                    "moduleVoltage": <module voltage>,
                    "rc": <rc>,
                    "readyForShutdown": <ready for shutdown>,
                    "rsoc": <relative state of charge>,
                    "rsocReal": <real relative state of charge>,
                    "statusCode": <status code>,
                    "terminalVoltage": <terminal voltage>,
                    "totalUseTime": <total use time>,
                    "totalDischargeTime": <total discharge time>,
                    "trainingMode": <training mode>,
                    "usuableCapacity": <usuable capacity>
                    "usuableRemainingCapacity": <usuable remaining capacity>

Might be good to add correct units there as well. For reference about the units, these are the values shown in RscpGui:

image image

vchrisb commented 11 months ago

Yes, W is not correct. For me it is Wh and the value is exactly the expected one. But this doesn't make sense in your case.

A PR to improve the docs is always appreciated.