Changes for review

Author: AdrianSoundy

README.md

@@ -13,8 +13,8 @@ document language: [English](README.md) | [简体中文](README.zh-cn.md)
 |:-|---|---|
 | nanoFramework.Networking.Thread | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.Networking.Thread/_apis/build/status/nanoFramework.Networking.Thread?repoName=nanoframework%2FnanoFramework.Networking.Thread&branchName=main)](https://dev.azure.com/nanoframework/nanoFramework.Networking.Thread/_build/latest?definitionId=85&repoName=nanoframework%2FnanoFramework.Networking.Thread&branchName=main) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.Networking.Thread.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Networking.Thread/) |
 
-
 # nanoFramework.Networking.Thread
+
  .NET nanoFramework library for working with OpenThread networking. 
 
  The OpenThread network is based on IPV6 and requires a firmware which has IPV6 and Thread enabled.
@@ -38,22 +38,21 @@ document language: [English](README.md) | [简体中文](README.zh-cn.md)
 
  This can be one of the types.
 
-	- Router
-	- End device
-	- Sleepy end device
+- Router
+- End device
+- Sleepy end device
 
 The **Router** and **End device** are for a powered devices. 
 The **End device** will stay in the **child** role and won't ever be promoted to a router.
 The **Router** type will start with the child role and be promoted to the **router** or **leader** roles as required.
 
-The **Sleepy end device** are for battery operated devices and don't  stay connected to 
-the mesh network to save on battery. It will regularly poll its connected router for any messages. Routers connected 
+The **Sleepy end device** are for battery operated devices and don't stay connected to
+the mesh network to save on battery. It will regularly poll its connected router for any messages. Routers connected
 to a sleepy end device will store and forward messages. 
 
 The devices can take on a number of roles as already mentioned. 
 These are child, Router or Leader. 
 
-
 ### Devices with a built-in 802.15.4 radio
 
 Creating openThread object for a device with a built-in 802.15.4 radio.
@@ -76,7 +75,6 @@ This code creates the stack using the network processor connected by UART on dev
 OpenThread ot = OpenThread.CreateThreadWithUartRadio(ThreadDeviceType.Router, 1);
 ```    
 
-
 #### Connected via a SPI port.**
 
 Create the openThread object specifying the SPI port connected to the co-processor. 
@@ -118,7 +116,6 @@ If not it will wait about 2 minutes and create a new network using credentials i
 Monitor the state change events to know when the device has attached to the mesh network.
 See later section on events raised by the OpenThread class.
 
-
 ## Joining a existing network using the commissioner.
 
  To attach a device to an existing network where the network credentials are unknown. 
@@ -157,6 +154,7 @@ ot.OnConsoleOutputAvailable += Ot_OnConsoleOutputAvailable;
 ```
 
 ### OnStatusChanged
+
 This event is fired when the state of the Thread stack changes. 
 The main states that need to be monitored are the Detached and Attached events.
 There will also be events for network interface up/down, an IPV6 address has been assigned and when the stack has been started or stopped.
@@ -181,6 +179,7 @@ private static void Ot_OnStatusChanged(OpenThread sender, OpenThreadStateChangeE
 ```
 
 ### OnRoleChanged
+
 This event is fired when the role of the device changes. 
 
 The role can be one of the following:
@@ -193,7 +192,6 @@ The role can be one of the following:
 | Router | The device is a router and has 0 or more child devices. |
 | Leader | The device is a router that has been promoted to leader. |
 
-
 ### OnConsoleOutputAvailable  
 
 This event is fired when unsolicited messages are received on Command Line Interface (CLI).
@@ -234,7 +232,6 @@ For examples on using sockets for communication see the Thread sockets samples
 As the OpenThread is based on an IP networking it also supports communication via TCP/IP. All the 
 normal methods of communicating with TCP/IP will work. 
 
-
 ## OpenThread CLI interface.
 
 The OpenThread library has a large number of different APIs.  
@@ -255,6 +252,7 @@ This will send a command to the CLI and wait for all strings returned until a 'd
 These strings will be returned directly by the command excluding the 'done' message. 
 
 CLI command to return all the IPV6 addresses assigned to the interface.
+
 ```c#
 string[] results = ot.CommandLineInputAndWaitResponse("ipaddr");
 ```

Tests/DataSetTests/nano.runsettings

@@ -10,7 +10,7 @@
    <nanoFrameworkAdapter>
        <Logging>None</Logging> <!--Set to the desired level of logging for Unit Test execution. Possible values are: None, Detailed, Verbose, Error. -->
        <IsRealHardware>False</IsRealHardware><!--Set to true to run tests on real hardware. -->
-       <RealHardwarePort>COM3</RealHardwarePort><!--Specify the COM port to use to connect to a nanoDevice. If none is specified, a device detection is performed and the 1st available one will be used. -->
+       <RealHardwarePort></RealHardwarePort><!--Specify the COM port to use to connect to a nanoDevice. If none is specified, a device detection is performed and the 1st available one will be used. -->
        <CLRVersion></CLRVersion><!--Specify the nanoCLR version to use. If not specified, the latest available will be used. -->
        <PathToLocalCLRInstance></PathToLocalCLRInstance><!--Specify the path to a local nanoCLR instance. If not specified, the default one installed with nanoclr CLR witll be used. -->
    </nanoFrameworkAdapter>

nanoFramework.Networking.Thread/OpenThreadConsoleOutputAvailableArgs.cs

@@ -0,0 +1,30 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using nanoFramework.Runtime.Events;
+
+namespace nanoFramework.Networking.Thread
+{
+    // <summary>
+    /// Event arguments for the OnConsoleOutputAvailable Event.
+    /// </summary>
+    public class OpenThreadConsoleOutputAvailableArgs : BaseEvent
+    {
+        private string[] _consoleLines;
+
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        public OpenThreadConsoleOutputAvailableArgs() : base()
+        {
+            _consoleLines = new string[0];
+        }
+
+        /// <summary>
+        /// Currently available console lines. 0 or more strings.
+        /// </summary>
+        public string[] consoleLines { get => _consoleLines; set => _consoleLines = value; }
+    }
+}

nanoFramework.Networking.Thread/OpenThreadDataset.cs

@@ -24,7 +24,7 @@ public class OpenThreadDataset
         /// Used to flags properties in use.
         /// </summary>
         [Flags]
-        enum componentInUseFlags
+        private enum componentInUseFlags
         {
             None = 0,
             channel = 1,
@@ -45,7 +45,7 @@ public OpenThreadDataset()
         }
 
         /// <summary>
-        /// Get or Set the Thread Network Key.
+        /// Get or set the Thread Network Key.
         /// Must be a byte[8].
         /// </summary>
         /// <remarks>
@@ -61,6 +61,7 @@ public byte[] NetworkKey
                 {
                     throw new ArgumentException();
                 }
+
                 _networkKey = value;
                 _inUseFlags |= componentInUseFlags.networkKey;
             }

nanoFramework.Networking.Thread/OpenThreadEventListener.cs

@@ -19,52 +19,6 @@ enum OpenThreadEventType
         JoinerComplete
     };
 
-    /// <summary>
-    /// This class represents the event arguments for OnStatusChanged.
-    /// </summary>
-    public class OpenThreadStateChangeEventArgs : BaseEvent
-    {
-        /// <summary>
-        /// Current state of OpenThread stack.
-        /// </summary>
-        public int currentState;
-    }
-
-    /// <summary>
-    /// This class represents the event arguments for OnRoleChanged.
-    /// </summary>
-    public class OpenThreadRoleChangeEventArgs : BaseEvent
-    {
-        /// <summary>
-        /// The previous thread device role before current change.
-        /// </summary>
-        public ThreadDeviceRole previousRole;
-
-        /// <summary>
-        /// Current role of device.
-        /// </summary>
-        public ThreadDeviceRole currentRole;
-    }
-
-    /// <summary>
-    /// Event arguments for the OnConsoleOutputAvailable Event.
-    /// </summary>
-    public class OpenThreadConsoleOutputAvailableArgs : BaseEvent
-    {
-        /// <summary>
-        /// Currently available console lines. 0 or more strings.
-        /// </summary>
-        public string[] consoleLines;
-    }
-
-    internal class OpenThreadJoinerStartCompleteEventArgs : BaseEvent
-    {
-        /// <summary>
-        /// Joiner start error or 0
-        /// </summary>
-        public int error;
-    }
-
     internal class OpenThreadEventListener : IEventProcessor, IEventListener
     {
         // Reference to current open thread object for passing events.

nanoFramework.Networking.Thread/OpenThreadJoinerStartCompleteEventArgs.cs

@@ -0,0 +1,24 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using nanoFramework.Runtime.Events;
+
+namespace nanoFramework.Networking.Thread
+{
+    internal class OpenThreadJoinerStartCompleteEventArgs : BaseEvent
+    {
+        private int _error;
+
+        internal OpenThreadJoinerStartCompleteEventArgs() : base() 
+        {
+            _error = 0;
+        }
+
+        /// <summary>
+        /// Joiner start error or 0 if successful.
+        /// </summary>
+        public int error { get => _error; set => value = _error; }
+    }
+}

nanoFramework.Networking.Thread/OpenThreadRoleChangeEventArgs.cs

@@ -0,0 +1,35 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using nanoFramework.Runtime.Events;
+
+namespace nanoFramework.Networking.Thread
+{
+    /// <summary>
+    /// This class represents the event arguments for OnRoleChanged.
+    /// </summary>
+    public class OpenThreadRoleChangeEventArgs : BaseEvent
+    {
+        private ThreadDeviceRole _previousRole;
+        private ThreadDeviceRole _currentRole;
+
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        public OpenThreadRoleChangeEventArgs() : base()
+        {
+        }
+
+        /// <summary>
+        /// The previous thread device role before current change.
+        /// </summary>
+        public ThreadDeviceRole previousRole { get => _previousRole; set => _previousRole = value; }
+
+        /// <summary>
+        /// Current role of device.
+        /// </summary>
+        public ThreadDeviceRole currentRole { get => _currentRole; set => _currentRole = value; }
+    }
+}

nanoFramework.Networking.Thread/OpenThreadStateChangeEventArgs.cs

@@ -0,0 +1,30 @@
+//
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using nanoFramework.Runtime.Events;
+
+namespace nanoFramework.Networking.Thread
+{
+    /// <summary>
+    /// This class represents the event arguments for OnStatusChanged.
+    /// </summary>
+    public class OpenThreadStateChangeEventArgs : BaseEvent
+    {
+        private int _currentState;
+
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        public OpenThreadStateChangeEventArgs() : base() 
+        {
+        }
+
+        /// <summary>
+        /// Current state of OpenThread stack.
+        /// </summary>
+        public int currentState { get => _currentState; set => _currentState = value; }
+    }
+}

nanoFramework.Networking.Thread/ThreadDeviceState.cs

@@ -14,30 +14,36 @@ public enum ThreadDeviceState
         /// <summary>
         /// Thread network stack has started.
         /// </summary>
-        OPENTHREAD_EVENT_START = 0,
+        Start = 0,
+
         /// <summary>
         /// Thread network stack has stopped.
         /// </summary>
-        OPENTHREAD_EVENT_STOP = 1,
+        Stop = 1,
+
         /// <summary>
         /// Thread detached from any mesh network.
         /// </summary>
-        OPENTHREAD_EVENT_DETACHED = 2,
+        Detached = 2,
+
         /// <summary>
         /// THread attached to mesh network.
         /// </summary>
-        OPENTHREAD_EVENT_ATTACHED = 3,
+        Attached = 3,
+
         /// <summary>
         /// Network interface is up.
         /// </summary>
-        OPENTHREAD_EVENT_IF_UP = 5,
+        InterfaceUp = 5,
+
         /// <summary>
         /// Network interface is down.
         /// </summary>
-        OPENTHREAD_EVENT_IF_DOWN = 6,
+        InterfaceDown = 6,
+
         /// <summary>
         /// Network interface received IPV6 address.
         /// </summary>
-        OPENTHREAD_EVENT_GOT_IP6 = 7,
+        GotIpv6 = 7,
     }
 }

nanoFramework.Networking.Thread/ThreadRadioConnection.cs

@@ -16,10 +16,12 @@ public enum RadioConnection
         /// Connected via a native radio which is part of SOC.
         /// </summary>
         Native,
+
         /// <summary>
         /// Connected via a UART port.
         /// </summary>
         Uart,
+
         /// <summary>
         /// Connected via a SPI bus.
         /// </summary>