Version

CShocker/CShocker.csproj

@@ -7,7 +7,7 @@
         <Authors>Glax</Authors>
         <RepositoryUrl>https://github.com/C9Glax/CShocker</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
-        <Version>2.3.1</Version>
+        <Version>2.4.0</Version>
     </PropertyGroup>
 
     <ItemGroup>

CShocker/Devices/APIs/OpenShockHttp.cs

@@ -19,7 +19,7 @@ public class OpenShockHttp : OpenShockApi
         string json = "{" +
                       "  \"shocks\": [" +
                       "    {" +
-                      $"      \"id\": \"{openShockShocker.id}\"," +
+                      $"      \"id\": \"{openShockShocker.ID}\"," +
                       $"      \"type\": {ControlActionToByte(action)}," +
                       $"      \"intensity\": {intensity}," +
                       $"      \"duration\": {duration}" +

CShocker/Devices/APIs/OpenShockSerial.cs

@@ -36,8 +36,8 @@ public class OpenShockSerial : OpenShockApi
             return;
         }
         string json = "rftransmit {" +
-                        $"\"model\":\"{Enum.GetName(openShockShocker.model)!.ToLower()}\"," +
-                        $"\"id\":{openShockShocker.rfId}," +
+                        $"\"model\":\"{Enum.GetName(openShockShocker.Model)!.ToLower()}\"," +
+                        $"\"id\":{openShockShocker.RfId}," +
                         $"\"type\":\"{ControlActionToString(action)}\"," +
                         $"\"intensity\":{intensity}," +
                         $"\"durationMs\":{duration}" +

CShocker/Devices/APIs/PiShockHttp.cs

