Use complex return type from OpenRGB source

Author: w-enterprises

AllMyLights.Test/Common/ColorConverterTest.cs

@@ -120,5 +120,15 @@ public void Should_convert_to_BGR_decimal(string hex, int expectedBgr)
 
             Assert.AreEqual(expectedBgr, color.ToBgrDecimal());
         }
+
+
+        [Test]
+        public void Should_convert_to_comma_separated_rgb_string()
+        {
+            var color = Color.FromArgb(10, 20, 30);
+            var actual = color.ToCommaSeparatedRgbString();
+
+            Assert.AreEqual("10,20,30", actual);
+        }
     }
 }

AllMyLights.Test/Connectors/OpenRGBSourceTest.cs

@@ -1,3 +1,6 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Reactive;
 using AllMyLights.Connectors.Sources.OpenRGB;
 using Microsoft.Reactive.Testing;
@@ -43,7 +46,7 @@ public void Should_emit_distinct_device_colors()
             var corsairH150i = new Device();
             corsairH150i.SetColors(red, green);
             corsairH150i.SetName("Corsair H150");
-            
+
             var devices = new Device[] {
                 corsairH150i
             };
@@ -79,21 +82,22 @@ public void Should_emit_distinct_device_colors()
             );
 
             var actual = scheduler.Start(
-             () => subject.Get(),
+             () => subject.Get() as IObservable<Dictionary<string, DeviceState>>,
              created: 0,
              subscribed: 0,
              disposed: 100
            );
 
 
-            string payload = $"{{\"Corsair H150\":{{\"Colors\":[\"#FF0000\",\"#00FF00\"]}}}}";
-            string payloadUpdated = $"{{\"Corsair H150\":{{\"Colors\":[\"#00FF00\",\"#0000FF\"]}}}}";
-
-            var expected = new Recorded<Notification<object>>[] {
-                OnNext(10, (object)payload),
-                OnNext(30, (object)payloadUpdated)
+            var deviceState = new DeviceState(new List<System.Drawing.Color> { red.ToSystemColor(), green.ToSystemColor() });
+            var deviceStateUpdated = new DeviceState(new List<System.Drawing.Color> { green.ToSystemColor(), blue.ToSystemColor() });
+            
+            var expected = new Recorded<Notification<Dictionary<string, DeviceState>>>[] {
+                OnNext(10, (Dictionary<string, DeviceState> actual) => actual["Corsair H150"].Colors.SequenceEqual(deviceState.Colors) ),
+                OnNext(30, (Dictionary<string, DeviceState> actual) => actual["Corsair H150"].Colors.SequenceEqual(deviceStateUpdated.Colors) ),
             };
 
+
             ReactiveAssert.AreElementsEqual(expected, actual.Messages);
         }
     }

AllMyLights.Test/Transformations/ExpressionTransformationTest.cs

@@ -1,7 +1,9 @@
+using System.Collections.Generic;
 using System.Drawing;
 using System.Reactive;
 using System.Reactive.Linq;
 using AllMyLights.Common;
+using AllMyLights.Connectors.Sources.OpenRGB;
 using AllMyLights.Transformations;
 using AllMyLights.Transformations.Expression;
 using Microsoft.Reactive.Testing;
@@ -122,5 +124,39 @@ public void Should_not_break_for_invalid_input()
 
             ReactiveAssert.AreElementsEqual(expected, actual.Messages);
         }
