Update 'WaveshareUARTFingerprintSensor.Sample/README.md'

Fix a bug

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 Zero 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/DataDisplay.cs

@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Terminal.Gui;
+
+namespace WaveshareUARTFingerprintSensor.Sample
+{
+    public class DataDisplay : Toplevel
+    {
+        private string _title;
+        private byte[] _data;
+
+        public DataDisplay(string title, byte[] data)
+        {
+            _title = title;
+            _data = data;
+
+            Init();
+        }
+
+        private void Init()
+        {
+            ColorScheme = Colors.TopLevel;
+
+            // Creates the top-level window to show
+            var win = new Window(_title)
+            {
+                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);
+
+            var quitButton = new Button("_Ok")
+            {
+                X = Pos.Right(this) - 9,
+                Y = Pos.Bottom(this) - 2
+            };
+            quitButton.Clicked += () => Application.RequestStop();
+
+            var stream = new MemoryStream(_data);
+            var text = new HexView(stream)
+            {
+                X = Pos.Center(),
+                Y = Pos.Center(),
+                Height = Dim.Fill() - 5,
+                Width = Dim.Fill() - 2,
+                AllowEdits = false
+            };
+
+            Add(text, quitButton);
+        }
+    }
+}

WaveshareUARTFingerprintSensor.Sample/EntryDialog.cs

@@ -0,0 +1,87 @@
+using NStack;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Terminal.Gui;
+
+namespace WaveshareUARTFingerprintSensor.Sample
+{
+    public class EntryDialog : Dialog
+    {
+        private Func<ustring, bool> _validator;
+        private bool _success;
+        private string _title;
+        private string _errorMessage;
+
+        public EntryDialog(string title, Func<ustring, bool> validator = null, string errorMessage = "") : base(title, 60, 7)
+        {
+            _title = title;
+            _errorMessage = errorMessage;
+
+            _validator = validator;
+
+            ColorScheme = Colors.ColorSchemes["Menu"];
+        }
+
+        public bool TryShow(out ustring input)
+        {
+            _success = false;
+
+            var levelEntry = new TextField("")
+            {
+                X = 1,
+                Y = 2,
+                Width = Dim.Fill(),
+                Height = 1
+            };
+
+            var cancelButton = new Button("_Cancel")
+            {
+                X = Pos.Percent(82),
+                Y = Pos.Percent(95)
+            };
+            cancelButton.Clicked += () => Application.RequestStop();
+
+
+            var okButton = new Button("_Ok")
+            {
+                X = Pos.Percent(70),
+                Y = Pos.Percent(95)
+            };
+            okButton.Clicked += () => CheckInput(levelEntry.Text);
+
+            Add(levelEntry, okButton, cancelButton);
+
+            levelEntry.SetFocus();
+
+            Application.Run(this);
+
+            if (_success)
+            {
+                input = levelEntry.Text;
+
+                return true;
+            }
+
+            input = default;
+
+            return false;
+        }
+
+        private void CheckInput(ustring input)
+        {
+            if (_validator?.Invoke(input) ?? true)
+            {
+                _success = true;
+
+                Application.RequestStop();
+            }
+            else
+            {
+                MessageBox.ErrorQuery(_title, _errorMessage, "Ok");
+            }
+        }
+    }
+}

WaveshareUARTFingerprintSensor.Sample/FingerprintDialog.cs

