From 068a5b9b430035985c65a539822697e41911bbb0 Mon Sep 17 00:00:00 2001 From: Kai Lauterbach Date: Thu, 8 Feb 2024 16:29:14 +0100 Subject: [PATCH] Readme fixed --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c277985..2aa03be 100644 --- a/README.md +++ b/README.md @@ -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 | |:----------------------------|---------:|:---------------------------------------------------------|