feature/website-live-updates

GpioController/Controllers/GpioController.cs

@@ -19,7 +19,8 @@
             return Unauthorized();
 
         var gpios = gpioService.GetGpios();
-        var filteredResults = gpioService.OrderResultsByFilter(gpios);
+        var mappedResults = gpioService.MapGpioNames(gpios);
+        var filteredResults = gpioService.OrderResultsByFilter(mappedResults);
 
         return Ok(filteredResults);
     }

GpioController/Models/AuthorizationSettings.cs

@@ -3,5 +3,5 @@ namespace GpioController.Models;
 public class AuthorizationSettings
 {
     public required bool Enabled { get; set; }
-    public required List<string> AuthorizedEmails { get; set; }
+    public required List<string> AuthorizedEmails { get; set; } = new();
 }

GpioController/Models/FilterSettings.cs

@@ -2,12 +2,6 @@ namespace GpioController.Models;
 
 public class FilterSettings
 {
-    public FilterSettings()
-    {
-        AllowOnlyTheseChipsets = new();
-        AllowOnlyTheseGpios = new();
-    }
-
-    public List<int> AllowOnlyTheseChipsets { get; set; }
-    public List<int> AllowOnlyTheseGpios { get; set; }
+    public List<int> AllowOnlyTheseChipsets { get; set; } = new();
+    public List<int> AllowOnlyTheseGpios { get; set; } = new();
 }

GpioController/Models/MappingSettings.cs

@@ -0,0 +1,12 @@
+namespace GpioController.Models;
+
+public class MappingSettings
+{
+    public List<Map> GpioNames { get; set; } = new();
+}
+
+public class Map
+{
+    public int Id { get; set; }
+    public required string Name { get; set; }
+}

GpioController/Program.cs

@@ -26,6 +26,10 @@ public static void Main(string[] args)
             builder.Configuration.GetSection("Filters")
         );
 
+        builder.Services.Configure<MappingSettings>(
+            builder.Configuration.GetSection("Mappings")
+        );
+
         var requireAuth = builder.Configuration.GetValue<bool>("Authorization:Enabled");
 
         if (requireAuth)

GpioController/Services/GpioService.cs

@@ -7,7 +7,7 @@
 
 namespace GpioController.Services;
 