@@ -0,0 +1,53 @@
+using NStack;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Terminal.Gui;
+
+namespace WaveshareUARTFingerprintSensor.Sample
+{
+    public class FingerprintDialog : Dialog
+    {
+        public string ErrorTitle { get; set; }
+        public string ErrorMessage { get; set; }
+
+        public FingerprintDialog(string errorTitle, string errorMessage) : base(errorTitle, 60, 7)
+        {
+            ErrorTitle = errorTitle;
+            ErrorMessage = errorMessage;
+
+            ColorScheme = Colors.ColorSchemes["Menu"];
+        }
+
+        public void Show()
+        {
+            var label = new Label("Please place your finger flat on the sensor")
+            {
+                X = Pos.Center(),
+                Y = Pos.Center(),
+                Height = 1
+            };
+
+            Add(label);
+
+            Application.Run(this);
+        }
+
+        public void Cancel()
+        {
+            Application.MainLoop.Invoke(() => Application.RequestStop());
+        }
+
+        public void CancelAndShowError()
+        {
+            Application.MainLoop.Invoke(() =>
+            {
+                MessageBox.ErrorQuery(ErrorTitle, ErrorMessage, "Ok");
+
+                Application.RequestStop();
+            });
+        }
+    }
+}

WaveshareUARTFingerprintSensor.Sample/Program.cs

@@ -5,6 +5,7 @@ using System.Linq;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using Terminal.Gui;
 using Unosquare.RaspberryIO;
 using Unosquare.RaspberryIO.Abstractions;
 using Unosquare.WiringPi;
@@ -15,17 +16,7 @@ namespace WaveshareUARTFingerprintSensor.Sample
     {
         static void Main(string[] args)
         {
-            var sensor = new FingerprintSensor(FingerprintSensor.PrimarySerialPort);
+            Application.Run<TUIManager>();
-
-            sensor.Start();
-
-            Console.WriteLine("Adding fingerprint");
-
-            var response = sensor.AddFingerprint(40, UserPermission.Level3);
-
-            Console.WriteLine("End");
-
-            Thread.Sleep(-1);
         }
     }
 }

WaveshareUARTFingerprintSensor.Sample/README.md

@@ -0,0 +1,22 @@
+# Sample App
+
+A sample app for the [Waveshare UART fingerprint sensor (C) library](../README.md)
+
+![Sample](../Sample.png)
+
+## 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/SettingsDisplay.cs