@@ -8,8 +8,8 @@ namespace CShocker.Devices.APIs;
 
 public class PiShockHttp : PiShockApi
 {
-    // ReSharper disable twice MemberCanBePrivate.Global external usage
-    public string Username, Endpoint, ApiKey;
+    // ReSharper disable thrice MemberCanBePrivate.Global -> Exposed
+    public readonly string Username, Endpoint, ApiKey;
 
     public PiShockHttp(string apiKey, string username, string endpoint = "https://do.pishock.com/api/apioperate", ILogger? logger = null) : base(DeviceApi.PiShockHttp, logger)
     {

CShocker/Devices/APIs/PiShockSerial.cs

@@ -1,7 +1,6 @@
 using System.IO.Ports;
 using CShocker.Devices.Abstract;
 using CShocker.Devices.Additional;
-using CShocker.Ranges;
 using CShocker.Shockers.Abstract;
 using Microsoft.Extensions.Logging;
 
@@ -10,7 +9,8 @@ namespace CShocker.Devices.APIs;
 public class PiShockSerial : PiShockApi
 {
     private const int BaudRate = 115200;
-    public SerialPortInfo SerialPortI;
+    // ReSharper disable once MemberCanBePrivate.Global -> Exposed
+    public readonly SerialPortInfo SerialPortI;
     private readonly SerialPort _serialPort;
     
     public PiShockSerial(DeviceApi apiType, SerialPortInfo serialPortI, ILogger? logger = null) : base(apiType, logger)

CShocker/Devices/Abstract/Api.cs

@@ -7,7 +7,7 @@ namespace CShocker.Devices.Abstract;
 
 public abstract class Api : IDisposable
 {
-    // ReSharper disable 4 times MemberCanBePrivate.Global external use
+    // ReSharper disable 4 times MemberCanBePrivate.Global -> Exposed
     protected ILogger? Logger;
     public readonly DeviceApi ApiType;
     private readonly Queue<ValueTuple<ControlAction, Shocker, int, int>> _queue = new();
@@ -25,12 +25,12 @@ public abstract class Api : IDisposable
             this.Logger?.Log(LogLevel.Information, "No action defined.");
             enqueueItem = false;
         }
-        if (!ValidIntensityRange.ValueWithinLimits(intensity))
+        if (!ValidIntensityRange.IsValueWithinLimits(intensity))
         {
             this.Logger?.Log(LogLevel.Information, $"Value not within allowed {nameof(intensity)}-Range ({ValidIntensityRange.RangeString()}): {intensity}");
             enqueueItem = false;
         }
-        if (!ValidDurationRange.ValueWithinLimits(duration))
+        if (!ValidDurationRange.IsValueWithinLimits(duration))
         {
             this.Logger?.Log(LogLevel.Information, $"Value not within allowed {nameof(duration)}-Range ({ValidIntensityRange.RangeString()}): {duration}");
             enqueueItem = false;
@@ -42,7 +42,7 @@ public abstract class Api : IDisposable
         }
         foreach (Shocker shocker in shockers)
         {
-            this.Logger?.Log(LogLevel.Debug, $"Enqueueing {action} {intensity} {duration}");
+            this.Logger?.Log(LogLevel.Debug, $"Enqueueing {action} Intensity: {intensity} Duration: {duration}\nShocker:\n{shocker}");
             _queue.Enqueue(new(action, shocker, intensity, duration));
         }
     }
@@ -64,7 +64,7 @@ public abstract class Api : IDisposable
         while (_workOnQueue)
             if (_queue.Count > 0 && _queue.Dequeue() is { } action)
             {
-                this.Logger?.Log(LogLevel.Information, $"{action.Item1} {action.Item2} {action.Item3} {action.Item4}");
+                this.Logger?.Log(LogLevel.Information, $"Executing: {Enum.GetName(action.Item1)} Intensity: {action.Item3} Duration: {action.Item4}\nShocker:\n{action.Item2.ToString()}");
                 ControlInternal(action.Item1, action.Item2, action.Item3, action.Item4);
                 Thread.Sleep(action.Item4 + CommandDelay);
             }
@@ -92,7 +92,7 @@ public abstract class Api : IDisposable
 
     public override int GetHashCode()
     {
-        return HashCode.Combine(ApiType);
+        return ApiType.GetHashCode();
     }
 
     public void Dispose()

CShocker/Devices/Abstract/OpenShockApi.cs

@@ -8,10 +8,12 @@ namespace CShocker.Devices.Abstract;
 
 public abstract class OpenShockApi : Api
 {
+    // ReSharper disable twice MemberCanBeProtected.Global -> Exposed
     public string Endpoint { get; init; }
     public string ApiKey { get; init; }
     private const string DefaultEndpoint = "https://api.shocklink.net";
 
+    // ReSharper disable once PublicConstructorInAbstractClass -> Exposed
     public OpenShockApi(DeviceApi apiType, string apiKey, string endpoint = DefaultEndpoint, ILogger? logger = null) : base(apiType, new IntegerRange(0, 100), new IntegerRange(300, 30000), logger)
     {
         this.Endpoint = endpoint;
@@ -25,7 +27,7 @@ public abstract class OpenShockApi : Api
 
     private bool Equals(OpenShockApi other)
     {
-        return base.Equals(other) && Endpoint == other.Endpoint && ApiKey == other.ApiKey;
+        return base.Equals(other) && Endpoint.Equals(other.Endpoint) && ApiKey.Equals(other.ApiKey);
     }
 
     public override int GetHashCode()
@@ -33,12 +35,13 @@ public abstract class OpenShockApi : Api
         return HashCode.Combine(Endpoint, ApiKey);
     }
 
-    public List<OpenShockShocker> GetShockers()
+    public IEnumerable<OpenShockShocker> GetShockers()
     {
         return GetShockers(this.ApiKey, this, this.Endpoint, this.Logger);
     }
 
-    public static List<OpenShockShocker> GetShockers(string apiKey, OpenShockApi api, string apiEndpoint = DefaultEndpoint, ILogger? logger = null)
+    // ReSharper disable once MemberCanBePrivate.Global
+    public static IEnumerable<OpenShockShocker> GetShockers(string apiKey, OpenShockApi api, string apiEndpoint = DefaultEndpoint, ILogger? logger = null)
     {
         List<OpenShockShocker> shockers = new();
         

CShocker/Devices/Abstract/SerialPortInfo.cs

@@ -1,7 +1,8 @@
 namespace CShocker.Devices.Abstract;
 
-public struct SerialPortInfo
+public readonly struct SerialPortInfo
 {
+    // ReSharper disable thrice MemberCanBePrivate.Global -> Exposed
     public readonly string? PortName, Description, Manufacturer, DeviceID;
 
     public SerialPortInfo(string? portName, string? description, string? manufacturer, string? deviceID)
@@ -14,7 +15,12 @@ public struct SerialPortInfo
 
     public override string ToString()
     {
-        return
-            $"{GetType().Name}\nPortName: {PortName}\nDescription: {Description}\nManufacturer: {Manufacturer}\nDeviceID: {DeviceID}\n\r";
+        return $"{string.Join("\n\t",
+            $"{GetType().Name}",
+            $"PortName: {PortName}",
+            $"Description: {Description}",
+            $"Manufacturer: {Manufacturer}",
+            $"DeviceID: {DeviceID}")}" +
+               $"\n\r";
     }
 }

CShocker/Devices/Additional/ApiHttpClient.cs

@@ -26,14 +26,19 @@ public static class ApiHttpClient
                 new StringContent(jsonContent, Encoding.UTF8, new MediaTypeHeaderValue("application/json"));
         foreach ((string, string) customHeader in customHeaders)
             request.Headers.Add(customHeader.Item1, customHeader.Item2);
-        logger?.Log(LogLevel.Debug, $"Request-URI: {request.RequestUri}\n\r" +
-                                         $"Request-Headers: \n\t{string.Join("\n\t", request.Headers.Select(h => $"{h.Key} {string.Join(", ", h.Value)}"))}\n\r" +
-                                         $"Request-Content: {request.Content?.ReadAsStringAsync().Result}");
+        logger?.Log(LogLevel.Debug, string.Join("\n\t",
+                "Request:",
+                $"\u251c\u2500\u2500 URI: {request.RequestUri}",
+                $"\u251c\u2500\u2510 Headers: {string.Concat(request.Headers.Select(h => $"\n\t\u2502 {(request.Headers.Last().Key.Equals(h.Key) ? "\u2514" : "\u251c")} {h.Key}: {string.Join(", ", h.Value)}"))}", 
+                $"\u2514\u2500\u2500 Content: {request.Content?.ReadAsStringAsync().Result}"));
 
         HttpClient httpClient = new();
         HttpResponseMessage response = httpClient.Send(request);
-        logger?.Log(!response.IsSuccessStatusCode ? LogLevel.Error : LogLevel.Debug,
-            $"{request.RequestUri} response: {response.StatusCode}");
+        logger?.Log(!response.IsSuccessStatusCode ? LogLevel.Error : LogLevel.Debug, string.Join("\n\t",
+            "Request:",
+            $"\u251c\u2500\u2500 URI: {request.RequestUri}",
+            $"\u251c\u2500\u2510 Headers: {string.Concat(response.Headers.Select(h => $"\n\t\u2502 {(response.Headers.Last().Key.Equals(h.Key) ? "\u2514" : "\u251c")} {h.Key}: {string.Join(", ", h.Value)}"))}", 
+            $"\u2514\u2500\u2500 Content: {response.Content?.ReadAsStringAsync().Result}"));
         httpClient.Dispose();
         return response;
     }

CShocker/Devices/Additional/ApiJsonConverter.cs

@@ -26,7 +26,7 @@ public class ApiJsonConverter : JsonConverter
             case DeviceApi.PiShockHttp:
                 return jo.ToObject<PiShockHttp>()!;
             case DeviceApi.PiShockSerial:
-                throw new NotImplementedException();
+                return jo.ToObject<PiShockSerial>()!;
             default:
                 throw new Exception();
         }