+
+        [Test]
+        public void Should_allow_usage_of_color_related_extensions_methods()
+        {
+            var input = new Dictionary<string, DeviceState>() {
+                { "Copperhead", new DeviceState(new Color[]{ Color.Red }) }
+            };
+            var source = Observable.Return(input);
+            var expressionExpectingColor = "value[\"Copperhead\"].Colors.Cast().First().ToCommaSeparatedRgbString()";
+            var expectation = "255,0,0";
+
+            var options = new ExpressionTransformationOptions()
+            {
+                Expression = expressionExpectingColor
+            };
+
+            var transformation = new ExpressionTransformation<string>(options);
+
+            var scheduler = new TestScheduler();
+
+            var actual = scheduler.Start(
+              () => transformation.GetOperator()(source),
+              created: 0,
+              subscribed: 10,
+              disposed: 100
+            );
+
+            var expected = new Recorded<Notification<string>>[] {
+                OnNext(10, expectation),
+                OnCompleted<string>(10)
+            };
+
+            ReactiveAssert.AreElementsEqual(expected, actual.Messages);
+        }
     }
 }

AllMyLights/Common/ColorConverter.cs

@@ -70,9 +70,12 @@ public static int ToBgrDecimal(this Color color)
         }
 
         public static  OpenRGB.NET.Models.Color ToOpenRGBColor(this Color color) => new OpenRGB.NET.Models.Color(color.R, color.G, color.B);
+        public static  Color ToSystemColor(this OpenRGB.NET.Models.Color color) => Color.FromArgb(color.R, color.G, color.B);
 
         public static string ToHexString(this Color c) => $"#{c.R:X2}{c.G:X2}{c.B:X2}";
 
+        public static string ToCommaSeparatedRgbString(this Color c) => $"{c.R},{c.G},{c.B}";
+
         public static string ToHexString(this OpenRGB.NET.Models.Color c) => $"#{c.R:X2}{c.G:X2}{c.B:X2}";
 
         private static void FromHex(string hex, out byte a, out byte r, out byte g, out byte b)

AllMyLights/Connectors/Sources/OpenRGB/DeviceState.cs

@@ -1,12 +1,13 @@
 using System.Collections.Generic;
+using System.Drawing;
 
 namespace AllMyLights.Connectors.Sources.OpenRGB
 {
     public struct DeviceState
     {
-        public IEnumerable<string> Colors;
+        public IEnumerable<Color> Colors;
 
-        public DeviceState(IEnumerable<string> colors)
+        public DeviceState(IEnumerable<Color> colors)
         {
             Colors = colors;
         }

AllMyLights/Connectors/Sources/OpenRGB/OpenRGBSource.cs

@@ -16,7 +16,7 @@ public class OpenRGBSource: Source
         protected override IObservable<object> Value { get; }
 
         private IOpenRGBClient Client { get; }
-        private readonly ReplaySubject<string> Subject = new ReplaySubject<string>(1);
+        private readonly ReplaySubject<Dictionary<string, DeviceState>> Subject = new ReplaySubject<Dictionary<string, DeviceState>>(1);
 
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 
@@ -52,11 +52,11 @@ IObservable<long> pollingInterval
                 {
                     deviceStates.Add(it.Name, new DeviceState()
                     {
-                        Colors = it.Colors.Select(color => color.ToHexString())
+                        Colors = it.Colors.Select(color => color.ToSystemColor())
                     });
                 });
 
-                Subject.OnNext(JsonConvert.SerializeObject(deviceStates));
+                Subject.OnNext(deviceStates);
             });
         }
     }

AllMyLights/Transformations/Expression/ExpressionTransformation.cs

@@ -1,10 +1,11 @@
 using System;
 using System.Collections.Generic;
-using SystemColor = System.Drawing.Color;
+using System.Linq;
 using System.Reactive.Linq;
 using AllMyLights.Common;
 using CodingSeb.ExpressionEvaluator;
 using NLog;