@@ -0,0 +1,71 @@
+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
+{
+    public class SettingsDisplay : Toplevel
+    {
+        private string _port;
+        private RadioGroup _radioPort;
+
+        public SettingsDisplay()
+        {
+            Init();
+        }
+
+        private void Init()
+        {
+            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/SleepDisplay.cs

@@ -0,0 +1,106 @@
+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
+{
+    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()
+        {
+            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/TUIManager.cs

@@ -0,0 +1,416 @@
+using NStack;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Terminal.Gui;
+
+namespace WaveshareUARTFingerprintSensor.Sample
+{
+    public class TUIManager : Toplevel
+    {
+        public const string OutputFilePath = "out.txt";
+        public const string SettingsFilePath = "settings.txt";
+
+        private FingerprintSensor _fingerprintSensor;
+        private Label _serialPortLabel;
+        private Label _comparisonLevelLabel;
+        private Label _userCountLabel;
+
+        private object _outputFileLock = new object();
+
+        public TUIManager()
+        {
+            Init();
+        }
+
+        private void Init()
+        {
+            ColorScheme = Colors.Error;
+
+            // Creates the top-level window to show
+            var win = new Window("TUIManager")
+            {
+                X = 0,
+                Y = 1, // Leave one row for the toplevel menu
+
+                // By using Dim.Fill(), it will automatically resize without manual intervention
+                Width = Dim.Fill(),
+                Height = Dim.Fill()
+            };
+
+            win.ColorScheme = Colors.ColorSchemes["Dialog"];
+
+            Add(win);
+
+            // Creates a menubar, the item "New" has a help menu.
+            var menu = new MenuBar(new MenuBarItem[] {
+                new MenuBarItem ("_Options", new MenuItem [] {
+                    new MenuItem ("_Change Config", "", () => { ChangeConfig(); }),
+                    new MenuItem ("_Quit", "", () => { Application.RequestStop(); })
+                })
+            });
+
+            Add(menu);
+
+            // Window Content
+            _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),
+                Y = Pos.Bottom(_comparisonLevelLabel),
+                Width = Dim.Fill()
+            };
+
+            var userCountButton = new Button("Query _User Count")
+            {
+                X = Pos.Center(),
+                Y = 7
+            };
+            userCountButton.Clicked += UserCountButton_Clicked;
+
+            var readFingerprintButton = new Button("_Read Fingerprint")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(userCountButton) + 1
+            };
+            readFingerprintButton.Clicked += ReadFingerprintButton_Clicked;
+
+            var readEigenvaluesButton = new Button("Read _Eigenvalues")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(readFingerprintButton)
+            };
+            readEigenvaluesButton.Clicked += ReadEigenvaluesButton_Clicked;
+
+            var readImageButton = new Button("Read _Image")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(readEigenvaluesButton)
+            };
+            readImageButton.Clicked += ReadImageButton_Clicked;
+
+            var addFingerprintButton = new Button("_Add Fingerprint")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(readImageButton) + 1
+            };
+            addFingerprintButton.Clicked += AddFingerprintButton_Clicked;
+
+            var deleteAFingerprint = new Button("_Delete a Fingerprint")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(addFingerprintButton)
+            };
+            deleteAFingerprint.Clicked += DeleteAFingerprint_Clicked;
+
+            var clearFingerprintsButton = new Button("_Clear Fingerprints")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(deleteAFingerprint)
+            };
+            clearFingerprintsButton.Clicked += ClearFingerprintsButton_Clicked;
+
+            var setComparisonLevelButton = new Button("Set Comparison _Level")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(clearFingerprintsButton) + 1
+            };
+            setComparisonLevelButton.Clicked += SetComparisonLevelButton_Clicked;
+
+            var sleepButton = new Button("_Sleep Mode")
+            {
+                X = Pos.Center(),
+                Y = Pos.Bottom(setComparisonLevelButton) + 1
+            };
+            sleepButton.Clicked += SleepButton_Clicked;
+
+            var quitButton = new Button("_Quit")
+            {
+                X = Pos.Center(),
+                Y = Pos.Percent(95)
+            };
+            quitButton.Clicked += Quit_Clicked;
+
+            win.Add(
+                _serialPortLabel,
+                _comparisonLevelLabel,
+                _userCountLabel,
+                userCountButton,
+                readFingerprintButton,
+                readEigenvaluesButton,
+                readImageButton,
+                addFingerprintButton,
+                deleteAFingerprint,
+                clearFingerprintsButton,
+                setComparisonLevelButton,
+                sleepButton,
+                quitButton
+            );
+
+            // Init Sensor
+            if (!File.Exists(SettingsFilePath))
+            {
+                Application.Run(new SettingsDisplay());
+            }
+
+            InitSensor();
+
+            // Update gui
+            UpdateSerialPort();
+            UpdateUserCount();
+            UpdateComparisonLevel();
+        }
+
+        private void UpdateSerialPort()
+        {
+            _serialPortLabel.Text = $"Serial Port: {_fingerprintSensor.PortName}";
+        }
+
+        private void InitSensor()
+        {
+            _fingerprintSensor = new FingerprintSensor(File.ReadAllText(SettingsFilePath));
+
+            _fingerprintSensor.Start();
+        }
+
+        private void UpdateUserCount()
+        {
+            if (_fingerprintSensor.TryGetUserCount(out ushort count))
+            {
+                _userCountLabel.Text = $"Users: {count}";
+            }
+        }
+
+        private void UpdateComparisonLevel()
+        {
+            if (_fingerprintSensor.TryGetComparisonLevel(out byte comparisonLevel))
+            {
+                _comparisonLevelLabel.Text = $"Comparison Level: {comparisonLevel}";
+            }
+        }
+
+        private void ReadImageButton_Clicked()
+        {
+            var dialog = new FingerprintDialog("Acquire Image", "Can't acquire image, try to place your finger flat on the sensor");
+            byte[] image = null;
+
+            Task.Run(() =>
+            {
+                if (_fingerprintSensor.TryAcquireImage(out image))
+                {
+                    dialog.Cancel();
+                }
+                else
+                {
+                    dialog.CancelAndShowError();
+                }
+            });
+
+            dialog.Show();
+
+            if (image != null)
+            {
+                WriteOut($"Image:\n{Utils.ArrayDisplay(image)}\n\n\n");
+
+                var window = new DataDisplay("Image", image.ToArray());
+
+                Application.Run(window);
+            }
+        }
+
+        private void ReadEigenvaluesButton_Clicked()
+        {
+            var dialog = new FingerprintDialog("Acquire Eigenvalues", "Can't acquire eigenvalues, try to place your finger flat on the sensor");
+            byte[] eigenvalues = null;
+
+            Task.Run(() =>
+            {
+                if (_fingerprintSensor.TryAcquireEigenvalues(out var values))
+                {
+                    eigenvalues = values.ToArray();
+
+                    dialog.Cancel();
+                }
+                else
+                {
+                    dialog.CancelAndShowError();
+                }
+            });
+
+            dialog.Show();
+
+            if (eigenvalues != null)
+            {
+                var window = new DataDisplay("Eigenvalues", eigenvalues);
+
+                 WriteOut($"Eigenvalues:\n{Utils.ArrayDisplay(eigenvalues)}\n\n\n");
+
+                Application.Run(window);
+            }
+        }
+
+        private void SetComparisonLevelButton_Clicked()
+        {
+            if (new EntryDialog("Comparison Level", i => int.TryParse(i.ToString(), out var n) && n > 0 && n < 10, "Need to be a valid number in 0-9 range").TryShow(out var input))
+            {
+                if (!_fingerprintSensor.TrySetComparisonLevel(byte.Parse(input.ToString())))
+                {
+                    MessageBox.ErrorQuery("Comparison Level", "Can't set comparison level", "Ok");
+                }
+            }
+
+            UpdateComparisonLevel();
+        }
+
+        private void DeleteAFingerprint_Clicked()
+        {
+            if (new EntryDialog("User id", i => int.TryParse(i.ToString(), out var n), "Need to be a valid user id").TryShow(out var input))
+            {
+                if (!_fingerprintSensor.DeleteUser(ushort.Parse(input.ToString())))
+                {
+                    MessageBox.ErrorQuery("Delete User", "Can't delete user, check user id", "Ok");
+                }
+            }
+
+            UpdateUserCount();
+        }
+
+        private void SleepButton_Clicked()
+        {
+            var window = new SleepDisplay(_fingerprintSensor);
+
+            Application.Run(window);
+        }
+
+        private void ClearFingerprintsButton_Clicked()
+        {
+            if (!_fingerprintSensor.DeleteAllUsers())
+            {
+                MessageBox.ErrorQuery("Delete All Users", "Can't delete all user", "Ok");
+            }
+        }
+
+        private void AddFingerprintButton_Clicked()
+        {
+            if (new EntryDialog("User id", i => ushort.TryParse(i.ToString(), out var n), "Need to be a valid user id").TryShow(out var input))
+            {
+                var dialog = new FingerprintDialog("Add Fingerprint", "Can't add fingerprint, try to place your finger flat on the sensor");
+
+                Task.Run(() =>
+                {
+                    switch (_fingerprintSensor.AddFingerprint(ushort.Parse(input.ToString()), UserPermission.Level1))
+                    {
+                        case ResponseType.Success:
+                            dialog.Cancel();
+
+                            Application.MainLoop.Invoke(() => MessageBox.Query("Add Fingerprint", "Successfully added fingerprint", "Ok"));
+
+                            break;
+                        case ResponseType.Full:
+                            dialog.ErrorMessage = "Sensor full, can't add more users";
+
+                            dialog.CancelAndShowError();
+
+                            break;
+                        case ResponseType.NoUser:
+                            dialog.ErrorMessage = "Can't add fingerprint, invalid id";
+
+                            dialog.CancelAndShowError();
+
+                            break;
+                        case ResponseType.FingerOccupied:
+                            dialog.ErrorMessage = "Can't add fingerprint, finger already registered";
+
+                            dialog.CancelAndShowError();
+
+                            break;
+                        case ResponseType.UserOccupied:
+                            dialog.ErrorMessage = "Can't add fingerprint, id already used";
+
+                            dialog.CancelAndShowError();
+
+                            break;
+                        default:
+                            dialog.CancelAndShowError();
+                            break;
+                    }
+                });
+
+                dialog.Show();
+
+                UpdateUserCount();
+            }
+        }
+
+        private void ReadFingerprintButton_Clicked()
+        {
+            var dialog = new FingerprintDialog("Read Fingerprint", "Can't read fingerprint, try to place your finger flat on the sensor");
+
+            (ushort userID, UserPermission permission) userInfo = default;
+
+            Task.Run(() =>
+            {
+                if (_fingerprintSensor.TryComparison1N(out userInfo))
+                {
+                    dialog.Cancel();
+                }
+                else
+                {
+                    dialog.CancelAndShowError();
+                }
+            });
+
+            dialog.Show();
+
+            if (userInfo != default)
+            {
+                MessageBox.Query("Read Fingerprint", $"Successfully read fingerprint\n\nUser ID: {userInfo.userID}\nPermissions: {userInfo.permission}\n ", "Ok");
+            }
+        }
+
+        private void UserCountButton_Clicked()
+        {
+            UpdateUserCount();
+        }
+        private void WriteOut(string text)
+        {
+            Task.Run(() =>
+            {
+                lock (_outputFileLock)
+                {
+                    File.AppendAllText(OutputFilePath, text);
+                }
+            });
+        }
+
+        private void ChangeConfig()
+        {
+            File.Delete(SettingsFilePath);
+
+            Application.Run(new SettingsDisplay());
+
+            InitSensor();
+
+            UpdateSerialPort();
+        }
+
+        private void Quit_Clicked()
+        {
+            Application.RequestStop();
+        }
+    }
+}

