Update README.md

Fix typo

README.md

@@ -0,0 +1,69 @@
+# Waveshare UART fingerprint sensor (C)
+
+A C# library for the [**Waveshare UART fingerprint sensor (C)**][Sensor], running on
+.Net Framework 4.7 (**Mono**) on a **Raspberry Pi**
+
+This library is tested using a Raspberry Pi Zero (hence the use of Mono)
+but should work on any Raspberry.  
+It should also be easily portable to any device that supports Mono
+or an equivalent (*.Net Core*).
+
+## Usage
+
+- First install it from [**nuget**](https://www.nuget.org/packages/WaveshareUARTFingerprintSensor/)
+
+Then you only need to start the sensor
+
+```csharp
+// PrimarySerialPort refers to /dev/ttyAMA0
+// SecondarySerialPort refers to /dev/ttyS0
+// You need to choose it according to your Raspberry
+// Check the table below
+var sensor = new FingerprintSensor(FingerprintSensor.PrimarySerialPort);
+
+sensor.Start();
+
+// Do any command
+
+// Example: get the user count
+if (sensor.TryGetUserCount(out ushort count))
+{
+    Console.WriteLine($"User count: {count}");
+}
+```
+
+Here is a table of which serial port to use on which Raspberry Pi,
+it may be different for you
+
+| Model     | Port                   |
+| --------- | ---------------------- |
+| Pi Zero   | Primary (/dev/ttyAMA0) |
+| Pi Zero W | Secondary (/dev/ttyS0) |
+| Pi 1      | Primary (/dev/ttyAMA0) |
+| Pi 2      | Primary (/dev/ttyAMA0) |
+| Pi 3      | Secondary (/dev/ttyS0) |
+| Pi 4      | Secondary (/dev/ttyS0) |
+
+> The Secondary UART is **disabled by default**, you an activate it in `raspi-config`  
+> [**Source**](https://www.raspberrypi.org/documentation/configuration/uart.md)
+
+## Sample App
+
+You can find a [**sample app**](WaveshareUARTFingerprintSensor.Sample) which shows basic usages of
+this library and may help you to understand how to use it
+
+## Contributing
+
+If you have a feature idea or want to report a bug, don't hesitate to create a new
+[**Issue**](https://github.com/Eveldee/WaveshareUARTFingerprintSensor/issues) or do a
+[**Pull Request**](https://github.com/Eveldee/WaveshareUARTFingerprintSensor/pulls)
+
+## Copyright and license
+
+*[**WaveshareUARTFingerprintSensor**](README.md)* library is licensed under the [MIT License](LICENSE).
+
+*[**Unosquare.Raspberry.IO**](https://github.com/migueldeicaza/gui.cs/)* library is under the [MIT License](https://github.com/unosquare/raspberryio/blob/master/LICENSE).
+
+
+<!-- Links -->
+[Sensor]: https://www.waveshare.com/wiki/UART_Fingerprint_Sensor_(C)

WaveshareUARTFingerprintSensor.Sample/Program.cs

@@ -9,19 +9,14 @@ using Terminal.Gui;
 using Unosquare.RaspberryIO;
 using Unosquare.RaspberryIO.Abstractions;
 using Unosquare.WiringPi;
+using WaveshareUARTFingerprintSensor.Sample.Views;
 
 namespace WaveshareUARTFingerprintSensor.Sample
 {
     class Program
     {
-        public static FingerprintSensor FingerprintSensor { get; private set; }
-
         static void Main(string[] args)
         {
-            FingerprintSensor = new FingerprintSensor(FingerprintSensor.SecondarySerialPort);
-
-            FingerprintSensor.Start();
-
             Application.Run<TUIManager>();
         }
     }

WaveshareUARTFingerprintSensor.Sample/README.md

@@ -0,0 +1,24 @@
+# Sample App
+
+A sample app for the [Waveshare UART fingerprint sensor (C) library](../README.md)
+
+![Sample](../Sample.png)
+
+[![asciicast](https://asciinema.org/a/U1cBQzJ3ueFyN0urkh2NRcjB9.svg)](https://asciinema.org/a/U1cBQzJ3ueFyN0urkh2NRcjB9)
+
+## Build
+
+You can compile it using any **C# IDE** that supports **.Net Framework** or by running
+`dotnet build` in a **terminal** using [**.Net CLI**](https://docs.microsoft.com/en-us/dotnet/core/tools/)
+
+## Usage
+
+- Install [**Mono**](https://www.mono-project.com/) on your Raspberry Pi
+- [**Download**](https://github.com/Eveldee/WaveshareUARTFingerprintSensor/releases) or [**Build**](#build) the application
+- Run it with `mono WaveshareUARTFingerprintSensor.Sample.exe`
+
+## Copyright and license
+
+[**WaveshareUARTFingerprintSensor**](../README.md) library is licensed under the [MIT License](../LICENSE).
+
+[**gui.cs**](https://github.com/migueldeicaza/gui.cs/) library is under the [MIT License](https://github.com/migueldeicaza/gui.cs/blob/master/LICENSE).

WaveshareUARTFingerprintSensor.Sample/Views/DataDisplay.cs

@@ -6,7 +6,7 @@ using System.Text;
 using System.Threading.Tasks;
 using Terminal.Gui;
 
-namespace WaveshareUARTFingerprintSensor.Sample
+namespace WaveshareUARTFingerprintSensor.Sample.Views
 {
     public class DataDisplay : Toplevel
     {
@@ -23,10 +23,12 @@ namespace WaveshareUARTFingerprintSensor.Sample
 
         private void Init()
         {
+            Modal = true;
+
             ColorScheme = Colors.TopLevel;
 
             // Creates the top-level window to show
-            var win = new Window("TUIManager")
+            var win = new Window(_title)
             {
                 X = 0,
                 Y = 0,

WaveshareUARTFingerprintSensor.Sample/Views/EntryDialog.cs

@@ -6,7 +6,7 @@ using System.Text;
 using System.Threading.Tasks;
 using Terminal.Gui;
 
-namespace WaveshareUARTFingerprintSensor.Sample
+namespace WaveshareUARTFingerprintSensor.Sample.Views
 {
     public class EntryDialog : Dialog
     {

WaveshareUARTFingerprintSensor.Sample/Views/FingerprintDialog.cs

@@ -6,7 +6,7 @@ using System.Text;
 using System.Threading.Tasks;
 using Terminal.Gui;
 
-namespace WaveshareUARTFingerprintSensor.Sample
+namespace WaveshareUARTFingerprintSensor.Sample.Views
 {
     public class FingerprintDialog : Dialog
     {

WaveshareUARTFingerprintSensor.Sample/Views/SettingsDisplay.cs

@@ -0,0 +1,73 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Terminal.Gui;
+
+namespace WaveshareUARTFingerprintSensor.Sample.Views
+{
+    public class SettingsDisplay : Toplevel
+    {
+        private string _port;
+        private RadioGroup _radioPort;
+
+        public SettingsDisplay()
+        {
+            Init();
+        }
+
+        private void Init()
+        {
+            Modal = true;
+
+            ColorScheme = Colors.Error;
+
+            // Creates the top-level window to show
+            var win = new Window("Settings")
+            {
+                X = 0,
+                Y = 0,
+
+                // By using Dim.Fill(), it will automatically resize without manual intervention
+                Width = Dim.Fill(),
+                Height = Dim.Fill()
+            };
+
+            win.ColorScheme = Colors.ColorSchemes["Dialog"];
+
+            Add(win);
+
+            // Window Content
+            var portLabel = new Label("Serial Port:")
+            {
+                X = 4,
+                Y = 3
+            };
+            _radioPort = new RadioGroup(new NStack.ustring[] { FingerprintSensor.PrimarySerialPort, FingerprintSensor.SecondarySerialPort })
+            {
+                X = Pos.Right(portLabel) + 2,
+                Y = Pos.Top(portLabel),
+                Width = Dim.Fill()
+            };
+
+            var saveButton = new Button("_Save")
+            {
+                X = Pos.Right(this) - 14,
+                Y = Pos.Bottom(this) - 4
+            };
+            saveButton.Clicked += () => { Save();  Application.RequestStop(); };
+
+            win.Add(portLabel, _radioPort, saveButton);
+        }
+
+        private void Save()
+        {
+            _port = _radioPort.RadioLabels[_radioPort.SelectedItem].ToString();
+
+            File.WriteAllText(TUIManager.SettingsFilePath, _port);
+        }
+    }
+}

WaveshareUARTFingerprintSensor.Sample/Views/SleepDisplay.cs

@@ -0,0 +1,108 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Terminal.Gui;
+
+namespace WaveshareUARTFingerprintSensor.Sample.Views
+{
+    public class SleepDisplay : Toplevel
+    {
+        private FingerprintSensor _fingerprintSensor;
+        private int _count;
+        private int _lastID;
+        private Label _sleepModeLabel;
+        private Label _readCountLabel;
+        private Label _lastReadLabel;
+
+        public SleepDisplay(FingerprintSensor fingerprintSensor)
+        {
+            _fingerprintSensor = fingerprintSensor;
+            _count = 0;
+            _lastID = -1;
+
+            Init();
+        }
+
+        private void Init()
+        {
+            Modal = true;
+
+            ColorScheme = Colors.Error;
+
+            // Creates the top-level window to show
+            var win = new Window("Sleep")
+            {
+                X = 0,
+                Y = 0,
+
+                // By using Dim.Fill(), it will automatically resize without manual intervention
+                Width = Dim.Fill(),
+                Height = Dim.Fill()
+            };
+
+            win.ColorScheme = Colors.ColorSchemes["Dialog"];
+
+            Add(win);
+
+            // Window Content
+            _sleepModeLabel = new Label("Sleep mode is on, waiting for fingerprints...")
+            {
+                X = 2,
+                Y = 1,
+                Width = Dim.Fill()
+            };
+            _readCountLabel = new Label("Read: 0")
+            {
+                X = Pos.Left(_sleepModeLabel),
+                Y = Pos.Bottom(_sleepModeLabel) + 1,
+                Width = Dim.Fill()
+            };
+            _lastReadLabel = new Label("Last User: - 1")
+            {
+                X = Pos.Left(_readCountLabel),
+                Y = Pos.Bottom(_readCountLabel),
+                Width = Dim.Fill()
+            };
+
+            var stopButton = new Button("_Stop")
+            {
+                X = Pos.Right(this) - 11,
+                Y = Pos.Bottom(this) - 2
+            };
+            stopButton.Clicked += () => { _fingerprintSensor.Waked -= FingerprintSensor_Waked; Application.RequestStop(); };
+
+            win.Add(_sleepModeLabel, _readCountLabel, _lastReadLabel);
+
+            Add(stopButton);
+
+            _fingerprintSensor.Waked += FingerprintSensor_Waked;
+
+            _fingerprintSensor.Sleep();
+        }
+
+        private void UpdateInfo()
+        {
+            _readCountLabel.Text = $"Read: {_count}";
+            _lastReadLabel.Text = $"Last User: {_lastID}";
+        }
+
+        private void FingerprintSensor_Waked(FingerprintSensor sender)
+        {
+            _fingerprintSensor.Wake();
+
+            if (_fingerprintSensor.TryComparison1N(out var userInfo))
+            {
+                _count += 1;
+                _lastID = userInfo.userID;
+
+                Application.MainLoop.Invoke(UpdateInfo);
+            }
+
+            _fingerprintSensor.Sleep();
+        }
+    }
+}

WaveshareUARTFingerprintSensor.Sample/Views/TUIManager.cs

@@ -7,13 +7,15 @@ using System.Text;
 using System.Threading.Tasks;
 using Terminal.Gui;
 
-namespace WaveshareUARTFingerprintSensor.Sample
+namespace WaveshareUARTFingerprintSensor.Sample.Views
 {
     public class TUIManager : Toplevel
     {
         public const string OutputFilePath = "out.txt";
+        public const string SettingsFilePath = "settings.txt";
 
-        private readonly FingerprintSensor _fingerprintSensor;
+        private FingerprintSensor _fingerprintSensor;
+        private Label _serialPortLabel;
         private Label _comparisonLevelLabel;
         private Label _userCountLabel;
 
@@ -21,8 +23,6 @@ namespace WaveshareUARTFingerprintSensor.Sample
 
         public TUIManager()
         {
-            _fingerprintSensor = Program.FingerprintSensor;
-
             Init();
         }
 
@@ -48,7 +48,7 @@ namespace WaveshareUARTFingerprintSensor.Sample
             // Creates a menubar, the item "New" has a help menu.
             var menu = new MenuBar(new MenuBarItem[] {
                 new MenuBarItem ("_Options", new MenuItem [] {
-                    new MenuItem ("Reset Config", "", () => { ResetConfig(); }),
+                    new MenuItem ("_Change Config", "", () => { ChangeConfig(); }),
                     new MenuItem ("_Quit", "", () => { Application.RequestStop(); })
                 })
             });
@@ -56,12 +56,18 @@ namespace WaveshareUARTFingerprintSensor.Sample
             Add(menu);
 
             // Window Content
-            _comparisonLevelLabel = new Label("Comparison Level: 0")
+            _serialPortLabel = new Label("Serial Port:")
             {
                 X = 2,
                 Y = 1,
                 Width = Dim.Fill()
             };
+            _comparisonLevelLabel = new Label("Comparison Level: 0")
+            {
+                X = Pos.Left(_serialPortLabel),
+                Y = Pos.Bottom(_serialPortLabel),
+                Width = Dim.Fill()
+            };
             _userCountLabel = new Label("Users: 0")
             {
                 X = Pos.Left(_comparisonLevelLabel),
@@ -140,6 +146,7 @@ namespace WaveshareUARTFingerprintSensor.Sample
             quitButton.Clicked += Quit_Clicked;
 
             win.Add(
+                _serialPortLabel,
                 _comparisonLevelLabel,
                 _userCountLabel,
                 userCountButton,
@@ -154,10 +161,30 @@ namespace WaveshareUARTFingerprintSensor.Sample
                 quitButton
             );
 
+            // Init Sensor
+            if (!File.Exists(SettingsFilePath))
+            {
+                Application.Run(new SettingsDisplay());
+            }
+
+            InitSensor();
+
+            // Update gui
+            UpdateSerialPort();
             UpdateUserCount();
             UpdateComparisonLevel();
+        }
 
-            // TODO Config at first start
+        private void UpdateSerialPort()
+        {
+            _serialPortLabel.Text = $"Serial Port: {_fingerprintSensor.PortName}";
+        }
+
+        private void InitSensor()
+        {
+            _fingerprintSensor = new FingerprintSensor(File.ReadAllText(SettingsFilePath));
+
+            _fingerprintSensor.Start();
         }
 
         private void UpdateUserCount()
@@ -264,7 +291,9 @@ namespace WaveshareUARTFingerprintSensor.Sample
 
         private void SleepButton_Clicked()
         {
-            //TODO
+            var window = new SleepDisplay(_fingerprintSensor);
+
+            Application.Run(window);
         }
 
         private void ClearFingerprintsButton_Clicked()
@@ -368,11 +397,15 @@ namespace WaveshareUARTFingerprintSensor.Sample
             });
         }
 
-        private void ResetConfig()
+        private void ChangeConfig()
         {
-            MessageBox.Query("Reset Config", "Config reset", "OK");
+            File.Delete(SettingsFilePath);
 
-            //TODO
+            Application.Run(new SettingsDisplay());
+
+            InitSensor();
+
+            UpdateSerialPort();
         }
 
         private void Quit_Clicked()

WaveshareUARTFingerprintSensor.Sample/WaveshareUARTFingerprintSensor.Sample.csproj

@@ -99,12 +99,14 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="DataDisplay.cs" />
-    <Compile Include="EntryDialog.cs" />
-    <Compile Include="FingerprintDialog.cs" />
+    <Compile Include="Views\DataDisplay.cs" />
+    <Compile Include="Views\EntryDialog.cs" />
+    <Compile Include="Views\FingerprintDialog.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
-    <Compile Include="TUIManager.cs" />
+    <Compile Include="Views\SettingsDisplay.cs" />
+    <Compile Include="Views\SleepDisplay.cs" />
+    <Compile Include="Views\TUIManager.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />

WaveshareUARTFingerprintSensor/CommandType.cs

@@ -6,6 +6,9 @@ using System.Threading.Tasks;
 
 namespace WaveshareUARTFingerprintSensor
 {
+    /// <summary>
+    /// Command flags recognized by the sensor
+    /// </summary>
     public enum CommandType : byte
     {
         ModifySerialNumber = 0x08,

WaveshareUARTFingerprintSensor/FingerprintSensor.cs

@@ -16,17 +16,45 @@ namespace WaveshareUARTFingerprintSensor
 {
     public class FingerprintSensor : IDisposable
     {
+        /// <summary>
+        /// Primary serial port on the RPI. <see href="https://www.raspberrypi.org/documentation/configuration/uart.md">Source</see>
+        /// </summary>
         public const string PrimarySerialPort = "/dev/ttyAMA0";
+        /// <summary>
+        /// Secondary serial port on the RPI. <see href="https://www.raspberrypi.org/documentation/configuration/uart.md">Source</see>
+        /// </summary>
         public const string SecondarySerialPort = "/dev/ttyS0";
+        /// <summary>
+        /// Timeout used for the <see cref="SerialPort"/> I/O operations
+        /// </summary>
         public const int DefaultTimeout = 10_000;
+        /// <summary>
+        /// Maximum number of user that the sensor can store before throwing <see cref="ResponseType.Full"/>. It is also the ID of the last user
+        /// </summary>
         public const int MaxUserID = 0xFFF;
+        /// <summary>
+        /// Internal buffer size
+        /// </summary>
         public const int DataBufferSize = 4095;
 
+        /// <summary>
+        /// Thrown when "WAKE" pin is high, works like a press button. Can be used while the sensor is asleep
+        /// </summary>
         public event WakedEventHandler Waked;
+        /// <summary>
+        /// Delegate for the <see cref="Waked"/> event
+        /// </summary>
+        /// <param name="sender"></param>
         public delegate void WakedEventHandler(FingerprintSensor sender);
 
+        /// <summary>
+        /// <see cref="SerialPort"/> name/path used
+        /// </summary>
         public string PortName { get; }
 
+        /// <summary>
+        /// Mark the end of a command packet, usually the 8th byte
+        /// </summary>
         private const byte PacketSeparator = 0xF5;
 
         private SerialPort _serialPort;
@@ -37,6 +65,12 @@ namespace WaveshareUARTFingerprintSensor
         private bool _sleeping = false;
         private readonly object _lock = new object();
 
+        /// <summary>
+        /// Create a new instance of <see cref="FingerprintSensor"/>, don't forget to call <see cref="Start"/> before using any command
+        /// </summary>
+        /// <param name="portName">A valid name/path to a serial port, see <see cref="PrimarySerialPort"/> and <see cref="SecondarySerialPort"/> for the RPI</param>
+        /// <param name="wakePin">WAKE <see cref="GpioPin"/> number, default is according to the sensor documentation wiring</param>
+        /// <param name="rstPin">RST <see cref="GpioPin"/> number, default is according to the sensor documentation wiring</param>
         public FingerprintSensor(string portName, int wakePin = 23, int rstPin = 24)
         {
             PortName = portName;
@@ -44,6 +78,9 @@ namespace WaveshareUARTFingerprintSensor
             _rstPinNumber = rstPin;
         }
 
+        /// <summary>
+        /// Start the sensor, initializing <see cref="BootstrapWiringPi"/>, the Gpio pins and the <see cref="SerialPort"/>
+        /// </summary>
         public void Start()
         {
             // Initialize Gpio
@@ -64,6 +101,11 @@ namespace WaveshareUARTFingerprintSensor
             _serialPort.Open();
         }
 
+        /// <summary>
+        /// Compute the checksum for a command packet: XOR of <see cref="byte"/> 1 to 5 (counting from 0)
+        /// </summary>
+        /// <param name="data">A command packet, usually 8 bytes</param>
+        /// <returns>The computed checksum, usually stored in the 6th <see cref="byte"/></returns>
         private byte ComputeChecksum(byte[] data)
         {
             byte checksum = 0;
@@ -76,6 +118,12 @@ namespace WaveshareUARTFingerprintSensor
             return checksum;
         }
 
+        /// <summary>
+        /// Compute the checksum for a data packet: XOR of <see cref="byte"/> 1 to (last - 2) (counting from 0)
+        /// </summary>
+        /// <param name="data">A data, not to be confused with a command packet</param>
+        /// <param name="length">Length of the data packet, should be 2 bytes less than data.Length</param>
+        /// <returns>The computed checksum, usually stored in the (last - 2)th byte</returns>
         private byte ComputeChecksumData(byte[] data, int length)
         {
             byte checksum = 0;
@@ -88,6 +136,15 @@ namespace WaveshareUARTFingerprintSensor
             return checksum;
         }
 
+        /// <summary>
+        /// Send an 8 <see cref="byte"/> command and read the response, can throw an <see cref="Exception"/>
+        /// </summary>
+        /// <param name="commandType">Command flag, see <see cref="CommandType"/></param>
+        /// <param name="first">First data <see cref="byte"/>, the 2th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="second">Second data <see cref="byte"/>, the 3th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="third">Third data <see cref="byte"/>, the 4th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="timeout">Timeout used for the <see cref="SerialPort"/>, default to <see cref="DefaultTimeout"/></param>
+        /// <returns>The 3 data <see cref="byte"/> from the response (2, 3 and 4), the third one is parsed as a <see cref="ResponseType"/></returns>
         private (byte first, byte second, ResponseType responseType) SendAndReceive(CommandType commandType, byte first, byte second, byte third, int timeout = DefaultTimeout)
         {
             if (_sleeping)
@@ -132,6 +189,15 @@ namespace WaveshareUARTFingerprintSensor
             return (buffer[2], buffer[3], (ResponseType)buffer[4]);
         }
 
+        /// <summary>
+        /// Send an 8 <see cref="byte"/> command and read the response, can throw an <see cref="Exception"/>
+        /// </summary>
+        /// <param name="commandType">Command flag, see <see cref="CommandType"/></param>
+        /// <param name="first">First data <see cref="byte"/>, the 2th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="second">Second data <see cref="byte"/>, the 3th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="third">Third data <see cref="byte"/>, the 4th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="timeout">Timeout used for the <see cref="SerialPort"/>, default to <see cref="DefaultTimeout"/></param>
+        /// <returns>The 3 data <see cref="byte"/> from the response (2, 3 and 4)</returns>
         private (byte first, byte second, byte third) SendAndReceiveRaw(CommandType commandType, byte first, byte second, byte third, int timeout = DefaultTimeout)
         {
             (byte f, byte s, ResponseType response) = SendAndReceive(commandType, first, second, third, timeout);
@@ -139,6 +205,16 @@ namespace WaveshareUARTFingerprintSensor
             return (f, s, (byte)response);
         }
 
+        /// <summary>
+        /// Send an 8 <see cref="byte"/> command and read the response without throwing an <see cref="Exception"/>
+        /// </summary>
+        /// <param name="commandType">Command flag, see <see cref="CommandType"/></param>
+        /// <param name="first">First data <see cref="byte"/>, the 2th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="second">Second data <see cref="byte"/>, the 3th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="third">Third data <see cref="byte"/>, the 4th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="response">The response as returned by <see cref="SendAndReceive(CommandType, byte, byte, byte, int)"/></param>
+        /// <param name="timeout">Timeout used for the <see cref="SerialPort"/>, default to <see cref="DefaultTimeout"/></param>
+        /// <returns>true if successful, false otherwise</returns>
         private bool TrySendAndReceive(CommandType commandType, byte first, byte second, byte third, out (byte first, byte second, ResponseType responseType) response, int timeout = DefaultTimeout)
         {
             try
@@ -155,6 +231,16 @@ namespace WaveshareUARTFingerprintSensor
             return true;
         }
 
+        /// <summary>
+        /// Send an 8 <see cref="byte"/> command and read the response without throwing an <see cref="Exception"/>
+        /// </summary>
+        /// <param name="commandType">Command flag, see <see cref="CommandType"/></param>
+        /// <param name="first">First data <see cref="byte"/>, the 2th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="second">Second data <see cref="byte"/>, the 3th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="third">Third data <see cref="byte"/>, the 4th <see cref="byte"/> (counting from 0)</param>
+        /// <param name="response">The response as returned by <see cref="SendAndReceive(CommandType, byte, byte, byte, int)"/></param>
+        /// <param name="timeout">Timeout used for the <see cref="SerialPort"/>, default to <see cref="DefaultTimeout"/></param>
+        /// <returns>true if successful, false otherwise</returns>
         private bool TrySendAndReceiveRaw(CommandType commandType, byte first, byte second, byte third, out (byte first, byte second, byte third) response, int timeout = DefaultTimeout)
         {
             try
@@ -171,6 +257,12 @@ namespace WaveshareUARTFingerprintSensor
             return true;
         }
 
+        /// <summary>
+        /// Read a data packet
+        /// </summary>
+        /// <param name="length">The length of the data packet</param>
+        /// <param name="skipChecksum">An invalid checksum will throw an <see cref="Exception"/>, use this to ignore the checksum</param>
+        /// <returns></returns>
         private byte[] ReadData(int length, bool skipChecksum = false)
         {
             byte first = (byte)_serialPort.ReadByte();
@@ -200,6 +292,10 @@ namespace WaveshareUARTFingerprintSensor
             return data;
         }
 
+        /// <summary>
+        /// Query the sensor serial number
+        /// </summary>
+        /// <returns></returns>
         public uint QuerySerialNumber()
         {
             (byte first, byte second, byte third) = SendAndReceiveRaw(CommandType.QuerySerialNumber, 0, 0, 0);
@@ -207,6 +303,11 @@ namespace WaveshareUARTFingerprintSensor
             return Utils.Merge(first, second, third);
         }
 
+        /// <summary>
+        /// Get the number of registered users (fingerprints)
+        /// </summary>
+        /// <param name="count">User count if the command is successful</param>
+        /// <returns></returns>
         public bool TryGetUserCount(out ushort count)
         {
             if (TrySendAndReceive(CommandType.QueryUserCount, 0, 0, 0, out var response, 1000))
@@ -223,6 +324,12 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Add a fingerprint by sending three commands, with a delay between each to ensure the fingerprint is perfectly read
+        /// </summary>
+        /// <param name="userID">The id where to store the user (fingerprint)</param>
+        /// <param name="userPermission">The <see cref="UserPermission"/> to store</param>
+        /// <returns></returns>
         public ResponseType AddFingerprint(ushort userID, UserPermission userPermission)
         {
             if (userID > MaxUserID)
@@ -312,6 +419,11 @@ namespace WaveshareUARTFingerprintSensor
             }
         }
 
+        /// <summary>
+        /// Delete a user (fingerprint) from the sensor
+        /// </summary>
+        /// <param name="userID">A valid user (fingerprint) id</param>
+        /// <returns>true if successful, false otherwise</returns>
         public bool DeleteUser(ushort userID)
         {
             (byte high, byte low) = Utils.Split(userID);
@@ -324,6 +436,10 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Delete all users (fingerprints) from the sensor
+        /// </summary>
+        /// <returns>true if successful, false otherwise</returns>
         public bool DeleteAllUsers()
         {
             if (TrySendAndReceive(CommandType.DeleteAllUsers, 0, 0, 0, out var response, 1000))
@@ -334,6 +450,11 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Delete all users that match a specified <see cref="UserPermission"/>
+        /// </summary>
+        /// <param name="userPermission"></param>
+        /// <returns>true if successful, false otherwise</returns>
         public bool DeleteAllUsersWithPermission(UserPermission userPermission)
         {
             if (TrySendAndReceive(CommandType.DeleteAllUsers, 0, 0, (byte)userPermission, out var response, 1000))
@@ -348,12 +469,12 @@ namespace WaveshareUARTFingerprintSensor
         /// Read a fingerprint and check if it matches with the specified user
         /// </summary>
         /// <param name="userID">A registered user ID</param>
-        /// <returns></returns>
+        /// <returns>true if the fingerprint match</returns>
         public bool Comparison11(ushort userID)
         {
             (byte high, byte low) = Utils.Split(userID);
 
-            if (TrySendAndReceive(CommandType.Comparison11, high, low, 0, out var response, 1000))
+            if (TrySendAndReceive(CommandType.Comparison11, high, low, 0, out var response))
             {
                 return response.responseType == ResponseType.Success;
             }
@@ -365,10 +486,10 @@ namespace WaveshareUARTFingerprintSensor
         /// Read a fingerprint and check if it match with any registered user
         /// </summary>
         /// <param name="userInfo">The matched user info</param>
-        /// <returns></returns>
+        /// <returns>true if the fingerprint match</returns>
         public bool TryComparison1N(out (ushort userID, UserPermission permission) userInfo)
         {
-            if (TrySendAndReceive(CommandType.Comparison1N, 0, 0, 0, out var response, 1000))
+            if (TrySendAndReceive(CommandType.Comparison1N, 0, 0, 0, out var response))
             {
                 if (response.responseType != ResponseType.NoUser && response.responseType != ResponseType.Timeout)
                 {
@@ -383,6 +504,12 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Get the stored <see cref="UserPermission"/> for a user
+        /// </summary>
+        /// <param name="userID">A registered user</param>
+        /// <param name="userPermission"></param>
+        /// <returns>true if the user exist, false otherwise</returns>
         public bool TryQueryPermission(ushort userID, out UserPermission userPermission)
         {
             (byte high, byte low) = Utils.Split(userID);
@@ -402,6 +529,11 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Retrieve the comparison level used internally by the sensor to compare fingerprints
+        /// </summary>
+        /// <param name="comparisonLevel"></param>
+        /// <returns></returns>
         public bool TryGetComparisonLevel(out byte comparisonLevel)
         {
             if (TrySendAndReceive(CommandType.ManageComparisonLevel, 0, 0, 1, out var response, 1000))
@@ -420,7 +552,7 @@ namespace WaveshareUARTFingerprintSensor
         }
 
         /// <summary>
-        /// Set comparison level used to compare fingerprints
+        /// Set the comparison level used internally by the sensor to compare fingerprints
         /// </summary>
         /// <param name="comparisonLevel">A value in 0..9 range, 9 is the strictest, default is 5</param>
         /// <returns></returns>
@@ -439,6 +571,11 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Read a fingerprint and retrieve it's raw image
+        /// </summary>
+        /// <param name="image"></param>
+        /// <returns>true if a valid fingerprint has been read</returns>
         public bool TryAcquireImage(out byte[] image)
         {
              if (TrySendAndReceive(CommandType.AcquireImage, 0, 0, 0, out var response))
@@ -458,6 +595,11 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Read a fingerprint and retrieve the sensor computed eigenvalues
+        /// </summary>
+        /// <param name="eigenvalues"></param>
+        /// <returns>true if a valid fingerprint has been read</returns>
         public bool TryAcquireEigenvalues(out Span<byte> eigenvalues)
         {
             if (TrySendAndReceive(CommandType.AcquireEigenvalues, 0, 0, 0, out var response))
@@ -477,6 +619,13 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Retrieve the sensor computed eigenvalues from a registered user
+        /// </summary>
+        /// <param name="userID"></param>
+        /// <param name="eigenvalues"></param>
+        /// <param name="userPermission"></param>
+        /// <returns></returns>
         public bool TryAcquireUserEigenvalues(ushort userID, out Span<byte> eigenvalues, out UserPermission userPermission)
         {
             (byte high, byte low) = Utils.Split(userID);
@@ -501,16 +650,28 @@ namespace WaveshareUARTFingerprintSensor
             return false;
         }
 
+        /// <summary>
+        /// Make the sensor sleep, in this mode the sensor use less power (&lt;16 µA) but won't answer commands until it is waked using <see cref="Wake"/>.
+        /// <para/>
+        /// You can know when to wake the sensor using the <see cref="Waked"/> event that is still triggered while asleep
+        /// </summary>
         public void Sleep()
         {
             _sleeping = true;
             _rstPin.Write(GpioPinValue.Low);
         }
 
+        /// <summary>
+        /// Wake the sensor, do nothing if it was not sleeping
+        /// </summary>
         public void Wake()
         {
             _sleeping = false;
             _rstPin.Write(GpioPinValue.High);
+
+            // Needed after wake to really wake the sensor
+            // Because the first command always fail for whatever reason
+            TryGetUserCount(out var _);
         }
 
         private void OnWake()
@@ -521,6 +682,9 @@ namespace WaveshareUARTFingerprintSensor
             }
         }
 
+        /// <summary>
+        /// Dispose by disposing the <see cref="SerialPort"/> used
+        /// </summary>
         public void Dispose()
         {
             _serialPort.Close();

WaveshareUARTFingerprintSensor/Properties/AssemblyInfo.cs

@@ -5,12 +5,12 @@ using System.Runtime.InteropServices;
 // Les informations générales relatives à un assembly dépendent de
 // l'ensemble d'attributs suivant. Changez les valeurs de ces attributs pour modifier les informations
 // associées à un assembly.
-[assembly: AssemblyTitle("WaveshareUARTFingerprintSensor")]
-[assembly: AssemblyDescription("")]
+[assembly: AssemblyTitle("Waveshare UART Fingerprint Sensor (C)")]
+[assembly: AssemblyDescription("C# library for the Waveshare UART fingerprint sensor (C)")]
 [assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("")]
+[assembly: AssemblyCompany("Ilyx")]
 [assembly: AssemblyProduct("WaveshareUARTFingerprintSensor")]
-[assembly: AssemblyCopyright("Copyright ©  2020")]
+[assembly: AssemblyCopyright("")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 

WaveshareUARTFingerprintSensor/ResponseType.cs

@@ -6,10 +6,16 @@ using System.Threading.Tasks;
 
 namespace WaveshareUARTFingerprintSensor
 {
+    /// <summary>
+    /// If available, it is the third byte from a response packet
+    /// </summary>
     public enum ResponseType : byte
     {
         Success = 0x00,
         Fail = 0x01,
+        /// <summary>
+        /// Sensor has exceeded maximum number of users (0xFFF)
+        /// </summary>
         Full = 0x04,
         NoUser = 0x05,
         UserOccupied = 0x06,

WaveshareUARTFingerprintSensor/UserPermission.cs

@@ -1,5 +1,8 @@
 namespace WaveshareUARTFingerprintSensor
 {
+    /// <summary>
+    /// Permission level stored on the sensor for each user, it does not have any direct signification
+    /// </summary>
     public enum UserPermission : byte
     {
         Level1 = 1,

WaveshareUARTFingerprintSensor/Utils.cs

@@ -8,12 +8,41 @@ namespace WaveshareUARTFingerprintSensor
 {
     public static class Utils
     {
+        /// <summary>
+        /// Parse two <see cref="byte"/> to an <see cref="ushort"/> according to the sensor documentation
+        /// </summary>
+        /// <param name="high">Usually the first data <see cref="byte"/> from a response</param>
+        /// <param name="low">Usually the second data <see cref="byte"/> from a response</param>
+        /// <returns></returns>
         public static ushort Merge(byte high, byte low) => (ushort)(high << 8 | low);
+        /// <summary>
+        /// Parse threee <see cref="byte"/> to an <see cref="uint"/> according to the sensor documentation
+        /// </summary>
+        /// <param name="first">Usually the first data <see cref="byte"/> from a response</param>
+        /// <param name="second">Usually the second data <see cref="byte"/> from a response</param>
+        /// <param name="third">Usually the third data <see cref="byte"/> from a response</param>
+        /// <returns></returns>
         public static uint Merge(byte first, byte second, byte third) => (uint)(first << 16 | second << 8 | third);
 
+        /// <summary>
+        /// Split an <see cref="ushort"/> to two bytes according to the sensor documentation
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns>The first <see cref="byte"/> (high) and the second <see cref="byte"/> (low)</returns>
         public static (byte high, byte low) Split(ushort value) => ((byte)(value >> 8), (byte)(value & 0xFF));
+        /// <summary>
+        /// Split an <see cref="uint"/> to three bytes according to the sensor documentation
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
         public static (byte first, byte second, byte third) Split(uint value) => ((byte)(value >> 16 & 0xFF), (byte)(value >> 8 & 0xFF), (byte)(value & 0xFF));
 
+        /// <summary>
+        /// Display an array in a standard format
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="arr"></param>
+        /// <returns>A <see cref="string"/> in the form: [ element1, element2, element3, ... ]</returns>
         public static string ArrayDisplay<T>(T[] arr) => $"[ {string.Join(", ", arr)} ]";
     }
 }

WaveshareUARTFingerprintSensor/WaveshareUARTFingerprintSensor.nuspec

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package >
+  <metadata>
+    <id>$id$</id>
+    <version>$version$</version>
+    <title>Waveshare UART Fingerprint Sensor</title>
+    <authors>Eveldee</authors>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <license type="expression">MIT</license>
+    <projectUrl>https://github.com/Eveldee/WaveshareUARTFingerprintSensor</projectUrl>
+    <!-- <iconUrl>http://icon_url_here_or_delete_this_line/</iconUrl> -->
+    <description>C# library for the Waveshare UART fingerprint sensor (C)</description>
+    <releaseNotes>Initial version.</releaseNotes>
+    <copyright>$copyright$</copyright>
+    <tags>Fingerprint Sensor Waveshare UART</tags>
+  </metadata>
+</package>