Skip to content

Commit d132ab0

Browse files
authored
Update README.md for clockInfos, add @RelapsingCertainly to contributors
1 parent 09f6803 commit d132ab0

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

apps/smartbatt/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ When this app is installed, <i><b>do not rely on it for the first 24-30 hours.</
88
The module might return different data than expected, or a severely low prediction. Give it time. It will learn from drainage rates, which needs the battery to drain. If your watch normally lasts for a long time on one charge, it will take longer for the module to return an accurate reading.
99

1010
If you think something is wrong with the predictions after 3 days, try clearing the data, and let it rebuild again from scratch.
11+
## Clock Infos
12+
The module provides two clockInfos:
13+
- Days left
14+
- Learned drainage rate per hour
1115

1216
## Settings
1317
### Clear Data - Clears all learned data.
@@ -27,7 +31,18 @@ Logs:
2731
## Functions
2832
From any app, you can call `require("smartbatt")` and then one of the functions below:
2933
* `require("smartbatt").record()` - Attempts to record the battery and push it to the average.
30-
* `require("smartbatt").get()` - Returns an object that contains the hours left and current battery percentage
34+
* `require("smartbatt").get()` - Returns an object that contains:
35+
36+
37+
* `hrsRemaining` - Hours remaining
38+
* `avgDrainage` - Learned battery drainage per hour
39+
* `totalCycles` - Total times the battery has been recorded and averaged
40+
* `totalHours` - Total hours recorded
41+
* `batt` - Current battery level
42+
43+
3144
* `require("smartbatt").deleteData()` - Deletes all learned data. (Automatically re-learns)
3245
## Creator
33-
RKBoss6
46+
- RKBoss6
47+
## Contributors
48+
- RelapsingCertainly

0 commit comments

Comments
 (0)