WaveshareUARTFingerprintSensor.Sample/WaveshareUARTFingerprintSensor.Sample.csproj

@@ -27,6 +27,8 @@
     <IsWebBootstrapper>false</IsWebBootstrapper>
     <UseApplicationTrust>false</UseApplicationTrust>
     <BootstrapperEnabled>true</BootstrapperEnabled>
+    <NuGetPackageImportStamp>
+    </NuGetPackageImportStamp>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>
@@ -48,6 +50,9 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="NStack, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\packages\NStack.Core.0.14.0\lib\netstandard2.0\NStack.dll</HintPath>
+    </Reference>
     <Reference Include="Swan, Version=3.0.0.0, Culture=neutral, processorArchitecture=MSIL">
       <HintPath>..\packages\Unosquare.Swan.3.0.0\lib\net461\Swan.dll</HintPath>
     </Reference>
@@ -80,6 +85,9 @@
     <Reference Include="System.Data" />
     <Reference Include="System.Net.Http" />
     <Reference Include="System.Xml" />
+    <Reference Include="Terminal.Gui, Version=0.90.3.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\packages\Terminal.Gui.0.90.3\lib\net472\Terminal.Gui.dll</HintPath>
+    </Reference>
     <Reference Include="Unosquare.Raspberry.Abstractions, Version=0.4.1.0, Culture=neutral, processorArchitecture=MSIL">
       <HintPath>..\packages\Unosquare.Raspberry.Abstractions.0.4.1\lib\netstandard2.0\Unosquare.Raspberry.Abstractions.dll</HintPath>
     </Reference>
