klaute/ESP32_powerMC
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Readme fixed

Browse source
This commit is contained in:
Kai Lauterbach 2024-02-08 16:29:14 +01:00
parent 3e96da19b6
commit 068a5b9b43
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -41,21 +41,20 @@ This is an example of a JSON object containing various measurement values and co
- `shuntVoltage`: The voltage across the shunt resistor in volts.
- `current`: The current consumption in amperes.
- `power`: The power in watts.
- `energy`: The energy in watt-hours.
- `energy`: The energy in watt-hours of the attached battery.
- `temperature`: The temperature in degrees Celsius.
- `humidity`: The humidity in percentage.
- `errorCode`: An error code indicating possible error conditions.
- `shuntValue`: The value of the shunt resistor in ohms.
- `ina226Status`: The status of the INA226 chip.
- `shuntValue`: The value of the shunt resistor in ohms which is used for configuration.
- `ina226Status`: The status of the INA226 initialization (setMaxCurrentShunt function call).
- `ina226ShuntValue`: The value of the shunt resistor according to the INA226 chip in ohms.
- `ina226AlertFlag`: A flag indicating whether a warning has been triggered by the INA226 chip.
- `ina226AlertLimit`: The limit value for alerts from the INA226 chip.
- `ina226CurrentLSB`: The value of the least significant bit (LSB) for the current according to the INA226 chip in amperes.
- `ina226CurrentLSB`: The value of the least significant bit (LSB) for the current according to the INA226 chip in amperes represents the smallest measurable current level that the INA226 chip can detect.
### Error codes in `errorCode`
#### Error codes in `errorCode`
The variable `globalError` is used as a bitmask, where each bit represents a specific error condition. Here are the possible error codes and their meanings:
#### Error Codes
| Descriptive Name | Value | Meaning |
|:----------------------------|---------:|:---------------------------------------------------------|