+using SystemColor = System.Drawing.Color;
 
 namespace AllMyLights.Transformations.Expression
 {
@@ -24,6 +25,8 @@ public class ExpressionTransformation<T>: ITransformation<T>  where T: class
         public ExpressionTransformation(ExpressionTransformationOptions options)
         {
             Expression = options.Expression;
+            Evaluator.StaticTypesForExtensionsMethods.Add(typeof(ColorConverter));
+            Evaluator.StaticTypesForExtensionsMethods.Add(typeof(Enumerable));
         }
 
         public Func<IObservable<object>, IObservable<T>> GetOperator()
@@ -34,7 +37,12 @@ public Func<IObservable<object>, IObservable<T>> GetOperator()
                 {
                     try
                     {
-                        var value = input is Ref<SystemColor> ? (input as Ref<SystemColor>).Value : input;
+                        var value = input switch
+                        {
+                            Ref<SystemColor> r => r.Value,
+                            _ => input
+                        };
+
                         Evaluator.Variables["value"] = value;
 
                         Logger.Debug($"Expression received value {value}");

AllMyLights/allmylightsrc.json

@@ -17,6 +17,17 @@
           "ChannelLayout": "_RGB"
         }
       ]
+    },
+    {
+      "Type": "OpenRGB",
+      "Server": "192.168.178.120",
+      "Port": 6742,
+      "Transformations": [
+        {
+          "Type": "Expression",
+          "Expression": "value[\"Corsair H150i PRO RGB\"].Colors.Cast().First().ToCommaSeparatedRgbString()"
+        }
+      ]
     }
   ],
   "Sinks": [

README.md

@@ -190,19 +190,19 @@ that topic.
 
 ```json5
 {
-    "Type" : "Mqtt",
-    "Server": "192.168.1.20",
-    "Port": 1883,
-    "Topics": {
-      // optional command topic that is used to request the current color on startup
-      "Command": "cmnd/sonoff-1144-dimmer-5/color",
-      "Result": "stat/sonoff-1144-dimmer-5/RESULT"
-    },
-    // transformations are applied in order on any received message 
-    "Transformations": [
-      // ... see section transformations for options
-    ]
-  }
+  "Type" : "Mqtt",
+  "Server": "192.168.1.20",
+  "Port": 1883,
+  "Topics": {
+    // optional command topic that is used to request the current color on startup
+    "Command": "cmnd/sonoff-1144-dimmer-5/color",
+    "Result": "stat/sonoff-1144-dimmer-5/RESULT"
+  },
+  // transformations are applied in order on any received message 
+  "Transformations": [
+    // ... see section transformations for options
+  ]
+}
 ```
 
 
@@ -212,36 +212,35 @@ a json that contains the colors per device if any device state changed.
 
 ```json5
 {
-    "Type" : "OpenRGB",
-    "Server": "127.0.0.1",
-    "Port": 6742,
-    // controls how often OpenRGB is asked for changes, default is 1000ms
-    "PollingInterval": 1000,
-    // transformations are applied in order on any received message 
-    "Transformations": [
-      // ... see section transformations for options
-    ]
-  }
+  "Type" : "OpenRGB",
+  "Server": "127.0.0.1",
+  "Port": 6742,
+  // controls how often OpenRGB is asked for changes, default is 1000ms
+  "PollingInterval": 1000,
+  // transformations are applied in order on any received message 
+  "Transformations": [
+    // ... see section transformations for options
+  ]
+}
 ```
 
-The returned json looks as follows, where for each LED on your device 
-one color is returned:
+The produced value is of type `Dictionary<string, DeviceState>()` where the
+key is the name of your OpenRGB device and `DeviceState` is a struct that
+has the following properties:
 
-```json5
+```csharp
+public struct DeviceState
 {
-  "Corsair H150": {
-    "Colors": [ "#FF0000", "#00FF00" ]
-  }
+    public IEnumerable<Color> Colors;
 }
 ```
 
-To extract a single color value from that payload, you could use a 
-[`JsonPath`](#jsonpath) transformation such as 
+To extract values from it, use the [`Expression`](#expression) transformation such as 
 
 ```json5
 {
-  "Type": "JsonPath",
-  "Expression": "$['Corsair H150i PRO RGB'].Colors[0]"
+  "Type": "Expression",
+  "Expression": "value[\"Corsair H150i PRO RGB\"].Colors.Cast().First().ToCommaSeparatedRgbString()"
 }
 ```