Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AE-74] Revamp Battery API for Nicla Sense ME #680

Merged
merged 48 commits into from
May 12, 2023
Merged
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
965fb69
nicla-system: Rework battery API.
sebromero Apr 26, 2023
d8fc798
nicla-sense-pmic: Use function to toggle Hi-Z mode.
sebromero Apr 26, 2023
20ee494
nicla-system: Add battery monitor web app.
sebromero Apr 27, 2023
864d9a3
nicla-system: Add battery check sketch for Nicla Sense.
sebromero Apr 27, 2023
bd0ee3e
nicla-system: Add function for toggling battery NTC.
sebromero Apr 28, 2023
a47ec88
nicla-system: Refactor names.
sebromero Apr 28, 2023
254eecb
nicla-system: Remove duplicate functionality.
sebromero May 2, 2023
66bc141
nicla-system: Add API for operating system.
sebromero May 2, 2023
3b0af63
nicla-system: Rename function.
sebromero May 2, 2023
edaf109
nicla-system: Use getFaultsRegister to query faults register.
sebromero May 2, 2023
03cbd92
nicla-system: Add documentation.
sebromero May 2, 2023
1c55bb5
nicla-system: Remove battery status function.
sebromero May 2, 2023
c29e363
nicla-system: Replace defines with enum for battery level.
sebromero May 2, 2023
9f7b9a9
nicla-system: Add getter for fast charge register.
sebromero May 2, 2023
f14d519
nicla-system: Replace battery temperature with enum.
sebromero May 2, 2023
6e8f454
nicla-system: Add API to set regulated battery voltage.
sebromero May 2, 2023
d2c93a0
nicla-system: Move function to read LDO register to pmic driver.
sebromero May 2, 2023
56b67be
nicla-system: Catch error case.
sebromero May 3, 2023
d69d3ad
nicla-system: Rename function name.
sebromero May 3, 2023
444a74d
nicla-system: Improve efficiency of voltage calculation.
sebromero May 3, 2023
0708980
nicla-system: Fix incorrect INT disable.
sebromero May 3, 2023
e6ff5c5
nicla-system: Add documentation to charging function.
sebromero May 3, 2023
6d8c08a
nicla-system: Rename charging function.
sebromero May 3, 2023
9f1b6cc
nicla-system: Avoid High-Z mode when powered from VIN.
sebromero May 3, 2023
ad89fb1
nicla-system: Add function to check if board runs on battery.
sebromero May 3, 2023
6ab5b66
nicla-system: Add documentation to LDO functions.
sebromero May 4, 2023
6286728
nicla-system: Add function to disable charging.
sebromero May 4, 2023
abbc54f
nicla-system: Disable charging while taking a battery reading.
sebromero May 4, 2023
2871417
nicla-system: Display charging and power status.
sebromero May 4, 2023
de371ef
nicla-system: Make BLE updates more robust.
sebromero May 4, 2023
4dee246
nicla-system: Add documentation to the web app.
sebromero May 4, 2023
48fb48e
nicla-system: Change order of setup instructions.
sebromero May 4, 2023
cea8fa2
nicla-system: Add function for backwards compatibility.
sebromero May 4, 2023
b16d5ea
nicla-system: Give PMIC more time to wake up.
sebromero May 5, 2023
b3d7f82
nicla-system: Add error messages to sketch.
sebromero May 5, 2023
f7845c2
nicla-system: Fix incorrect battery voltage reading.
sebromero May 9, 2023
d47a6db
nicla-system: Add documentation about charging rate.
sebromero May 9, 2023
a0b13de
nicla-system: Remove NTC toggling from charge function.
sebromero May 9, 2023
f5e6718
nicla-system: Add more documentation.
sebromero May 10, 2023
d2271c1
nicla-system: Simplify the watchdog reset machanism.
sebromero May 10, 2023
14117b6
nicla-system: Remove unused code.
sebromero May 10, 2023
d399ee3
nicla-system: Increase safety charge time from 3 to 9 hours.
sebromero May 10, 2023
9bce6e8
nicla-system: Add more documentation.
sebromero May 11, 2023
c316d06
nicla-system: Add sketch that shows how to charge the battery.
sebromero May 11, 2023
21a7c56
nicla-system: Add new measurement of charge current to docs.
sebromero May 11, 2023
e51a021
nicla-system: Add option to configure safety timer.
sebromero May 11, 2023
5fff648
nicla-system: Make the safety timer configuration explicit.
sebromero May 11, 2023
1ca6fc3
nicla-system: Apply suggestions from Ali's code review.
sebromero May 12, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/*
* This example shows how to use the Nicla Sense ME library to charge a battery.
*
* The LED colors will change depending on the battery's operating status:
* - Blue: Ready
* - Yellow: Charging
* - Green: Charging complete
* - Red: Error
*
* Instructions:
* 1. Connect a battery to the board.
* 2. Configure the charge current in the setup() function.
* 3. Upload this sketch to your Nicla Sense ME board.
*
* Initial author: Sebastian Romero @sebromero
*/

#include "Nicla_System.h"

constexpr auto printInterval { 10000ul };
float voltage = -1.0f;

void setup(){
Serial.begin(115200);
for (const auto timeout = millis() + 2500; millis() < timeout && !Serial; delay(250));
nicla::begin(); // Initialise library
nicla::leds.begin(); // Start I2C connection to LED driver
nicla::setBatteryNTCEnabled(true); // Set to false if your battery doesn't have a NTC.

/*
A safe default charging current value that works for most common LiPo batteries is 0.5C,
which means charging at a rate equal to half of the battery's capacity.
For example, a 200mAh battery could be charged at 100mA (0.1A).
*/
nicla::enableCharging(100);
nicla::leds.setColor(blue);
}

void loop(){

static auto updateTimestamp = millis();

if (millis() - updateTimestamp >= printInterval) {
updateTimestamp = millis();

float currentVoltage = nicla::getCurrentBatteryVoltage();
if(currentVoltage != voltage){
voltage = currentVoltage;
Serial.print("\nVoltage: ");
Serial.println(voltage);
} else {
Serial.print(".");
}

auto operatingStatus = nicla::getOperatingStatus();

switch(operatingStatus) {
case OperatingStatus::Charging:
nicla::leds.setColor(255,100,0); // Yellow
break;
case OperatingStatus::ChargingComplete:
nicla::leds.setColor(green);

// This will stop further charging until enableCharging() is called again.
nicla::disableCharging();
break;
case OperatingStatus::Error:
nicla::leds.setColor(red);
break;
case OperatingStatus::Ready:
nicla::leds.setColor(blue);
break;
default:
nicla::leds.setColor(off);
break;
}

}
}
Loading