nanoFramework.Iot.Device.Ip5306 1.2.514

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package nanoFramework.Iot.Device.Ip5306 --version 1.2.514
NuGet\Install-Package nanoFramework.Iot.Device.Ip5306 -Version 1.2.514
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.Ip5306" Version="1.2.514" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nanoFramework.Iot.Device.Ip5306 --version 1.2.514
#r "nuget: nanoFramework.Iot.Device.Ip5306, 1.2.514"
#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.Ip5306 as a Cake Addin
#addin nuget:?package=nanoFramework.Iot.Device.Ip5306&version=1.2.514

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

IP5306 - Power management

This chip is used mainly in power bank and embedded devices as a power management device. It is connected using I2C and allows to adjust the charging current,voltage, cutoff voltage. It has the capacity to light up 4 leds displaying the charge of the battery. This device is used in the M5Stack.

Documentation

The datasheet in Chinese can be found here.

Usage

As always when using I2C, you need to make sure you're using the right pins. En ESP32, you need the register the pins if not using the default one.

Configuration.SetPinFunction(22, DeviceFunction.I2C1_CLOCK);
Configuration.SetPinFunction(21, DeviceFunction.I2C1_DATA);

I2cDevice i2c = new(new I2cConnectionSettings(1, Ip5306.SecondaryI2cAddress));
Ip5306 power = new(i2c);

Note the default address of the IP5306 is 0xEA, the address used in M5Stack is 0x75 (here setup as SecondaryI2cAddress).

Getting access to the properties

All properties can be adjusted and changed. He is an example how to display all of them:

Debug.WriteLine($"  AutoPowerOnEnabled: {power.AutoPowerOnEnabled}");
Debug.WriteLine($"  BoostOutputEnabled: {power.BoostOutputEnabled}");
Debug.WriteLine($"  BoostWhenVinUnpluggedEnabled: {power.BoostWhenVinUnpluggedEnabled}");
Debug.WriteLine($"  BostEnabled: {power.BoostEnabled}");
Debug.WriteLine($"  ButtonOffEnabled: {power.ButtonOffEnabled}");
Debug.WriteLine($"  ChargerEnabled: {power.ChargerEnabled}");
Debug.WriteLine($"  ChargingBatteryVoltage: {power.ChargingBatteryVoltage}");
Debug.WriteLine($"  ChargingCurrent: {power.ChargingCurrent}");
Debug.WriteLine($"  ChargingCutOffCurrent: {power.ChargingCutOffCurrent}");
Debug.WriteLine($"  ChargingCuttOffVoltage{power.ChargingCuttOffVoltage}");
Debug.WriteLine($"  ChargingLoopSelection: {power.ChargingLoopSelection}");
Debug.WriteLine($"  ChargingUnderVoltage: {power.ChargingUnderVoltage}");
Debug.WriteLine($"  ConstantChargingVoltage: {power.ConstantChargingVoltage}");
Debug.WriteLine($"  FlashLightBehavior {power.FlashLightBehavior}");
Debug.WriteLine($"  IsBatteryFull: {power.IsBatteryFull}");
Debug.WriteLine($"  IsCharging: {power.IsCharging}");
Debug.WriteLine($"  IsOutputLoadHigh: {power.IsOutputLoadHigh}");
Debug.WriteLine($"  LightDutyShutdownTime: {power.LightDutyShutdownTime}");
Debug.WriteLine($"  LowPowerOffEnabled: {power.LowPowerOffEnabled}");
Debug.WriteLine($"  ShortPressToSwitchBosst: {power.ShortPressToSwitchBosst}");
Debug.WriteLine($"  SwitchOffBoostBehavior: {power.SwitchOffBoostBehavior}");
Debug.WriteLine($"  GetButtonStatus: {power.GetButtonStatus()}");

Button status

You can get the button status:

var button = power.GetButtonStatus();
switch (button)
{
    case ButtonPressed.DoubleClicked:
        Debug.WriteLine("double clicked");
        break;
    case ButtonPressed.LongPressed:
        Debug.WriteLine("Long pressed");
        break;
    case ButtonPressed.ShortPressed:
        Debug.WriteLine("Short pressed");
        break;
    case ButtonPressed.NotPressed:
    default:
        break;
}

Important: depending on the behavior you setup for the button, the device may switch off what's connected to it. So be careful on what you setup. Once the I2C connection is broken, you can't adjust the behavior bck.

configuration for M5Stack

The configuration for M5Stack is the following:

// Configuration for M5Stack
power.ButtonOffEnabled = true;
power.BoostOutputEnabled = false;
power.AutoPowerOnEnabled = true;
power.ChargerEnabled = true;
power.BoostEnabled = true;
power.LowPowerOffEnabled = true;
power.FlashLightBehavior = ButtonPress.Doubleclick;
power.SwitchOffBoostBehavior = ButtonPress.LongPress;
power.BoostWhenVinUnpluggedEnabled = true;
power.ChargingUnderVoltage = ChargingUnderVoltage.V4_55;
power.ChargingLoopSelection = ChargingLoopSelection.Vin;
power.ChargingCurrent = ElectricCurrent.FromMilliamperes(2250);
power.ConstantChargingVoltage = ConstantChargingVoltage.Vm28;
power.ChargingCuttOffVoltage = ChargingCutOffVoltage.V4_17;
power.LightDutyShutdownTime = LightDutyShutdownTime.S32;
power.ChargingCutOffCurrent = ChargingCutOffCurrent.C500mA;
power.ChargingCuttOffVoltage = ChargingCutOffVoltage.V4_2;
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 (3)

Showing the top 3 NuGet packages that depend on nanoFramework.Iot.Device.Ip5306:

Package Downloads
nanoFramework.M5Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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

nanoFramework.Fire The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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

nanoFramework.M5Stack The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.514 83 3/22/2024
1.2.494 168 2/28/2024
1.2.474 249 1/24/2024
1.2.462 148 1/5/2024
1.2.458 115 12/20/2023
1.2.436 243 11/10/2023
1.2.403 314 10/6/2023
1.2.396 196 9/27/2023
1.2.384 199 9/6/2023
1.2.378 244 8/16/2023
1.2.369 232 8/2/2023
1.2.363 190 7/28/2023
1.2.357 214 7/19/2023
1.2.354 193 7/14/2023
1.2.345 200 6/21/2023
1.2.341 169 6/14/2023
1.2.337 217 6/7/2023
1.2.335 107 6/2/2023
1.2.329 202 5/26/2023
1.2.313 300 5/12/2023
1.2.302 249 5/10/2023
1.2.297 268 5/3/2023
1.2.273 944 3/17/2023
1.2.267 580 3/10/2023
1.2.263 451 3/8/2023
1.2.259 481 2/27/2023
1.2.256 479 2/24/2023
1.2.253 480 2/22/2023
1.2.222 1,043 1/9/2023
1.2.208 1,421 1/3/2023
1.2.203 601 12/28/2022
1.2.153 1,945 11/5/2022
1.2.141 2,105 10/25/2022
1.2.63 6,872 9/3/2022
1.2.47 999 8/15/2022
1.2.40 967 8/6/2022
1.2.38 921 8/5/2022
1.2.28 2,416 8/1/2022
1.2.13 1,927 7/24/2022
1.2.10 932 7/23/2022
1.1.142.3202 1,803 7/7/2022
1.1.133.52556 2,639 6/30/2022
1.1.121.35854 2,326 6/26/2022
1.1.102.51394 2,353 6/15/2022
1.1.99.36719 928 6/14/2022
1.1.72.29765 4,720 5/31/2022
1.1.64.21380 2,301 5/26/2022
1.1.54.28879 1,726 5/23/2022
1.1.40 2,514 5/5/2022
1.1.1 8,063 4/14/2022
1.0.302 3,413 3/31/2022
1.0.300 413 3/31/2022
1.0.288-preview.113 127 3/25/2022
1.0.288-preview.103 131 3/21/2022
1.0.288-preview.98 122 3/18/2022
1.0.288-preview.93 143 3/15/2022
1.0.288-preview.86 163 3/8/2022
1.0.288-preview.77 147 2/27/2022
1.0.288-preview.75 111 2/26/2022
1.0.288-preview.65 134 2/18/2022
1.0.288-preview.63 116 2/16/2022
1.0.288-preview.61 129 2/12/2022
1.0.288-preview.58 113 2/10/2022
1.0.288-preview.53 115 2/9/2022
1.0.288-preview.41 162 1/31/2022
1.0.288-preview.29 135 1/28/2022
1.0.288-preview.20 157 1/27/2022
1.0.288-preview.18 132 1/27/2022
1.0.288-preview.5 137 1/24/2022
1.0.288-preview.1 136 1/21/2022
1.0.267 325 1/4/2022
1.0.259 508 12/9/2021
1.0.258 262 12/7/2021
1.0.218 461 10/18/2021
1.0.203 311 10/11/2021
1.0.191 298 9/29/2021
1.0.177 315 9/22/2021