jamesmontemagno / batteryplugin

Battery Plugin for Xamarin and Windows

Battery Status Plugin for Xamarin and Windows

Simple cross platform plugin to check battery status of mobile device, get remaining percentage for Xamarin.iOS, Xamarin.Android, Windows, and Xamarin.Forms projects.

Setup

• Available on NuGet: http://www.nuget.org/packages/Xam.Plugin.Battery
• Install into your PCL/NetStanadrd project and Client projects.

Build Status:

• 
• CI NuGet Feed: http://myget.org/F/xamarin-plugins

Migrate to: Xamarin.Essentials or .NET MAUI

I have been working on Plugins for Xamarin for a long time now. Through the years I have always wanted to create a single, optimized, and official package from the Xamarin team at Microsoft that could easily be consumed by any application. The time is now with Xamarin.Essentials, which offers over 50 cross-platform native APIs in a single optimized package. I worked on this new library with an amazing team of developers and I highly highly highly recommend you check it out.

Additionally, Xamarin.Essentials is now included in & .NET MAUI.

Due to the functionality being included "in the box" I have decided to officially archive this repo.

Platform Support

Platform	Version
Xamarin.iOS	iOS 6+
Xamarin.Android	API 10+
Windows 10 UWP	10+
Tizen.NET	4.0+

Windows Store has a blank DLL that always returns 100, AC, and Full as there is no API for checking battery

API Usage

Call CrossBattery.Current from any project or PCL to gain access to APIs.

RemainingChargePercent

/// <summary>
/// Current battery level 0 - 100
/// </summary>
int RemainingChargePercent { get; }

Status

/// <summary>
/// Current status of the battery
/// </summary>
BatteryStatus Status { get; }

This returns an enum with the current status of the battery. If charging or not:

/// <summary>
/// Current status of battery
/// </summary>
public enum BatteryStatus
{
  /// <summary>
  /// Plugged in and charging
  /// </summary>
  Charging,
  /// <summary>
  /// Battery is being drained currently
  /// </summary>
  Discharging,
  /// <summary>
  /// Battery is full completely
  /// </summary>
  Full,
  /// <summary>
  /// Not charging, but not discharging either
  /// </summary>
  NotCharging,
  /// <summary>
  /// Unknown or other status
  /// </summary>
  Unknown

}

Important:

• iOS: only returns Charging, Full, Discharging, and Unknown.

PowerSource

/// <summary>
/// Currently how the battery is being charged.
/// </summary>
PowerSource PowerSource { get; }

Returns how the phone is being charged

Events

You can subscribe to BatteryChanged, which will return BatteryChangedEventArgs with all information you need. This occurs when plugged, unplugged, or battery change.

/// <summary>
/// Event handler when battery changes
/// </summary>
event BatteryChangedEventHandler BatteryChanged;

License

Under MIT, see LICENSE file.

batteryplugin's Issues

Continual 'Changed' events in droid even when no property is changed.

From a Visual Studio perspective... The BatteryChangedEventArgs e has no changed properties between events. Yet is being raised every quarter second or so. I'm going to have to filter this before actually throwing an event to the rest of my program. So...

1. It would be nice if the plugin didn't hammer false change events.
2. It would be nice if the 'equals' operator comparred values of the object instead of instance so we can see if two different event args are equal to each other.

Simulate battery level change

How can I simulate a battery level change in the emulator to test my BatteryChanged handler?

thank you

--ilann

Plugin can be used in VS 2017 - C#?

HI, I'd like to know if this plugin can be used in VisualStudio 2017, C#, >NET 4.6. for a Windows 10 desktop app. classic windows, not UWA.

Thanks,

[UWP] Always report 'Full' when is not

Please fill out either the bug or feature request section and remove whatever section you are not using.

Bug

Version Number of Plugin: 2.1.0
Device Tested On: Windows 10 (PC & Mobile)

Expected Behavior

Should not be Full if the percentage is less than 100% (Charging or discharging...)

Actual Behavior

Always reports Full, due to the wrong IF condition in line 92:

if (percentage >= 1.0)

it should be >=100, as percentage is 0-100

Return -1

Hi,
i'm using Xamarin to create UWP and Android App using your plugin and it's always return -1, in Emulator and local and on Raspberry Pi3

Bug

Version Number of Plugin: Version=2.1.1.0
Device Tested On: Raspberry Pi3
Simulator Tested On: Mobile Emulator 10.0.14393.0 1080p 6inch 2GB

Expected Behavior

to show 100 value

Actual Behavior

return -1

Steps to reproduce the Behavior

call from PCL

Feature Request:

is there something missing i didn't do?

[Feature Request] Add .NET Standard Support

Xamarin.Forms.Mac

Hi,

are you planning to add Forms.Mac Support as well?
Also asking for your other plugins

thanks for your awesome work

Helge