@@ -91,8 +99,14 @@
     </Reference>
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="DataDisplay.cs" />
+    <Compile Include="EntryDialog.cs" />
+    <Compile Include="FingerprintDialog.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="SettingsDisplay.cs" />
+    <Compile Include="SleepDisplay.cs" />
+    <Compile Include="TUIManager.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />
@@ -117,4 +131,11 @@
     </ProjectReference>
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="..\packages\Microsoft.NETFramework.ReferenceAssemblies.net472.1.0.0\build\Microsoft.NETFramework.ReferenceAssemblies.net472.targets" Condition="Exists('..\packages\Microsoft.NETFramework.ReferenceAssemblies.net472.1.0.0\build\Microsoft.NETFramework.ReferenceAssemblies.net472.targets')" />
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>Ce projet fait référence à des packages NuGet qui sont manquants sur cet ordinateur. Utilisez l'option de restauration des packages NuGet pour les télécharger. Pour plus d'informations, consultez http://go.microsoft.com/fwlink/?LinkID=322105. Le fichier manquant est : {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\packages\Microsoft.NETFramework.ReferenceAssemblies.net472.1.0.0\build\Microsoft.NETFramework.ReferenceAssemblies.net472.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Microsoft.NETFramework.ReferenceAssemblies.net472.1.0.0\build\Microsoft.NETFramework.ReferenceAssemblies.net472.targets'))" />
+  </Target>
 </Project>

