Merge pull request #867 from WildernessLabs/bug/relay

Updated relay to use open/closed semantics
WildernessLabs · Dec 20, 2023 · 61ea208 · 61ea208
2 parents 49bf560 + e9de355
commit 61ea208
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 16 deletions.
diff --git a/Source/Meadow.Foundation.Core.Samples/Relays.Relay_Sample/MeadowApp.cs b/Source/Meadow.Foundation.Core.Samples/Relays.Relay_Sample/MeadowApp.cs
@@ -1,6 +1,7 @@
 using Meadow;
 using Meadow.Devices;
 using Meadow.Foundation.Relays;
+using Meadow.Peripherals.Relays;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -23,14 +24,16 @@ public override Task Initialize()
 
         public override Task Run()
         {
-            var state = false;
-
             while (true)
             {
-                state = !state;
-
-                Resolver.Log.Info($"- State: {state}");
-                relay.IsOn = state;
+                var newState = relay.State switch
+                {
+                    RelayState.Open => RelayState.Closed,
+                    _ => RelayState.Open
+                };
+
+                Resolver.Log.Info($"- State: {newState}");
+                relay.State = newState;
 
                 Thread.Sleep(500);
             }

diff --git a/Source/Meadow.Foundation.Core/Relays/Relay.cs b/Source/Meadow.Foundation.Core/Relays/Relay.cs
@@ -9,8 +9,11 @@ namespace Meadow.Foundation.Relays
     /// </summary>
     public class Relay : IRelay
     {
+        private RelayState _state;
+        private readonly bool _closedValue = true;
+
         /// <inheritdoc/>
-        public event EventHandler<bool> OnRelayChanged = default!;
+        public event EventHandler<RelayState> OnChanged = default!;
 
         /// <summary>
         /// Returns digital output port
@@ -25,18 +28,21 @@ public class Relay : IRelay
         /// <summary>
         /// Whether or not the relay is on. Setting this property will turn it on or off.
         /// </summary>
-        public bool IsOn
+        public RelayState State
         {
-            get => isOn;
+            get => _state;
             set
             {
-                isOn = value;
-                DigitalOut.State = isOn ? onValue : !onValue;
-                OnRelayChanged?.Invoke(this, isOn);
+                _state = value;
+                DigitalOut.State = State switch
+                {
+                    RelayState.Open => !_closedValue,
+                    _ => _closedValue
+                };
+
+                OnChanged?.Invoke(this, State);
             }
         }
-        bool isOn = false;
-        readonly bool onValue = true;
 
         /// <summary>
         /// Creates a new Relay on an IDigitalOutputPort.
@@ -58,7 +64,7 @@ public Relay(IDigitalOutputPort port, RelayType type = RelayType.NormallyOpen)
         {
             // if it's normally closed, we have to invert the "on" value
             Type = type;
-            onValue = Type != RelayType.NormallyClosed;
+            _closedValue = Type != RelayType.NormallyClosed;
 
             DigitalOut = port;
         }
@@ -68,7 +74,11 @@ public Relay(IDigitalOutputPort port, RelayType type = RelayType.NormallyOpen)
         /// </summary>
         public void Toggle()
         {
-            IsOn = !IsOn;
+            State = State switch
+            {
+                RelayState.Open => RelayState.Closed,
+                _ => RelayState.Open,
+            };
         }
     }
 }