nanoFramework.Iot.Device.Axp192 1.2.560

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package nanoFramework.Iot.Device.Axp192 --version 1.2.560                
NuGet\Install-Package nanoFramework.Iot.Device.Axp192 -Version 1.2.560                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="nanoFramework.Iot.Device.Axp192" Version="1.2.560" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.Iot.Device.Axp192 --version 1.2.560                
#r "nuget: nanoFramework.Iot.Device.Axp192, 1.2.560"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install nanoFramework.Iot.Device.Axp192 as a Cake Addin
#addin nuget:?package=nanoFramework.Iot.Device.Axp192&version=1.2.560

// Install nanoFramework.Iot.Device.Axp192 as a Cake Tool
#tool nuget:?package=nanoFramework.Iot.Device.Axp192&version=1.2.560                

AXP192 - Enhanced single Cell Li-Battery and Power System Management IC

Documentation

-Product documentation can be found here. -Registers can be found here (Chineese only, note: bing translator make miracle).

  • This sensor is used in the M5Stick. Initialization code for this device can be found here.

Usage

// Make sure you configure properly the I2C pins, here example for ESP32
Configuration.SetPinFunction(22, DeviceFunction.I2C1_CLOCK);
Configuration.SetPinFunction(21, DeviceFunction.I2C1_DATA);

I2cDevice i2cAxp192 = new(new I2cConnectionSettings(1, Axp192.I2cDefaultAddress));
Axp192 power = new Axp192(i2cAxp192);

Important: make sure you read th documentation of your battery and setup the proper charging values, stop current. Overcharging your battery may damage it.

Using the button

One button is available and can be setup to track short and long press:

// This part of the code will handle the button behavior
power.EnableButtonPressed(ButtonPressed.LongPressed | ButtonPressed.ShortPressed);
power.SetButtonBehavior(LongPressTiming.S2, ShortPressTiming.Ms128, true, SignalDelayAfterPowerUp.Ms32, ShutdownTiming.S10);

The status is kept in the registers up to the next status read. You can then have both a short and a long press, you can get the status like this:

var status = power.GetButtonStatus();
if ((status & ButtonPressed.ShortPressed) == ButtonPressed.ShortPressed)
{
    Debug.WriteLine("Short press");
}
else if ((status & ButtonPressed.LongPressed) == ButtonPressed.LongPressed)
{
    Debug.WriteLine("Long press");
}

Battery status

You can get various elements regarding the battery status:

Debug.WriteLine($"Battery:");
Debug.WriteLine($"  Charge curr  : {power.GetBatteryChargeCurrent().Milliamperes} mA");
Debug.WriteLine($"  Status       : {power.GetBatteryChargingStatus()}");
Debug.WriteLine($"  Dicharge curr: {power.GetBatteryDischargeCurrent().Milliamperes} mA");
Debug.WriteLine($"  Inst Power   : {power.GetBatteryInstantaneousPower().Milliwatts} mW");
Debug.WriteLine($"  Voltage      : {power.GetBatteryVoltage().Volts} V");
Debug.WriteLine($"  Is battery   : {power.IsBatteryConnected()} ");

Advanced features

The AXP192 can charge the battery, get and set charging current, cut off voltage, has protection for temperature. Most feature can be access or setup. You can check out the sample to get more details on how to set those advance features.

Note: this binding uses UnitsNet for the units like Voltage, Amperes.

Here is an example reading the current, voltage:

Debug.WriteLine($"Temperature : {power.GetInternalTemperature().DegreesCelsius} °C");
Debug.WriteLine($"Input:");
// Note: the current and voltage will show 0 when plugged into USB.
// To see something else than 0, you should output those data on a serial port for example
// Or display on the screen.
Debug.WriteLine($"  Current   : {power.GetInputCurrent().Milliamperes} mA");
Debug.WriteLine($"  Voltage   : {power.GetInputVoltage().Volts} V");
Debug.WriteLine($"  Status    : {power.GetInputPowerStatus()}");
Debug.WriteLine($"  USB volt  : {power.GetUsbVoltageInput().Volts} V");
Debug.WriteLine($"  USB Curr  : {power.GetUsbCurrentInput().Milliamperes} mA");

Coulomb counter

The AXP192 has a Coulomb counter where the value is in mili Amperes per hour (this one is not yet using UnitsNet). You first have to enable the Counter and then you can read the value. It is recommended to let some time between the moment you enable and read the data. Features to reset, stop the count are available as well

power.EnableCoulombCounter();
// Do something here
// You can then read periodically the Coulomb counter:
Debug.WriteLine($"Coulomb: {power.GetCoulomb()} mA/h");
Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on nanoFramework.Iot.Device.Axp192:

Package Downloads
nanoFramework.M5Core2

This package includes the nanoFramework.M5Core2 assembly for .NET nanoFramework C# projects.

nanoFramework.M5StickC

This package includes the nanoFramework.M5StickC assembly for .NET nanoFramework C# projects.

nanoFramework.M5StickCPlus

This package includes the nanoFramework.M5StickCPlus assembly for .NET nanoFramework C# projects.

nanoFramework.Tough