WaveshareUARTFingerprintSensor.Sample/packages.config

@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
+  <package id="Microsoft.NETFramework.ReferenceAssemblies" version="1.0.0" targetFramework="net472" developmentDependency="true" />
+  <package id="Microsoft.NETFramework.ReferenceAssemblies.net472" version="1.0.0" targetFramework="net472" developmentDependency="true" />
+  <package id="NStack.Core" version="0.14.0" targetFramework="net472" />
   <package id="System.Buffers" version="4.5.1" targetFramework="net472" />
   <package id="System.Memory" version="4.5.4" targetFramework="net472" />
   <package id="System.Numerics.Vectors" version="4.5.0" targetFramework="net472" />
   <package id="System.Runtime.CompilerServices.Unsafe" version="4.5.3" targetFramework="net472" />
   <package id="System.ValueTuple" version="4.5.0" targetFramework="net472" />
+  <package id="Terminal.Gui" version="0.90.3" targetFramework="net472" />
   <package id="Unosquare.Raspberry.Abstractions" version="0.4.1" targetFramework="net472" />
   <package id="Unosquare.Raspberry.IO" version="0.27.1" targetFramework="net472" />
   <package id="Unosquare.Swan" version="3.0.0" targetFramework="net472" />

WaveshareUARTFingerprintSensor/FingerprintSensor.cs

@@ -110,7 +110,13 @@ namespace WaveshareUARTFingerprintSensor
                 _serialPort.Write(buffer, 0, buffer.Length);
 
                 // Response
-                _serialPort.Read(buffer, 0, buffer.Length);
+                int length = buffer.Length;
+                int offset = 0;
+                do
+                {
+                    int toRead = length - offset;
+                    offset += _serialPort.Read(buffer, offset, toRead);
+                } while (offset < length);
 
                 if (buffer[0] != PacketSeparator || buffer[7] != PacketSeparator || buffer[1] != (byte)commandType)
                 {
@@ -347,7 +353,7 @@ namespace WaveshareUARTFingerprintSensor
         {
             (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;
             }
@@ -362,7 +368,7 @@ namespace WaveshareUARTFingerprintSensor
         /// <returns></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)
                 {
@@ -505,6 +511,10 @@ namespace WaveshareUARTFingerprintSensor
         {
             _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()

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: AssemblyTitle("Waveshare UART Fingerprint Sensor (C)")]
-[assembly: AssemblyDescription("")]
+[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/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>