CShocker/Ranges/IntegerRange.cs

@@ -2,6 +2,7 @@
 
 public readonly struct IntegerRange
 {
+    // ReSharper disable twice MemberCanBePrivate.Global -> Exposed
     public readonly int Min, Max;
 
     public IntegerRange(int min, int max)
@@ -10,11 +11,16 @@ public readonly struct IntegerRange
         this.Max = max;
     }
 
-    public bool ValueWithinLimits(int value)
+    public bool IsValueWithinLimits(int value)
     {
         return value >= this.Min && value <= this.Max;
     }
 
+    public int RandomValueWithinLimits()
+    {
+        return Random.Shared.Next(this.Min, this.Max);
+    }
+
     internal string RangeString()
     {
         return $"{this.Min}-{this.Max}";

CShocker/Shockers/Abstract/Shocker.cs

@@ -5,6 +5,7 @@ namespace CShocker.Shockers.Abstract;
 
 public abstract class Shocker : IDisposable
 {
+    // ReSharper disable once MemberCanBePrivate.Global -> Exposed
     public Api Api { get; }
 
     internal Shocker(Api api)

CShocker/Shockers/Additional/ShockerJsonConverter.cs

@@ -22,7 +22,6 @@ public class ShockerJsonConverter : JsonConverter
         {
             return jo.ToObject<PiShockShocker>(serializer)!;
         }
-        throw new Exception();
     }
 
     public override bool CanWrite => false;
@@ -32,6 +31,6 @@ public class ShockerJsonConverter : JsonConverter
     /// </summary>
     public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
     {
-        throw new Exception("Dont call this");
+        throw new NotImplementedException("Dont call this");
     }
 }

CShocker/Shockers/OpenShockShocker.cs

@@ -1,29 +1,27 @@
-using System.Diagnostics.CodeAnalysis;
-using CShocker.Devices.Abstract;
+using CShocker.Devices.Abstract;
 using CShocker.Shockers.Abstract;
 
 namespace CShocker.Shockers;
 
