Miscellaneous fixes (#4)

josesimoes · web-flow · commit 39d41c436851 · 2021-10-22T13:36:54.000+01:00
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 
 -----
 
-# Welcome to the **nanoFramework** Aws.IoTCore.Devices repository!
+# Welcome to the .NET **nanoFramework** AWS IoT Core SDK repository!
 
 ## Build status
 
@@ -156,7 +156,7 @@ void ShadowUpdatedEvent(object sender, ShadowUpdateEventArgs e)
 
 ### Sending message
 
-You have to use the `SendMessage` function to send any kind of message or telemetry to Aws IoT. As with the other function, you have the possibility to ensure delivery using a `CancellationToken` than can be cancelled. If one that can't be cancelled is used, the delivery insurance will be ignored and the function will return false.
+You have to use the `SendMessage` function to send any kind of message or telemetry to AWS IoT. As with the other function, you have the possibility to ensure delivery using a `CancellationToken` than can be cancelled. If one that can't be cancelled is used, the delivery insurance will be ignored and the function will return false.
 
 ```csharp
 var isReceived = awsIoT.SendMessage($"{{\"Temperature\":42,\"Pressure\":1024}}", new CancellationTokenSource(5000).Token);
@@ -249,14 +249,13 @@ The list of contributors to this project can be found at [CONTRIBUTORS](https://
 
 ## License
 
-The **nanoFramework** Class Libraries are licensed under the [MIT license](LICENSE.md).
+The .NET **nanoFramework** Class Libraries are licensed under the [MIT license](LICENSE.md).
 
 ## Code of Conduct
 
-This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
+This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community.
 For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
 
 ### .NET Foundation
 
 This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
-
diff --git a/Tests/Aws.IoTCore.Devices.UnitTests.nfproj b/Tests/Aws.IoTCore.Devices.UnitTests.nfproj
@@ -15,7 +15,7 @@
     <OutputType>Library</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <FileAlignment>512</FileAlignment>
-    <RootNamespace>nanoFramwwork.Aws.IoTCore.Devices.Tests</RootNamespace>
+    <RootNamespace>nanoFramework.Aws.IoTCore.Devices.Tests</RootNamespace>
     <AssemblyName>NFUnitTest</AssemblyName>
     <IsCodedUITest>False</IsCodedUITest>
     <IsTestProject>true</IsTestProject>
diff --git a/Tests/Properties/AssemblyInfo.cs b/Tests/Properties/AssemblyInfo.cs
diff --git a/Tests/ShadowJsonMessageExamples.cs b/Tests/ShadowJsonMessageExamples.cs
@@ -1,7 +1,9 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
-namespace nanoFramwwork.Aws.IoTCore.Devices.Tests
+namespace nanoFramework.Aws.IoTCore.Devices.Tests
 {
     /// <summary>
     /// Connection status.
diff --git a/Tests/ShadowTests.cs b/Tests/ShadowTests.cs
@@ -1,7 +1,12 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
 using nanoFramework.TestFramework;
 using System;
 
-namespace nanoFramwwork.Aws.IoTCore.Devices.Tests
+namespace nanoFramework.Aws.IoTCore.Devices.Tests
 {
     [TestClass]
     public class ShadowTests
@@ -15,7 +20,7 @@ public void get_shadow_json_to_class()
         [TestMethod]
         public void get_shadow_class_to_json()
         {
-            //technicallly un-necessary, but a good check!
+            //technically un-necessary, but a good check!
             // need to make sure the above method passes before attempting this!
         }
 
@@ -28,8 +33,8 @@ public void update_shadow_recieved_json_to_class()
         [TestMethod]
         public void create_update_shadow_to_send_class()
         {
-            //technicallly un-necessary, but a good check!
-            //in the realworld, this would be a different class.
+            //technically un-necessary, but a good check!
+            //in the real world, this would be a different class.
             // need to make sure the above method passes before attempting this!
         }
 
diff --git a/Tests/nano.runsettings b/Tests/nano.runsettings
diff --git a/Tests/packages.config b/Tests/packages.config
diff --git a/nanoFramework.Aws.IoTCore.Devices.nuspec b/nanoFramework.Aws.IoTCore.Devices.nuspec
@@ -15,10 +15,8 @@
     <icon>images\nf-logo.png</icon>
     <repository type="git" url="https://github.com/nanoframework/nanoFramework.Aws.IoTCore.Devices" commit="$commit$" />
     <copyright>Copyright (c) .NET Foundation and Contributors</copyright>
-    <description>This package includes the .NET nanoFramework.Aws.IoTCore.Devices assembly for nanoFramework C# projects.
-This is an SDK for Aws IoTCore.</description>
-    <summary>nanoFramework.Aws.IoTCore.Devices assembly for nanoFramework C# projects</summary>
-    <tags>nanoFramework C# csharp netmf netnf AWS IoTCore nanoFramework.Aws.IoTCore.Devices</tags>
+    <description>This package includes the .NET nanoFramework SDK for AWS IoT Core.&#10;To be used in .NET nanoFramework C# projects targeting AWS IoT Core.</description>
+    <tags>nanoFramework C# csharp netmf netnf AWS IoT Core nanoFramework.Aws.IoTCore.Devices</tags>
     <dependencies>
       <dependency id="nanoFramework.CoreLibrary" version="1.10.5" />
       <dependency id="nanoFramework.Json" version="2.1.0" />
diff --git a/nanoFramework.Aws.IoTCore.Devices.sln b/nanoFramework.Aws.IoTCore.Devices.sln
@@ -5,20 +5,20 @@ VisualStudioVersion = 16.0.29709.97
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "nanoFramework.Aws.IoTCore.Devices", "nanoFramework.Aws.IoTCore.Devices\nanoFramework.Aws.IoTCore.Devices.nfproj", "{3473C1B1-23F4-4EE3-8709-2D35D01220A6}"
 EndProject
-Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "nanoFramwwork.Aws.IoTCore.Devices.Tests", "nanoFramwwork.Aws.IoTCore.Devices.Tests\nanoFramwwork.Aws.IoTCore.Devices.Tests.nfproj", "{99186E17-5D65-4218-9707-97D12A0C8605}"
+Project("{11A8DD76-328B-46DF-9F39-F559912D0360}") = "Aws.IoTCore.Devices.UnitTests", "Tests\Aws.IoTCore.Devices.UnitTests.nfproj", "{99186E17-5D65-4218-9707-97D12A0C8605}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{97905949-225F-47F4-AD99-42D42E90406D}"
+	ProjectSection(SolutionItems) = preProject
+		NuGet.Config = NuGet.Config
+		version.json = version.json
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{67298667-62F5-4C72-A2CC-22031D6B0D61}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{67298667-62F5-4C72-A2CC-22031D6B0D61}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{67298667-62F5-4C72-A2CC-22031D6B0D61}.Debug|Any CPU.Deploy.0 = Debug|Any CPU
-		{67298667-62F5-4C72-A2CC-22031D6B0D61}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{67298667-62F5-4C72-A2CC-22031D6B0D61}.Release|Any CPU.Build.0 = Release|Any CPU
-		{67298667-62F5-4C72-A2CC-22031D6B0D61}.Release|Any CPU.Deploy.0 = Release|Any CPU
 		{3473C1B1-23F4-4EE3-8709-2D35D01220A6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{3473C1B1-23F4-4EE3-8709-2D35D01220A6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{3473C1B1-23F4-4EE3-8709-2D35D01220A6}.Debug|Any CPU.Deploy.0 = Debug|Any CPU
diff --git a/nanoFramework.Aws.IoTCore.Devices/CloudToDeviceMessage.cs b/nanoFramework.Aws.IoTCore.Devices/CloudToDeviceMessage.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 using System;
 
diff --git a/nanoFramework.Aws.IoTCore.Devices/ConfirmationStatus.cs b/nanoFramework.Aws.IoTCore.Devices/ConfirmationStatus.cs
@@ -1,6 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
-
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 namespace nanoFramework.Aws.IoTCore.Devices
 {
diff --git a/nanoFramework.Aws.IoTCore.Devices/ConnectorState.cs b/nanoFramework.Aws.IoTCore.Devices/ConnectorState.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 namespace nanoFramework.Aws.IoTCore.Devices
 {
diff --git a/nanoFramework.Aws.IoTCore.Devices/ConnectorStateMessage.cs b/nanoFramework.Aws.IoTCore.Devices/ConnectorStateMessage.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 namespace nanoFramework.Aws.IoTCore.Devices //TODO: improve for AWS IoT.
 {
diff --git a/nanoFramework.Aws.IoTCore.Devices/MqttConnectionClient.cs b/nanoFramework.Aws.IoTCore.Devices/MqttConnectionClient.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 using nanoFramework.Aws.IoTCore.Devices.Shadows;
 using nanoFramework.Json;
@@ -92,7 +94,7 @@ internal MqttConnectionClient() { } //Required by IDisposable.
         /// <summary>
         /// Creates an <see cref="MqttConnectionClient"/> class.
         /// </summary>
-        /// <param name="iotCoreUri">The AWS IoT Core fully quilified domain name (example: 'instance'.'region'.amazonaws.com)</param>
+        /// <param name="iotCoreUri">The AWS IoT Core fully qualified domain name (example: 'instance'.'region'.amazonaws.com)</param>
         /// <param name="uniqueId">A unique identity for your device (Device ID / Thing Name).</param>
         /// <param name="clientCert">The certificate used to connect the device to the MQTT broker (containing both the private certificate and private key).</param>
         /// <param name="qosLevel">The default quality of service level for the delivery of MQTT messages, (defaults to the lowest quality)</param>
@@ -128,7 +130,7 @@ public MqttConnectionClient(string iotCoreUri, string uniqueId, X509Certificate2
         public MqttQoSLevel QosLevel { get; set; }
 
         /// <summary>
-        /// True if the device connected sucessfully.
+        /// True if the device connected successfully.
         /// </summary>
         public bool IsConnected => (_mqttc != null) && _mqttc.IsConnected;
 
@@ -152,7 +154,7 @@ public bool Open(string topicPrefix)
         /// </summary>
         /// <param name="telemetryTopic">The telemetry topic</param>
         /// <param name="deviceMessageTopic">The device message topic</param>
-        /// <param name="lwtTopic">The last will and testiment topic</param>
+        /// <param name="lwtTopic">The last will and testament topic</param>
         /// <returns>True for a successful connection</returns>
         public bool Open(string telemetryTopic, string deviceMessageTopic, string lwtTopic)
         {
@@ -194,7 +196,7 @@ public bool Open()
                 false, //TODO: but if "willretain" is that... what is "willflag" doing?
                 _lwtTopic,
                 "MQTT connection was unexpectedly disconnected!",
-                true, //TODO: this "should" handle persistant connections, and should be configurable?!
+                true, //TODO: this "should" handle persistent connections, and should be configurable?!
                 60
                 );
 
@@ -248,7 +250,7 @@ public void Close()
                     $"{ _shadowTopic }/#",
                     });
                 _mqttc.Disconnect();
-                // Make sure all get disconnected, cleared (TODO: 1 second arbitary value specified)
+                // Make sure all get disconnected, cleared (TODO: 1 second arbitrary value specified)
                 Thread.Sleep(1000);
             }
 
@@ -290,7 +292,7 @@ public Shadow GetShadow(CancellationToken cancellationToken = default, string na
         /// </summary>
         /// <param name="shadowToSend">The Shadow to send.</param>
         /// <param name="cancellationToken">A cancellation token. If you use the default one, the confirmation of delivery will not be awaited.</param>
-        /// <param name="namedShadow">The suplementry Shadow name.</param>
+        /// <param name="namedShadow">The supplementary Shadow name.</param>
         /// <returns>True for successful message delivery.</returns>
         public bool UpdateReportedState(Shadow shadowToSend, CancellationToken cancellationToken = default, string namedShadow = "") //was ShadowCollection
         {
@@ -350,7 +352,7 @@ public bool SendMessage(string message, CancellationToken cancellationToken = de
             return false;
         }
 
-        private void ClientMqttMsgReceived(object sender, MqttMsgPublishEventArgs e) //TODO: can we also add subscriptions publiclly?!! 
+        private void ClientMqttMsgReceived(object sender, MqttMsgPublishEventArgs e) //TODO: can we also add subscriptions publicly?!! 
         {
             //TODO: we might need to be more specific with topics to ensure reduced costs!
             Debug.WriteLine($"MsgReceivedHandler: received message on a subscribed topic: {e.Topic}");
@@ -364,7 +366,7 @@ private void ClientMqttMsgReceived(object sender, MqttMsgPublishEventArgs e) //T
 
                     if (e.Topic.StartsWith($"{_shadowTopic}/update") || (e.Topic.StartsWith($"{_shadowTopic}/name") && e.Topic.Contains("/update"))) //TODO: check correctness!
                     {
-                        //TODO: we might have to be more specific with subscribed topics here... I think receiving some of these could cost money, even if they are irrelevent!
+                        //TODO: we might have to be more specific with subscribed topics here... I think receiving some of these could cost money, even if they are irrelevant!
                         Debug.WriteLine($"ReceivedHandler Reached (update): {e.Topic}");
                         if (e.Topic.Contains("/rejected"))
                         {
@@ -381,7 +383,7 @@ private void ClientMqttMsgReceived(object sender, MqttMsgPublishEventArgs e) //T
                             _mqttBrokerStatus.Message = jsonMessageBody;
                             StatusUpdated?.Invoke(this, new StatusUpdatedEventArgs(_mqttBrokerStatus));
                         }
-                        else if (e.Topic.Contains("/accepted")) //TODO: this should not be required, since a delta should take precidence (but what if there is no delta?!)...
+                        else if (e.Topic.Contains("/accepted")) //TODO: this should not be required, since a delta should take precedence (but what if there is no delta?!)...
                         {
                             Debug.WriteLine($"ReceivedHandler Reached (update-accepted): {e.Topic}");
                             _mqttBrokerStatus.State = ConnectorStateMessage.ShadowUpdated;
@@ -497,7 +499,7 @@ public void Dispose()
                 Close();
                 while (_mqttc.IsConnected)
                 {
-                    Thread.Sleep(100); //TODO: arbitry value, explain why.
+                    Thread.Sleep(100); //TODO: arbitrary value, explain why.
 
                 }
 
diff --git a/nanoFramework.Aws.IoTCore.Devices/Shadows/Shadow.cs b/nanoFramework.Aws.IoTCore.Devices/Shadows/Shadow.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 using System.Collections;
 using nanoFramework.Json;
diff --git a/nanoFramework.Aws.IoTCore.Devices/Shadows/ShadowProperties.cs b/nanoFramework.Aws.IoTCore.Devices/Shadows/ShadowProperties.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 using System.Collections;
 
diff --git a/nanoFramework.Aws.IoTCore.Devices/Shadows/ShadowUpdatedEventArgs.cs b/nanoFramework.Aws.IoTCore.Devices/Shadows/ShadowUpdatedEventArgs.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 using System;
 
diff --git a/nanoFramework.Aws.IoTCore.Devices/StatusUpdatedEventArgs.cs b/nanoFramework.Aws.IoTCore.Devices/StatusUpdatedEventArgs.cs
@@ -1,5 +1,7 @@
-﻿// Copyright (c) .Net Foundation. All rights reserved.
-// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
 
 using System;
 
diff --git a/nanoFramework.Aws.IoTCore.Devices/WebsocketConnectionClient.cs b/nanoFramework.Aws.IoTCore.Devices/WebsocketConnectionClient.cs
@@ -1,4 +1,9 @@
-﻿using System;
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using System;
 
 namespace nanoFramework.Aws.IoTCore.Devices.Devices.Client
 {

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,12 @@`
	`1`	`+//`
	`2`	`+// Copyright (c) .NET Foundation and Contributors`
	`3`	`+// See LICENSE file in the project root for full license information.`
	`4`	`+//`
	`5`	`+`
`1`	`6`	`using nanoFramework.TestFramework;`
`2`	`7`	`using System;`
`3`	`8`
`4`		`-namespace nanoFramwwork.Aws.IoTCore.Devices.Tests`
	`9`	`+namespace nanoFramework.Aws.IoTCore.Devices.Tests`
`5`	`10`	`{`
`6`	`11`	`[TestClass]`
`7`	`12`	`public class ShadowTests`
`@@ -15,7 +20,7 @@ public void get_shadow_json_to_class()`
`15`	`20`	`[TestMethod]`
`16`	`21`	`public void get_shadow_class_to_json()`
`17`	`22`	`{`
`18`		`- //technicallly un-necessary, but a good check!`
	`23`	`+ //technically un-necessary, but a good check!`
`19`	`24`	`// need to make sure the above method passes before attempting this!`
`20`	`25`	`}`
`21`	`26`
`@@ -28,8 +33,8 @@ public void update_shadow_recieved_json_to_class()`
`28`	`33`	`[TestMethod]`
`29`	`34`	`public void create_update_shadow_to_send_class()`
`30`	`35`	`{`
`31`		`- //technicallly un-necessary, but a good check!`
`32`		`- //in the realworld, this would be a different class.`
	`36`	`+ //technically un-necessary, but a good check!`
	`37`	`+ //in the real world, this would be a different class.`
`33`	`38`	`// need to make sure the above method passes before attempting this!`
`34`	`39`	`}`
`35`	`40`