diff --git a/MultiTerm.Core/Model/MultiFormatString.cs b/MultiTerm.Core/Model/MultiFormatString.cs index 0337b77..b2dffb8 100644 --- a/MultiTerm.Core/Model/MultiFormatString.cs +++ b/MultiTerm.Core/Model/MultiFormatString.cs @@ -3,10 +3,21 @@ using System.Text; namespace MultiTerm.Core.Model; +/// +/// A string that contains symbols of multiple formats such as a standard character as well as hexadecimal or binary parts. +/// public class MultiFormatString { + /// + /// List of Symbols that are stored in this + /// public List> FormatValuePairs { get; private set; } = new(); + /// + /// Adds a single character to . + /// + /// format of the + /// value of the symbol, must be convertible to an Unicode character public void Add(FormatType format, string value) { // check if value is valid, if yes add to FormatValuePairs @@ -16,6 +27,11 @@ public class MultiFormatString } } + /// + /// Removes a given amount of characters from the end of . + /// + /// amount of characters to remove from the list, starting at the last item + /// if amount <= 0 public void Remove(int amount) { // guard amount <= 0 @@ -32,12 +48,16 @@ public class MultiFormatString this.FormatValuePairs.RemoveRange( (listCount - amount) , amount); } - // TODO Setup Unit Tests - public override string ToString() + /// + /// Converts the to a string that only contains Unicode (UTF-16) characters. + /// + /// converted string + public override string ToString() // TODO Implement Unit Tests! { StringBuilder stringBuilder = new(); string hexConversionCharacters = String.Empty, binaryConversionCharacters = String.Empty; + // Internal function to check and finalize a Hexadecimal Conversion // parameter == null will force ending void finalizeHexConversion(Tuple? formatValuePair) { @@ -57,6 +77,7 @@ public class MultiFormatString } } + // Internal function to check and finalize a Binary Conversion // parameter == null will force ending void finalizeBinaryConversion(Tuple? formatValuePair) { @@ -76,8 +97,10 @@ public class MultiFormatString } } + // go through every character foreach (var formatValuePair in this.FormatValuePairs) { + // finalize ongoing conversions if there are any finalizeHexConversion(formatValuePair); finalizeBinaryConversion(formatValuePair); @@ -100,13 +123,17 @@ public class MultiFormatString } } + // fully finalize after the loop, finish all unfinished conversions finalizeHexConversion(null); finalizeBinaryConversion(null); return stringBuilder.ToString(); } - + /// + /// Validates wether a certain is valid for the given . + /// + /// true if valid public static bool ValidateValue(FormatType format, string value) { // invalid if more than one character @@ -143,7 +170,7 @@ public class MultiFormatString // from: https://stackoverflow.com/questions/724862/converting-from-hex-to-string // test with: returns: "Hello world" for "48656C6C6F20776F726C64" // see https://www.fileformat.info/info/charset/UTF-16/list.htm - public static string FromHexString(string hexString) + private static string FromHexString(string hexString) { // Added PadLeft so strings with one character do not get ignored string internalHexString = hexString.PadLeft(4, '0'); @@ -156,7 +183,7 @@ public class MultiFormatString return Encoding.BigEndianUnicode.GetString(bytes); } - public static string FromBinaryString(string binaryString) + private static string FromBinaryString(string binaryString) { string internalBinaryString = binaryString.PadLeft(16, '0'); var bytes = new byte[internalBinaryString.Length / 8]; diff --git a/MultiTerm.Core/ViewModel/CommunicationDataViewModel.cs b/MultiTerm.Core/ViewModel/CommunicationDataViewModel.cs new file mode 100644 index 0000000..07e2bba --- /dev/null +++ b/MultiTerm.Core/ViewModel/CommunicationDataViewModel.cs @@ -0,0 +1,98 @@ +using CommunityToolkit.Mvvm.ComponentModel; +using CommunityToolkit.Mvvm.Input; +using MultiTerm.Protocols; +using MultiTerm.Protocols.Model; +using System.Collections.ObjectModel; + +namespace MultiTerm.Core.ViewModel; + +public partial class CommunicationDataViewModel : ObservableObject +{ + private ICommunicationProtocol? communicationProtocol; + + /// + /// Represents the collection of received characters from a communicaiton protocol. + /// + [ObservableProperty] + private ObservableCollection receivedData = new(); + + /// + /// Represents the collection of received characters from a communicaiton protocol. + /// + [ObservableProperty] + private ObservableCollection receivedCharacters = new(); //TODO + + /// + /// Represents the collection of sent characters to a communicaiton protocol. + /// + [ObservableProperty] + private ObservableCollection sentCharacters = new(); // TODO Change + + public CommunicationDataViewModel(ICommunicationProtocol? communicationProtocol) + { + this.communicationProtocol = communicationProtocol; + if (this.communicationProtocol != null) + { + this.communicationProtocol.ReceivedDataEvent += CommunicationProtocol_ReceivedDataEvent; + this.communicationProtocol.SentDataEvent += CommunicationProtocol_SentDataEvent; + } + else // TEMP + { + string lorem = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pellentesque elit eget gravida cum sociis natoque penatibus et magnis. Purus sit amet volutpat consequat mauris nunc congue nisi vitae. Id ornare arcu odio ut sem. Neque ornare aenean euismod elementum nisi quis eleifend. Faucibus vitae aliquet nec ullamcorper sit. Fermentum iaculis eu non diam phasellus vestibulum lorem sed risus. Pellentesque nec nam aliquam sem et tortor consequat id porta. Diam sollicitudin tempor id eu nisl. Fames ac turpis egestas sed tempus urna et. Commodo odio aenean sed adipiscing diam donec adipiscing tristique risus. Id aliquet lectus proin nibh nisl condimentum id. Dolor sit amet consectetur adipiscing elit duis. Sed vulputate odio ut enim blandit. Neque convallis a cras semper auctor neque vitae.\r\n\r\nLacus laoreet non curabitur gravida arcu ac tortor. Volutpat maecenas volutpat blandit aliquam. Neque laoreet suspendisse interdum consectetur. Tincidunt augue interdum velit euismod in pellentesque massa placerat. Magna fringilla urna porttitor rhoncus dolor purus non enim praesent. Fermentum leo vel orci porta non pulvinar neque laoreet suspendisse. Scelerisque viverra mauris in aliquam sem fringilla. Nec feugiat nisl pretium fusce id velit ut. Urna cursus eget nunc scelerisque viverra mauris. Condimentum mattis pellentesque id nibh tortor id aliquet. Enim sed faucibus turpis in eu. Adipiscing elit pellentesque habitant morbi tristique. A pellentesque sit amet porttitor eget dolor morbi non arcu. Amet commodo nulla facilisi nullam vehicula ipsum a arcu. Hac habitasse platea dictumst vestibulum rhoncus est pellentesque elit ullamcorper. Curabitur vitae nunc sed velit dignissim sodales ut. Malesuada fames ac turpis egestas maecenas pharetra. Tellus pellentesque eu tincidunt tortor aliquam.\r\n\r\nVitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Eget mi proin sed libero enim sed faucibus. Commodo nulla facilisi nullam vehicula ipsum. Proin libero nunc consequat interdum varius sit amet mattis vulputate. Morbi tristique senectus et netus. Feugiat scelerisque varius morbi enim nunc. Nulla aliquet enim tortor at auctor urna nunc. Non pulvinar neque laoreet suspendisse interdum consectetur libero id. Tellus orci ac auctor augue mauris augue neque gravida in. In egestas erat imperdiet sed euismod. Amet volutpat consequat mauris nunc congue nisi. Massa eget egestas purus viverra accumsan in. Eget duis at tellus at. Mi sit amet mauris commodo quis imperdiet. Nibh mauris cursus mattis molestie a iaculis at.\r\n\r\nNetus et malesuada fames ac turpis. Sit amet dictum sit amet justo donec. Euismod quis viverra nibh cras pulvinar mattis. Sit amet commodo nulla facilisi nullam vehicula ipsum a arcu. Scelerisque felis imperdiet proin fermentum. Ac tincidunt vitae semper quis lectus nulla at. Sit amet commodo nulla facilisi nullam vehicula. Enim lobortis scelerisque fermentum dui faucibus in ornare quam. Quam id leo in vitae turpis massa sed. Quam quisque id diam vel quam. A condimentum vitae sapien pellentesque. Neque aliquam vestibulum morbi blandit cursus risus at. Velit laoreet id donec ultrices tincidunt arcu non sodales neque. Tempus imperdiet nulla malesuada pellentesque elit eget gravida cum sociis. Egestas tellus rutrum tellus pellentesque eu tincidunt tortor. Nec feugiat in fermentum posuere. Dui accumsan sit amet nulla. Lacus viverra vitae congue eu consequat ac felis. Etiam tempor orci eu lobortis. Fermentum leo vel orci porta non pulvinar."; + string mcu = "<\\r><\\n>\r\n--------------------------------------------------------------<\\r><\\n>\r\nSPLITFLAP<\\r><\\n>\r\n--------------------------------------------------------------<\\r><\\n>\r\nMcuShell ; Group of McuShell commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\nSplitFlap ; Group of McuRTOS commands<\\r><\\n>\r\n help ; Print help or status information<\\r><\\n>\r\n setId ; sets the position (setupId) of the sf and its id (hwId)<\\r><\\n>\r\n initAll ; init all Splitflaps<\\r><\\n>\r\n Display ; displays as many chars of the string as sf are available<\\r><\\n>\r\n addId ; add new hwId with offset<\\r><\\n>\r\nMcuRTOS ; Group of McuRTOS commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n tasklist ; Print tasklist<\\r><\\n>\r\nMcuFlash ; Group of flash ini commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n dump ; Dump memory data<\\r><\\n>\r\n erase ; Erase memory at address<\\r><\\n>\r\nini ; Group of flash ini commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n dump ; Dump data information<\\r><\\n>\r\n erase ; Erase data information<\\r><\\n>\r\nMcuMinINI ; Group of McuMinINI commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n read ; Read a key from a section in a file<\\r><\\n>\r\n write ; Write a key with value to a section in a file<\\r><\\n>\r\n delkey ; Delete a key in a section of file<\\r><\\n>\r\n delsec ; Delete a section in a file<\\r><\\n>\r\nnvmc ; Group of NVMC commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n flags ; Set flags<\\r><\\n>\r\nrs ; Group of RS-485 commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n addr ; Set RS-485 address<\\r><\\n>\r\n send ; Send a text to the RS-485 bus<\\r><\\n>\r\n sendcmd ; Send a shell command to the RS-485 address and check response<\\r><\\n>\r\n log on|off ; Log RS-485 bus activity to McuLog<\\r><\\n>\r\nMcuUart485 ; Group of RS-485 commands<\\r><\\n>\r\n help|status ; Print help or status information<\\r><\\n>\r\n clear ; Clear UART ISR flags<\\r><\\n>\r\n<\\r><\\n>\r\nCMD>"; + string exampleData = "This is some example Text\nSecond line\nNow a very long line: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."; + int counter = 0; + List listOfChars = new(); + foreach (var character in exampleData) + { + if(++counter > 100 || character == '\n') + { + this.ReceivedData.Add(new DataLine(listOfChars)); + listOfChars = new List(); + counter = 0; + } + var extdChar = new ExtendedChar(character); + listOfChars.Add(extdChar); + this.ReceivedCharacters.Add(extdChar); + } + } + } + + ~CommunicationDataViewModel() + { + if (this.communicationProtocol != null) + { + this.communicationProtocol.ReceivedDataEvent -= CommunicationProtocol_ReceivedDataEvent; + this.communicationProtocol.SentDataEvent -= CommunicationProtocol_SentDataEvent; + this.communicationProtocol = null; + } + } + + private void CommunicationProtocol_ReceivedDataEvent(object? sender, ReceivedDataEventArgs e) + { + foreach (var receivedChar in e.ReceivedCharacters) + { + //this.ReceivedData.Add(receivedChar); // TODO Fix + } + } + + private void CommunicationProtocol_SentDataEvent(object? sender, SentDataEventArgs e) + { + foreach (var sentChar in e.SentCharacters) + { + this.SentCharacters.Add(sentChar); + } + } + + [RelayCommand] + private void ClearReceivedCharacters() + { + this.ReceivedData = new ObservableCollection(); + } + + [RelayCommand] + private void ClearSentCharacters() + { + this.SentCharacters = new ObservableCollection(); + } +} diff --git a/MultiTerm.Core/ViewModel/TerminalViewModel.cs b/MultiTerm.Core/ViewModel/TerminalViewModel.cs index 73272d0..71f7bc5 100644 --- a/MultiTerm.Core/ViewModel/TerminalViewModel.cs +++ b/MultiTerm.Core/ViewModel/TerminalViewModel.cs @@ -11,12 +11,25 @@ public abstract partial class TerminalViewModel : ObservableObject, ITerminalVie public abstract string Title { get; } public abstract TerminalViewType ViewType { get; } public ProtocolType ProtocolType { get; set; } - public ICommunicationProtocol? CommunicationProtocol { get; set; } - + public event EventHandler? ClosingEvent; - private IProtocolSettingsViewModel? protocolSettings; + [ObservableProperty] + private CommunicationDataViewModel communicationData = new(null); + private ICommunicationProtocol? communicationProtocol; + public ICommunicationProtocol? CommunicationProtocol + { + get { return communicationProtocol; } + set + { + communicationProtocol = value; + // register communication protocol in the Communication Data View Model + //this.CommunicationData = new CommunicationDataViewModel(communicationProtocol); // TEMP + } + } + + private IProtocolSettingsViewModel? protocolSettings; public IProtocolSettingsViewModel? ProtocolSettings { get { return protocolSettings; } diff --git a/MultiTerm.Protocols/Model/DataLine.cs b/MultiTerm.Protocols/Model/DataLine.cs new file mode 100644 index 0000000..c9213a5 --- /dev/null +++ b/MultiTerm.Protocols/Model/DataLine.cs @@ -0,0 +1,28 @@ +using CommunityToolkit.Mvvm.ComponentModel; +using System.Collections.ObjectModel; + +namespace MultiTerm.Protocols.Model; + +/// +/// One line of data(characters). +/// +public partial class DataLine : ObservableObject +{ + /// + /// Represents the collection of characters from a communication protocol. + /// + [ObservableProperty] + private ObservableCollection characters = new(); + + /// + /// Constructor of . + /// + /// characters collection + public DataLine(IEnumerable characters) + { + foreach (var character in characters) + { + this.Characters.Add(character); + } + } +} diff --git a/MultiTerm.Protocols/Model/ExtendedChar.cs b/MultiTerm.Protocols/Model/ExtendedChar.cs index 898eaec..0b158f7 100644 --- a/MultiTerm.Protocols/Model/ExtendedChar.cs +++ b/MultiTerm.Protocols/Model/ExtendedChar.cs @@ -1,4 +1,5 @@ -using System.Text; +using CommunityToolkit.Mvvm.ComponentModel; +using System.Text; namespace MultiTerm.Protocols.Model; @@ -7,13 +8,31 @@ namespace MultiTerm.Protocols.Model; /// A time can be stored in combination with this Character using the property. E.g. to represent arrived or sent time. /// Several methods to display the Character in other formats than Unicode are provided. /// -public class ExtendedChar +public partial class ExtendedChar : ObservableObject { /// /// Data in the form of a character. UTF-16 code unit. /// public char Character { get; set; } + /// + /// Property that hosts a displayable string of the character (UTF-16 encoded). + /// + [ObservableProperty] + private string displayStringUtf16 = String.Empty; + + /// + /// Property that hosts a string of the character (hexadecimal format). + /// + [ObservableProperty] + private string displayStringHex = String.Empty; + + /// + /// Property that hosts a string of the character (binary format). + /// + [ObservableProperty] + private string displayStringBin = String.Empty; + /// /// Time that is associated with the . /// E.g. to represent arrived or sent time. @@ -25,15 +44,11 @@ public class ExtendedChar /// Sets to now. /// /// data - public ExtendedChar(char character) - { - // initialize time with now - this.Time = TimeOnly.FromDateTime(DateTime.Now); - this.Character = character; - } + public ExtendedChar(char character) : this(character, TimeOnly.FromDateTime(DateTime.Now)) { } /// /// Creates an instance of ExtendedChar with a given and . + /// Initializes string properties , and . /// /// data /// time @@ -41,6 +56,9 @@ public class ExtendedChar { this.Character = character; this.Time = time; + this.DisplayStringUtf16 = this.ToUtf16String(); + this.DisplayStringHex = this.ToHexString(); + this.DisplayStringBin = this.ToBinaryString(); } public override string ToString() diff --git a/MultiTerm.Protocols/Serial/SerialProtocolSettingsViewModel.cs b/MultiTerm.Protocols/Serial/SerialProtocolSettingsViewModel.cs index b7d8264..138ae4e 100644 --- a/MultiTerm.Protocols/Serial/SerialProtocolSettingsViewModel.cs +++ b/MultiTerm.Protocols/Serial/SerialProtocolSettingsViewModel.cs @@ -29,7 +29,7 @@ public partial class SerialProtocolSettingsViewModel : ProtocolSettingsViewModel private Handshake handshake = Handshake.None; [ObservableProperty] - private IEnumerable comPorts = new string[] { }; + private IEnumerable comPorts = Array.Empty(); [RelayCommand] private void ReloadComPorts() diff --git a/MultiTerm.Wpf/View/SendReceiveView.xaml b/MultiTerm.Wpf/View/SendReceiveView.xaml index 8a9c6bc..7e109a5 100644 --- a/MultiTerm.Wpf/View/SendReceiveView.xaml +++ b/MultiTerm.Wpf/View/SendReceiveView.xaml @@ -31,6 +31,7 @@ +