Merge pull request #229 from WildernessLabs/feature/battery-backed-pe…

…ripheral add IBatteryBackedPeripheral interface
WildernessLabs · May 16, 2024 · 9bcc04f · 9bcc04f
2 parents 4478cf8 + 5e71ba9
commit 9bcc04f
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/Source/Meadow.Contracts/IBatteryBackedPeripheral.cs b/Source/Meadow.Contracts/IBatteryBackedPeripheral.cs
@@ -0,0 +1,13 @@
+namespace Meadow;
+
+/// <summary>
+/// Provides an abstraction for peripherals that have a battery and that can read information about that battery
+/// </summary>
+public interface IBatteryBackedPeripheral
+{
+    /// <summary>
+    /// Reads the state of the battery
+    /// </summary>
+    /// <returns><b>True</b> if the battery voltage is low, otherwise <b>False</b></returns>
+    bool IsBatteryLow();
+}