Merge pull request #251 from WildernessLabs/feature/backlit-display

add IBacklitDisplay interface
WildernessLabs · Jul 23, 2024 · d2240fb · d2240fb
2 parents a579ff5 + 74b8418
commit d2240fb
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/Source/Meadow.Contracts/Peripherals/Displays/IBacklitDisplay.cs b/Source/Meadow.Contracts/Peripherals/Displays/IBacklitDisplay.cs
@@ -0,0 +1,14 @@
+namespace Meadow.Peripherals.Displays;
+
+/// <summary>
+/// Defines a Display with a controllable backlight
+/// </summary>
+public interface IBacklitDisplay : IDisplay
+{
+    /// <summary>
+    /// Sets the backlight intensity.
+    /// </summary>
+    /// <param name="intensity">Intensity value</param>
+    /// <remarks>For displays with boolean power, use 0 for off and non-zero for on</remarks>
+    void SetBacklightIntensity(byte intensity);
+}