Add examples

Author: jdomnitz

Examples.md

@@ -0,0 +1,77 @@
+### Examples
+
+#### Getting Started
+To start using the library first instantiate the controller.
+```c#
+// Option 1
+Controller controller = new Controller("Example Matter Fabric");
+
+// Option 2
+Controller controller = Controller.Load("example.fabric", "example.key");
+```
+_Option 1: Creates a new controller then generates the fabric named "Example Matter Fabric" and the certificates._\
+_Option 2: Load an existing fabric into a controller._
+
+#### Example 1: Interviewing the Fabric
+On first startup of a fabric or after a long disconnected period it is a good idea to re-enumerate the fabric.  This will interview each node on the fabric for some basic information.
+```c#
+await controller.EnumerateFabric();
+```
+  
+#### Example 2: Adding Nodes (Commissioning an already commissioned device):
+This example adds a node to our fabric that has already been setup by another device. To commission a node, we need a commissioning payload. This is generated with either an 11/21 digit PIN Code, a QR code or an NFC tag.
+```c#
+// Option 1
+CommissioningPayload payload = CommissioningPayload.FromPIN("00362159269");
+
+// Option 2
+CommissioningPayload payload = CommissioningPayload.FromQR("MT:Y.K9042C00KA0648G00");
+
+// Option 3
+CommissioningPayload payload = CommissioningPayload.FromNFC(nfcBytes);
+```
+_Option 1: Creates a commissioning payload from a PIN Number._\
+_Option 2: Creates a commissioning payload from a QR Code._\
+_Option 3: Creates a commissioning payload from an NFC tag._
+
+Once we have the payload, we can activate commissioning which will automatically search bluetooth and/or the network and setup the device.
+
+```c#
+    CommissioningState info = await controller.StartCommissioning(payload);
+    await controller.CompleteCommissioning(info);
+    controller.Save("example.fabric", "example.key");
+```
+_Line 1 Find the device and begin commissioning._\
+_Line 2 Complete commissioning._\
+_Line 3 Save the fabric with the certificates for the newly added node._
+
+#### Example 3: Adding Nodes (Commissioning a New/Reset Device):
+To commission a node, we need a commissioning payload. This is generated with either an 11/21 digit PIN Code, a QR code or an NFC tag.
+```c#
+// Option 1
+CommissioningPayload payload = CommissioningPayload.FromPIN("00362159269");
+
+// Option 2
+CommissioningPayload payload = CommissioningPayload.FromQR("MT:Y.K9042C00KA0648G00");
+
+// Option 3
+CommissioningPayload payload = CommissioningPayload.FromNFC(nfcBytes);
+```
+_Option 1: Creates a commissioning payload from a PIN Number._\
+_Option 2: Creates a commissioning payload from a QR Code._\
+_Option 3: Creates a commissioning payload from an NFC tag._
+
+Once we have the payload, we can activate commissioning which will automatically search bluetooth and/or the network and setup the device.
+
+```c#
+    CommissioningState info = await controller.StartCommissioning(payload);
+    var result = info.FindWiFi("Linksys-24G")!;
+    await controller.CompleteCommissioning(info, result, "password123");
+    controller.Save("example.fabric", "example.key");
+```
+_Line 1 Find the device and begin commissioning._\
+_Line 2 Select a WiFi network out of the networks the device can see. This step can be skipped if the device is already on the network._\
+_Line 3 Complete commissioning and connect to the provided WiFi network._\
+_Line 4 Save the fabric with the certificates for the newly added node._
+
+Alternatively, line 2 can be replaced by selecting a thread network or an ethernet connection.

MatterDotNet/Entities/Controller.cs

@@ -44,13 +44,19 @@ public Controller(Fabric fabric)
         {
             this.fabric = fabric;
         }
+        
+        /// <summary>
+        /// Create a controller with a new fabric
+        /// </summary>
+        /// <param name="fabricName"></param>
+        public Controller(string fabricName = "MatterDotNot") : this((ulong)Random.Shared.NextInt64(), fabricName) { }
 
         /// <summary>
         /// Create a controller with a new fabric
         /// </summary>
         /// <param name="fabricId"></param>
         /// <param name="fabricName"></param>
-        public Controller(uint fabricId, string fabricName = "MatterDotNot")
+        public Controller(ulong fabricId, string fabricName = "MatterDotNot")
         {
             this.fabric = new Fabric(fabricName, fabricId, RandomNumberGenerator.GetBytes(16));
             this.fabric.CreateCommissioner();

README.md

@@ -24,5 +24,8 @@
 #### Other Projects:
 * Check out my other projects for [HomeKit](https://github.com/SmartHomeOS/HomeKitDotNet) and [ZWave](https://github.com/SmartHomeOS/ZWaveDotNet)
 
+## Getting Started
+* See our [Examples Page](Examples.md)
+
 **Financial Support will help the project achieve certification as an officially supported library:**
 <br/><a href="https://www.buymeacoffee.com/jdomnitz" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Pizza" style="height: 60px !important;width: 217px !important;" ></a>