-public class GpioService(ICommandFactory commandFactory, IOptions<FilterSettings> filterSettings) : IGpioService
+public class GpioService(ICommandFactory commandFactory, IOptions<FilterSettings> filterSettings, IOptions<MappingSettings> mappingSettings) : IGpioService
 {
     public IEnumerable<Gpio> GetGpios()
     {
@@ -28,6 +28,23 @@ public IEnumerable<Gpio> GetGpios()
         return results;
     }
 
+    public IEnumerable<Gpio?> MapGpioNames(IEnumerable<Gpio> results)
+    {
+        var nameMap = mappingSettings?.Value?.GpioNames ?? [];
+
+        if (!results.Any() || !nameMap.Any()) return results;
+
+        var mapById = nameMap.ToDictionary(m => m.Id, m => m.Name);
+
+        foreach (var gpio in results)
+        {
+            if (mapById.TryGetValue(gpio.Id, out var customMappedName))
+                gpio.Name = customMappedName;
+        }
+
+        return results;
+    }
+
     public IEnumerable<Gpio?> OrderResultsByFilter(IEnumerable<Gpio> results)
     {
         var filter = filterSettings?.Value?.AllowOnlyTheseGpios ?? [];

GpioController/Services/IGpioService.cs

@@ -7,5 +7,6 @@ public interface IGpioService
 {
     IEnumerable<Gpio> GetGpios();
     Gpio GetGpioById(int chipsetId, int gpioId);
+    IEnumerable<Gpio?> MapGpioNames(IEnumerable<Gpio> results);
     IEnumerable<Gpio?> OrderResultsByFilter(IEnumerable<Gpio> results);
 }

GpioController/appsettings.json

@@ -17,6 +17,9 @@
     "AllowOnlyTheseChipsets": [],
     "AllowOnlyTheseGpios": []
   },
+  "Mappings":{
+    "GpioNames":[]
+  },
   "Logging": {
     "LogLevel": {
       "Default": "Information",

GpioControllerTests/Services/GpioServiceTests.cs

@@ -14,15 +14,17 @@
 {
     private ICommandFactory commandFactory;
     private IOptions<FilterSettings> filterSettings;
+    private IOptions<MappingSettings> mappingSettings;
     private ICommand<GpioInfoRequest, GpioInfoResult> command;
 
     public GpioService GetSystemUnderTest()
     {
         command = A.Fake<ICommand<GpioInfoRequest, GpioInfoResult>>();
         commandFactory = A.Fake<ICommandFactory>();
         filterSettings = A.Fake<IOptions<FilterSettings>>();
+        mappingSettings = A.Fake<IOptions<MappingSettings>>();
 
-        return new GpioService(commandFactory, filterSettings);
+        return new GpioService(commandFactory, filterSettings, mappingSettings);
     }
 
     [Fact]
@@ -107,9 +109,9 @@
 
         var result = sut.OrderResultsByFilter(data).ToArray();
 
         result[0].Id.Should().Be(81);
         result[1].Id.Should().Be(95);
         result[2].Id.Should().Be(80);
     }
 
     [Fact]
@@ -147,8 +149,98 @@
 
         var result = sut.OrderResultsByFilter(data).ToArray();
 
         result[0].Id.Should().Be(95);
         result[1].Id.Should().Be(80);
         result[2].Id.Should().Be(81);
     }
+
+    [Fact]
+    public void MapGpioNames_WhenCustomMapsAreDefined_MapsNamesCorrectly()
+    {
+        var sut = GetSystemUnderTest();
+
+        A.CallTo(() => mappingSettings.Value).Returns(new MappingSettings
+        {
+           GpioNames =
+           [
+               new Map
+               {
+                   Id = 91,
+                   Name = "VCC"
+               },
+               new Map
+               {
+                   Id = 92,
+                   Name = "Common"
+               },
+               new Map
+               {
+                   Id = 81,
+                   Name = "Zone 1"
+               }
+           ]
+        });
+
+        var data = new List<Gpio>
+        {
+            new()
+            {
+                Chipset = 1,
+                Id = 91,
+                Name = "Gpio 91"
+            },
+            new()
+            {
+                Chipset = 1,
+                Id = 92,
+                Name = "Gpio 92"
+            },
+            new()
+            {
+                Chipset = 1,
+                Id = 81,
+                Name = "Gpio 81"
+            }
+        };
+
+        var result = sut.MapGpioNames(data).ToArray();
+
+        result[0].Name.Should().Be("VCC");
+        result[1].Name.Should().Be("Common");
+        result[2].Name.Should().Be("Zone 1");
+    }
+
+    [Fact]
+    public void MapGpioNames_WhenNoMapsAreDefined_DoesNotError()
+    {
+        var sut = GetSystemUnderTest();
+
+        A.CallTo(() => mappingSettings.Value).Returns(new MappingSettings());
+
+        var data = new List<Gpio>
+        {
+            new()
+            {
+                Chipset = 1,
+                Id = 91,
+                Name = "Gpio 91"
+            },
+            new()
+            {
+                Chipset = 1,
+                Id = 92,
+                Name = "Gpio 92"
+            },
+            new()
+            {
+                Chipset = 1,
+                Id = 81,
+                Name = "Gpio 81"
+            }
+        };
+
+        var result = sut.MapGpioNames(data).ToArray();
+
+        result.Should().BeEquivalentTo(data);
+    }
 }

README.md

@@ -297,6 +297,28 @@ To update your API settings, refer to the [AppSettings](https://github.com/Spark
 - `Filters:AllowOnlyTheseGpios` - `GET /sbc/chipsets/gpios` will usually return all <b>GPIOs</b> from your board. Some projects only require a subset of these. Adding IDs here filters results.
     - Example: `[91, 92, 81,95,80,79,94,93]`
 
+### Mappings:
+
+- `Mappings:GpioNames` - `GET /sbc/chipsets/gpios` will usually return the names assigned by the SBC. If you'd like to return custom names in their place, use this setting. 
+  - Example: ```[
+      {
+      "Id": 91,
+      "Name": "VCC Power"
+      },
+      {
+        "Id": 92,
+        "Name": "Common"
+      },
+      {
+        "Id": 81,
+        "Name": "Zone 1"
+      },
+      {
+        "Id": 85,
+        "Name": "Zone 2"
+      }
+]```
+
 
 <b>Important!</b><br/>If you expose your IP and Port to the public (By adding a rule to your router / firewall) it is <b>highly recommended</b> to set `Authorization:Enabled` to `true`. Without it, anybody can call your API.
 <br/>