This package includes the nanoFramework.Tough assembly for .NET nanoFramework C# projects.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on nanoFramework.Iot.Device.Axp192:

Repository Stars
nanoframework/Samples
🍬 Code samples from the nanoFramework team used in testing, proof of concepts and other explorational endeavours
nanoframework/nanoFramework.IoT.Device
📦 This repo includes .NET nanoFramework implementations for various sensors, chips, displays, hats and drivers
nanoframework/nanoFramework.M5Stack
:package: Board support package for M5Stack, M5StickC and M5StickCPlus for .NET nanoFramework
Version Downloads Last updated
1.2.718 227 10 days ago
1.2.696 400 23 days ago
1.2.673 821 3 months ago
1.2.656 820 3 months ago
1.2.639 662 4 months ago
1.2.631 314 4 months ago
1.2.613 565 5 months ago
1.2.601 270 5 months ago
1.2.590 405 6 months ago
1.2.573 670 7 months ago
1.2.570 128 7 months ago
1.2.560 377 7 months ago
1.2.548 386 8 months ago
1.2.536 611 9 months ago
1.2.514 704 10 months ago
1.2.494 510 2/28/2024
1.2.474 706 1/24/2024
1.2.462 249 1/5/2024
1.2.458 245 12/20/2023
1.2.436 705 11/10/2023
1.2.403 940 10/6/2023
1.2.396 414 9/27/2023
1.2.384 466 9/6/2023
1.2.378 644 8/16/2023
1.2.369 653 8/2/2023
1.2.363 348 7/28/2023
1.2.357 427 7/19/2023
1.2.354 416 7/14/2023
1.2.345 742 6/21/2023
1.2.341 473 6/14/2023
1.2.337 437 6/7/2023
1.2.335 211 6/2/2023
1.2.329 687 5/26/2023
1.2.313 736 5/12/2023
1.2.302 518 5/10/2023
1.2.297 523 5/3/2023
1.2.273 2,086 3/17/2023
1.2.267 1,187 3/10/2023
1.2.263 1,026 3/8/2023
1.2.259 1,116 2/27/2023
1.2.256 856 2/24/2023
1.2.253 819 2/22/2023
1.2.222 2,135 1/9/2023
1.2.219 363 1/9/2023
1.2.208 2,813 1/3/2023
1.2.203 1,331 12/28/2022
1.2.153 4,042 11/5/2022
1.2.141 3,993 10/25/2022
1.2.122 1,630 10/12/2022
1.2.114 1,554 10/8/2022
1.2.95 5,090 9/22/2022
1.2.87 4,815 9/15/2022
1.2.73 1,608 9/8/2022
1.2.63 2,600 9/3/2022
1.2.47 1,706 8/15/2022
1.2.40 1,940 8/6/2022
1.2.38 1,615 8/5/2022
1.2.28 4,796 8/1/2022
1.2.13 3,883 7/24/2022
1.2.10 1,634 7/23/2022
1.1.145.58726 3,013 7/7/2022
1.1.133.52556 5,807 6/30/2022
1.1.127.28388 2,750 6/28/2022
1.1.121.35854 1,949 6/26/2022
1.1.113.2032 2,748 6/23/2022
1.1.102.51394 2,529 6/15/2022
1.1.99.36719 1,636 6/14/2022
1.1.74.7591 8,412 5/31/2022
1.1.72.29765 1,051 5/31/2022
1.1.67.25390 1,745 5/27/2022
1.1.66.33470 1,396 5/26/2022
1.1.64.21380 1,430 5/26/2022
1.1.54.28879 2,829 5/23/2022
1.1.40 4,127 5/5/2022
1.1.1 13,192 4/14/2022
1.0.308 1,461 4/12/2022
1.0.302 4,628 3/31/2022
1.0.300 511 3/31/2022
1.0.288-preview.113 157 3/25/2022
1.0.288-preview.103 166 3/21/2022
1.0.288-preview.99 163 3/18/2022
1.0.288-preview.98 141 3/18/2022
1.0.288-preview.93 173 3/15/2022
1.0.288-preview.86 189 3/8/2022
1.0.288-preview.77 167 2/27/2022
1.0.288-preview.75 142 2/26/2022
1.0.288-preview.65 161 2/18/2022
1.0.288-preview.63 153 2/16/2022
1.0.288-preview.61 152 2/12/2022
1.0.288-preview.58 144 2/10/2022
1.0.288-preview.53 140 2/9/2022
1.0.288-preview.41 189 1/31/2022
1.0.288-preview.29 220 1/28/2022
1.0.288-preview.20 226 1/27/2022
1.0.288-preview.19 151 1/27/2022
1.0.288-preview.18 173 1/27/2022
1.0.288-preview.5 186 1/24/2022
1.0.288-preview.1 181 1/21/2022
1.0.272 263 1/10/2022
1.0.259 1,049 12/9/2021
1.0.258 355 12/7/2021
1.0.235 284 11/1/2021
1.0.234 202 11/1/2021
1.0.218 641 10/18/2021
1.0.191 397 9/29/2021
1.0.167 393 9/15/2021