Merge pull request #103 from K-Society/experimental

Experimental
K-Society · Jan 15, 2024 · fdfded3 · fdfded3
2 parents f06bb2f + 28b330c
commit fdfded3
Show file tree

Hide file tree

Showing 9 changed files with 114 additions and 90 deletions.
diff --git a/README.md b/README.md
@@ -122,8 +122,29 @@ You can get KSociety.SharpCubeProgrammer by [grabbing the latest NuGet package](
 
 - Register SharpCubeProgrammer as service with Autofac IoC:
 
+Create the module for Autofac in a dedicated file (in this example under the Bindings folder) with the following contents:
+
+```csharp
+namespace MyNamespace.Bindings
+{
+    using Autofac;
+    using KSociety.SharpCubeProgrammer;
+    using KSociety.SharpCubeProgrammer.Interface;
+
+    public class ProgrammerApi : Module
+    {
+        protected override void Load(ContainerBuilder builder)
+        {
+            builder.RegisterType<CubeProgrammerApi>().As<ICubeProgrammerApi>().SingleInstance();
+        }
+    }
+}
+```
+
+Register the module:
+
 ```csharp
-builder.RegisterModule(new KSociety.SharpCubeProgrammer.Bindings.ProgrammerApi());
+builder.RegisterModule(new Bindings.ProgrammerApi());
 ```
 
 - Get ST-Link list and connect:
@@ -165,4 +186,5 @@ The project is under Microsoft Reciprocal License [(MS-RL)](http://www.opensourc
 
 List of technologies, frameworks and libraries used for implementation:
 
-- [KSociety.Wmi](https://github.com/K-Society/KSociety.Wmi) (WMI)
+- [Microsoft.Bcl.AsyncInterfaces](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces)
+- [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions)
diff --git a/docs/KSociety.SharpCubeProgrammer/README.md b/docs/KSociety.SharpCubeProgrammer/README.md
@@ -121,8 +121,29 @@ You can get KSociety.SharpCubeProgrammer by [grabbing the latest NuGet package](
 
 - Register SharpCubeProgrammer as service with Autofac IoC:
 
+Create the module for Autofac in a dedicated file (in this example under the Bindings folder) with the following contents:
+
+```csharp
+namespace MyNamespace.Bindings
+{
+    using Autofac;
+    using KSociety.SharpCubeProgrammer;
+    using KSociety.SharpCubeProgrammer.Interface;
+
+    public class ProgrammerApi : Module
+    {
+        protected override void Load(ContainerBuilder builder)
+        {
+            builder.RegisterType<CubeProgrammerApi>().As<ICubeProgrammerApi>().SingleInstance();
+        }
+    }
+}
+```
+
+Register the module:
+
 ```csharp
-builder.RegisterModule(new KSociety.SharpCubeProgrammer.Bindings.ProgrammerApi());
+builder.RegisterModule(new Bindings.ProgrammerApi());
 ```
 
 - Get ST-Link list and connect:
@@ -164,4 +185,5 @@ The project is under Microsoft Reciprocal License [(MS-RL)](http://www.opensourc
 
 List of technologies, frameworks and libraries used for implementation:
 
-- [KSociety.Wmi](https://github.com/K-Society/KSociety.Wmi) (WMI)
+- [Microsoft.Bcl.AsyncInterfaces](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces)
+- [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions)
diff --git a/src/01/KSociety.SharpCubeProgrammer/Events/StLinkAddedEventArgs.cs b/src/01/KSociety.SharpCubeProgrammer/Events/StLinkAddedEventArgs.cs
@@ -1,14 +1,14 @@
-// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
+//// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
 
-namespace KSociety.SharpCubeProgrammer.Events
-{
-    using System;
+//namespace KSociety.SharpCubeProgrammer.Events
+//{
+//    using System;
 
-    public class StLinkAddedEventArgs : EventArgs
-    {
-        public StLinkAddedEventArgs()
-        {
+//    public class StLinkAddedEventArgs : EventArgs
+//    {
+//        public StLinkAddedEventArgs()
+//        {
 
-        }
-    }
-}
+//        }
+//    }
+//}
diff --git a/src/01/KSociety.SharpCubeProgrammer/Events/StLinkFoundEventArgs.cs b/src/01/KSociety.SharpCubeProgrammer/Events/StLinkFoundEventArgs.cs
@@ -1,14 +1,14 @@
-// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
+//// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
 
-namespace KSociety.SharpCubeProgrammer.Events
-{
-    using System;
+//namespace KSociety.SharpCubeProgrammer.Events
+//{
+//    using System;
 
-    public class StLinkFoundEventArgs : EventArgs
-    {
-        public StLinkFoundEventArgs()
-        {
+//    public class StLinkFoundEventArgs : EventArgs
+//    {
+//        public StLinkFoundEventArgs()
+//        {
 
-        }
-    }
-}
+//        }
+//    }
+//}
diff --git a/src/01/KSociety.SharpCubeProgrammer/Events/StLinkRemovedEventArgs.cs b/src/01/KSociety.SharpCubeProgrammer/Events/StLinkRemovedEventArgs.cs
@@ -1,14 +1,14 @@
-// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
+//// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
 
-namespace KSociety.SharpCubeProgrammer.Events
-{
-    using System;
+//namespace KSociety.SharpCubeProgrammer.Events
+//{
+//    using System;
 
-    public class StLinkRemovedEventArgs : EventArgs
-    {
-        public StLinkRemovedEventArgs()
-        {
+//    public class StLinkRemovedEventArgs : EventArgs
+//    {
+//        public StLinkRemovedEventArgs()
+//        {
 
-        }
-    }
-}
+//        }
+//    }
+//}
diff --git a/src/01/KSociety.SharpCubeProgrammer/Events/Stm32BootLoaderAddedEventArgs.cs b/src/01/KSociety.SharpCubeProgrammer/Events/Stm32BootLoaderAddedEventArgs.cs
@@ -1,14 +1,14 @@
-// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
+//// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
 
-namespace KSociety.SharpCubeProgrammer.Events
-{
-    using System;
+//namespace KSociety.SharpCubeProgrammer.Events
+//{
+//    using System;
 
-    public class Stm32BootLoaderAddedEventArgs : EventArgs
-    {
-        public Stm32BootLoaderAddedEventArgs()
-        {
+//    public class Stm32BootLoaderAddedEventArgs : EventArgs
+//    {
+//        public Stm32BootLoaderAddedEventArgs()
+//        {
 
-        }
-    }
-}
+//        }
+//    }
+//}
diff --git a/src/01/KSociety.SharpCubeProgrammer/Events/Stm32BootLoaderFoundEventArgs.cs b/src/01/KSociety.SharpCubeProgrammer/Events/Stm32BootLoaderFoundEventArgs.cs
@@ -1,14 +1,14 @@
-// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
+//// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
 
-namespace KSociety.SharpCubeProgrammer.Events
-{
-    using System;
+//namespace KSociety.SharpCubeProgrammer.Events
+//{
+//    using System;
 
-    public class Stm32BootLoaderFoundEventArgs : EventArgs
-    {
-        public Stm32BootLoaderFoundEventArgs()
-        {
+//    public class Stm32BootLoaderFoundEventArgs : EventArgs
+//    {
+//        public Stm32BootLoaderFoundEventArgs()
+//        {
 
-        }
-    }
-}
+//        }
+//    }
+//}
diff --git a/src/01/KSociety.SharpCubeProgrammer/Events/Stm32BootLoaderRemovedEventArgs.cs b/src/01/KSociety.SharpCubeProgrammer/Events/Stm32BootLoaderRemovedEventArgs.cs
@@ -1,14 +1,14 @@
-// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
+//// Copyright © K-Society and contributors. All rights reserved. Licensed under the K-Society License. See LICENSE.TXT file in the project root for full license information.
 
-namespace KSociety.SharpCubeProgrammer.Events
-{
-    using System;
+//namespace KSociety.SharpCubeProgrammer.Events
+//{
+//    using System;
 
-    public class Stm32BootLoaderRemovedEventArgs : EventArgs
-    {
-        public Stm32BootLoaderRemovedEventArgs()
-        {
+//    public class Stm32BootLoaderRemovedEventArgs : EventArgs
+//    {
+//        public Stm32BootLoaderRemovedEventArgs()
+//        {
 
-        }
-    }
-}
+//        }
+//    }
+//}
diff --git a/src/01/Samples/Programming/Program.cs b/src/01/Samples/Programming/Program.cs
@@ -8,7 +8,6 @@ namespace Programming
     using System.Text.RegularExpressions;
     using Autofac;
     using KSociety.SharpCubeProgrammer.Enum;
-    using KSociety.SharpCubeProgrammer.Events;
     using KSociety.SharpCubeProgrammer.Interface;
     using KSociety.SharpCubeProgrammer.Struct;
     using Microsoft.Extensions.Configuration;
@@ -36,9 +35,6 @@ private static void Main(string[] args)
 
             CubeProgrammerApi = container.Resolve<ICubeProgrammerApi>();
 
-            //CubeProgrammerApi.StLinkAdded += CubeProgrammerApiOnStLinkAdded;
-            //CubeProgrammerApi.StLinkRemoved += CubeProgrammerApiOnStLinkRemoved;
-            //CubeProgrammerApi.StLinksFoundStatus += CubeProgrammerApiOnStLinksFoundStatus;
             Console.WriteLine("Press a button to continue.");
             Console.ReadLine();
             //var testStLink = CubeProgrammerApi.TryConnectStLink(0, 0, DebugConnectionMode.UnderResetMode);
@@ -233,26 +229,10 @@ private static void Main(string[] args)
 
         }
 
-        //private static void CubeProgrammerApiOnStLinksFoundStatus(object? sender, StLinkFoundEventArgs e)
-        //{
-        //    Logger?.LogInformation("StLinksFound...");
-        //}
-
-        //private static void CubeProgrammerApiOnStLinkRemoved(object? sender, StLinkRemovedEventArgs e)
-        //{
-        //    Logger?.LogInformation("StLinkRemoved...");
-        //}
-
-        //private static void CubeProgrammerApiOnStLinkAdded(object? sender, StLinkAddedEventArgs e)
-        //{
-        //    Logger?.LogInformation("StLinkAdded...");
-        //}
-
         private static IContainer BuildContainer()
         {
             var builder = new ContainerBuilder();
             builder.RegisterModule(new Bindings.Log());
-            //builder.RegisterModule(new KSociety.Wmi.Bindings.Wmi());
             builder.RegisterModule(new Bindings.ProgrammerApi());
             return builder.Build();
         }