-#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
-[SuppressMessage("ReSharper", "InconsistentNaming")]
 public class OpenShockShocker : Shocker
 {
-    public string name, id;
-    public short rfId;
-    public OpenShockModel model;
-    public DateTime createdOn;
-    public bool isPaused;
+    // ReSharper disable thrice MemberCanBePrivate.Global -> Exposed
+    public readonly string Name, ID;
+    public readonly short RfId;
+    public readonly OpenShockModel Model;
+    public readonly DateTime CreatedOn;
+    public readonly bool IsPaused;
 
     public OpenShockShocker(Api api, string name, string id, short rfId, OpenShockModel model, DateTime createdOn, bool isPaused) : base (api)
     {
         if (api is not OpenShockApi)
             throw new Exception($"API-Type {api.GetType().FullName} is not usable with Shocker {this.GetType().FullName}");
-        this.name = name;
-        this.id = id;
-        this.rfId = rfId;
-        this.model = model;
-        this.createdOn = createdOn;
-        this.isPaused = isPaused;
+        this.Name = name;
+        this.ID = id;
+        this.RfId = rfId;
+        this.Model = model;
+        this.CreatedOn = createdOn;
+        this.IsPaused = isPaused;
     }
 
     public enum OpenShockModel : byte
@@ -34,13 +32,16 @@ public class OpenShockShocker : Shocker
 
     public override string ToString()
     {
-        return $"{GetType().Name}\n" +
-               $"Name: {name}\n" +
-               $"ID: {id}\n" +
-               $"RF-ID: {rfId}\n" +
-               $"Model: {Enum.GetName(model)}\n" +
-               $"Created On: {createdOn}\n" +
-               $"Paused: {isPaused}\n\r";
+        const int tabWidth = -12;
+        return $"\t{string.Join("\n\t",
+            $"\u251c {"Type",tabWidth}: {GetType().Name}",
+            $"\u251c {"Name",tabWidth}: {Name}",
+            $"\u251c {"ID",tabWidth}: {ID}",
+            $"\u251c {"RF-ID",tabWidth}: {RfId}",
+            $"\u251c {"Model",tabWidth}: {Enum.GetName(Model)}",
+            $"\u251c {"Created On",tabWidth}: {CreatedOn}",
+            $"\u2514 {"Paused",tabWidth}: {IsPaused}")}" +
+               $"\n\r";
     }
 
     public override bool Equals(object? obj)
@@ -51,11 +52,11 @@ public class OpenShockShocker : Shocker
 
     private bool Equals(OpenShockShocker other)
     {
-        return id == other.id && rfId == other.rfId && model == other.model && createdOn.Equals(other.createdOn);
+        return ID == other.ID;
     }
 
     public override int GetHashCode()
     {
-        return HashCode.Combine(id, rfId, (int)model, createdOn);
+        return ID.GetHashCode();
     }
 }

CShocker/Shockers/PiShockShocker.cs

@@ -5,7 +5,14 @@ namespace CShocker.Shockers;
 
 public class PiShockShocker : Shocker
 {
-    public string Code;
+    public readonly string Code;
+
+    public PiShockShocker(Api api, string code) : base(api)
+    {
+        if (api is not PiShockApi)
+            throw new Exception($"API-Type {api.GetType().FullName} is not usable with Shocker {this.GetType().FullName}");
+        Code = code;
+    }
 
     public override bool Equals(object? obj)
     {
@@ -21,11 +28,13 @@ public class PiShockShocker : Shocker
     {
         return Code.GetHashCode();
     }
-
-    public PiShockShocker(Api api, string code) : base(api)
+    
+    public override string ToString()
     {
-        if (api is not PiShockApi)
-            throw new Exception($"API-Type {api.GetType().FullName} is not usable with Shocker {this.GetType().FullName}");
-        Code = code;
+        const int tabWidth = -5;
+        return $"{string.Join("\n\t",
+            $"\u251c {"Type",tabWidth}: {GetType().Name}",
+            $"\u2514 {"Code",tabWidth}: {Code}")}" +
+               $"\n\r";
     }
 }

TestApp/TestApp.csproj

@@ -12,9 +12,7 @@
     </ItemGroup>
 
     <ItemGroup>
-      <Reference Include="GlaxLogger">
-        <HintPath>..\..\GlaxLogger\GlaxLogger\bin\Debug\net7.0\GlaxLogger.dll</HintPath>
-      </Reference>
+      <PackageReference Include="GlaxLogger" Version="1.0.6" />
     </ItemGroup>
 
 </Project>