v1.1.0 release

Author: seayxu

GodSharp.SerialPort.sln

@@ -22,6 +22,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nuspec", "nuspec", "{7518D83B-3290-4EB6-89BA-BC1A165A729F}"
+	ProjectSection(SolutionItems) = preProject
+		src\GodSharp.SerialPort\GodSharp.SerialPort.nuspec = src\GodSharp.SerialPort\GodSharp.SerialPort.nuspec
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
 		src\GodSharp.Shared\GodSharp.Shared.projitems*{42d420d1-b004-457d-99a0-913742aa3834}*SharedItemsImports = 13
@@ -52,5 +57,6 @@ Global
 		{4006DD01-8B21-4246-A7CF-A15421738486} = {A9C28F7F-0F11-4E92-B31A-BF950A54F863}
 		{64A904FC-399A-4D07-99F5-1B5CCD9FF17A} = {0D3F3351-97B4-4A86-B885-991892A0FAD9}
 		{DE27FFB1-2029-4FF5-892E-6F4274460CF1} = {0D3F3351-97B4-4A86-B885-991892A0FAD9}
+		{7518D83B-3290-4EB6-89BA-BC1A165A729F} = {A9C28F7F-0F11-4E92-B31A-BF950A54F863}
 	EndGlobalSection
 EndGlobal

README.md

@@ -1,8 +1,12 @@
 # GodSharp.SerialPort
-Easy to use SerialPort class.
+An easy-to-use .NET SerialPort class.
 
 [![AppVeyor build status](https://img.shields.io/appveyor/ci/seayxu/godsharp-serialport.svg?label=appveyor&style=flat-square)](https://ci.appveyor.com/project/seayxu/godsharp-serialport/) [![NuGet](https://img.shields.io/nuget/v/GodSharp.SerialPort.svg?label=nuget&style=flat-square)](https://www.nuget.org/packages/GodSharp.SerialPort/) [![MyGet](https://img.shields.io/myget/seay/v/GodSharp.SerialPort.svg?label=myget&style=flat-square)](https://www.myget.org/Package/Details/seay?packageType=nuget&packageId=GodSharp.SerialPort)
 
+
+# Requirement
+.NET Framework >= 3.5
+
 # Getting Started
 
 1. New instance GodSerialPort.
@@ -11,10 +15,35 @@ Easy to use SerialPort class.
 GodSerialPort serial = new GodSerialPort("COM1", 9600);
 ```
 
-2. Initialize the GodSerialPort instance with received data action: `Action<byte[]>`.
+About params:
+
+- Parity value.
+
+  - Parity.Space：0|s|space
+  - Parity.Mark：1|m|mark
+  - Parity.Even：2|e|even
+  - Parity.Odd：3|o|odd
+  - Parity.None：4|n|none
+
+- StopBits value.
+
+  - StopBits.None：0|n|none
+  - StopBits.One：1|o|one
+  - StopBits.OnePointFive：3|opf|of|f
+  - StopBits.Two：2|t|two
 
+- Handshake value.
+
+  - Handshake.None：0|n|none
+  - Handshake.RequestToSend：1|r|rst
+  - Handshake.RequestToSendXOnXOff：2|rtsxx|rsxx|rtsx|rsx|rx
+  - Handshake.XOnXOff：3|x|xx
+
+2. Use `DataReceived` event with received data action: `Action<byte[]>`.
+
+**Notice**:*This is not need when you read data by read method.*
 ```
-serial.Init((bytes)=>{});
+serial.UseDataReceived((bytes)=>{});
 ```
 
 3. Open SerialPort object.
@@ -28,31 +57,16 @@ serial.Open();
 ```
 byte[] bytes = new byte[]{31,32,33,34};
 serial.Write(bytes);
-serial.WriteAsciiString("ascii string");
+serial.Write(bytes,offset:1,count:2);
 serial.WriteHexString("7E 48 53 44");
+serial.WriteAsciiString("ascii string");
 ```
 
-5. Parity value.
-
-- Parity.Space：0|s|space
-- Parity.Mark：1|m|mark
-- Parity.Even：2|e|even
-- Parity.Odd：3|o|odd
-- Parity.None：4|n|none
-
-6. StopBits value.
-
-- StopBits.None：0|n|none
-- StopBits.One：1|o|one
-- StopBits.OnePointFive：3|opf|of|f
-- StopBits.Two：2|t|two
-
-7. Handshake value.
-
-- Handshake.None：0|n|none
-- Handshake.RequestToSend：1|r|rst
-- Handshake.RequestToSendXOnXOff：2|rtsxx|rsxx|rtsx|rsx|rx
-- Handshake.XOnXOff：3|x|xx
+5. Read data.
+```
+byte[] bytes = serial.Read();
+string stringAsciiOrHex = serial.ReadString();
+```
 
 # Sample
 
@@ -70,7 +84,7 @@ class Program
         }
 
         GodSerialPort gsp = new GodSerialPort("COM"+num, 9600);
-        gsp.Init((bytes) => {
+        gsp.UseDataReceived((bytes) => {
              string buffer = string.Join(" ", bytes);
              Console.WriteLine("receive data:" + buffer);
         });
@@ -105,3 +119,16 @@ class Program
     }
 }
 ```
+
+# Notes
+
+## 1.0.0
+- The first version release.
+
+## 1.0.1
+- Fix ctor and comments.
+
+## 1.1.0
+- 1.Add UseDataReceived method use to trigger DataReceived event.
+- 2.The read metnod can be used to end character.
+- 3.Add sleep time when try read data.

src/GodSharp.SerialPort/GodSharp.SerialPort.nuspec

@@ -2,7 +2,7 @@
 <package >
   <metadata>
     <id>GodSharp.SerialPort</id>
-    <version>1.0.1</version>
+    <version>1.1.0</version>
     <title>GodSharp.SerialPort</title>
     <authors>seayxu</authors>
     <owners>seayxu</owners>
@@ -11,7 +11,20 @@
     <iconUrl>https://avatars3.githubusercontent.com/u/26563296</iconUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>An easy-to-use .NET SerialPort class.</description>
-    <releaseNotes>An easy-to-use .NET SerialPort class.</releaseNotes>
+    <releaseNotes>
+      An easy-to-use .NET SerialPort class.(.NET Framework >= 3.5)
+
+      1.1.0
+      - 1.Add UseDataReceived method use to trigger DataReceived event.
+      - 2.The read metnod can be used to end character.
+      - 3.Add sleep time when try read data.
+
+      1.0.1
+      - 1.Fix ctor and comments.
+
+      1.0.0
+      - 1.The first version release.
+    </releaseNotes>
     <copyright>Copyright GodSharp 2017</copyright>
     <tags>GodSharp.SerialPort,GodSerialPort,SerialPort,GodSharp</tags>
   </metadata>

src/GodSharp.SerialPort/Properties/AssemblyInfo.cs

@@ -31,5 +31,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("1.1.*")]
 //[assembly: AssemblyFileVersion("1.0.0.0")]