# multiserialviewer
Shows multiple serial text streams in a single window with individual highlighting options
<img src="https://github.com/shaag7967/multiserialviewer/blob/main/doc/img/multiserialviewer.png?raw=true" width="70%" alt="example with two serial connections">
## Motivation for using this tool
Imagine you have several embedded devices / MCUs all printing out debug information over a UART. You don't want to use a terminal program (e.g. HTerm) for every COM port manually. You want to easily open all COM ports at once and clear all received data with a single click. Would be nice, if important text messages could be highlighted with different colors, so you don't have to read everything your devices are telling you.
## Installation
You can install this tool using the package installer for Python (pip). See [multiserialviewer](https://pypi.org/project/multiserialviewer/).
pip install multiserialviewer
## Usage
After installation using pip, you can start it by running
multiserialviewer
in a console (or by directly clicking '\Scripts\multiserialviewer.exe' in your python install directory).
### Setting up your serial/COM port connections
Click in the top left corner on "Create SerialViewer" and enter your connection details. After you created all SerialViewers you need, start receiving your text data by clicking on "Start".
<img src="https://github.com/shaag7967/multiserialviewer/blob/main/doc/img/create_serial_viewer.png?raw=true" width="70%" alt="create serial viewer connection">
If one of your serial ports can not be opened, you will see an error message in the corresponding SerialView window. In this case all other connections/SerialViewer will be closed again.
### Specifying text patterns for highlighting
If you want to highlight specific text, you can define text patterns using regular expression syntax. If you just want to highlight certain words, just enter them as normal text under "Text Highlighter Settings".
<img src="https://github.com/shaag7967/multiserialviewer/blob/main/doc/img/highlighter_settings.png?raw=true" width="60%" alt="highlighter settings">
## More information
### Configuration folder
When closing this tool, your settings (connections, window sizes/positions and highlighter) are stored in ini/text files. You will find them in your users config folder. On windows this could be e.g. `C:\Users\youruser\AppData\Local\MultiSerialViewer`.
Raw data
{
"_id": null,
"home_page": "https://github.com/shaag7967/multiserialviewer",
"name": "multiserialviewer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "serial, debug output, UART, MCU",
"author": "shaag",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/24/fb/fc2831410f71c8e163c16ef9fa99656e325e7fbaa8d1ae91f05cc9e1fdb8/multiserialviewer-24.12.1.tar.gz",
"platform": null,
"description": "\n# multiserialviewer\nShows multiple serial text streams in a single window with individual highlighting options\n\n<img src=\"https://github.com/shaag7967/multiserialviewer/blob/main/doc/img/multiserialviewer.png?raw=true\" width=\"70%\" alt=\"example with two serial connections\">\n\n\n## Motivation for using this tool\nImagine you have several embedded devices / MCUs all printing out debug information over a UART. You don't want to use a terminal program (e.g. HTerm) for every COM port manually. You want to easily open all COM ports at once and clear all received data with a single click. Would be nice, if important text messages could be highlighted with different colors, so you don't have to read everything your devices are telling you.\n\n## Installation\nYou can install this tool using the package installer for Python (pip). See [multiserialviewer](https://pypi.org/project/multiserialviewer/).\n\n pip install multiserialviewer\n\n## Usage\nAfter installation using pip, you can start it by running \n\n multiserialviewer\nin a console (or by directly clicking '\\Scripts\\multiserialviewer.exe' in your python install directory).\n\n### Setting up your serial/COM port connections\nClick in the top left corner on \"Create SerialViewer\" and enter your connection details. After you created all SerialViewers you need, start receiving your text data by clicking on \"Start\".\n\n<img src=\"https://github.com/shaag7967/multiserialviewer/blob/main/doc/img/create_serial_viewer.png?raw=true\" width=\"70%\" alt=\"create serial viewer connection\">\n\nIf one of your serial ports can not be opened, you will see an error message in the corresponding SerialView window. In this case all other connections/SerialViewer will be closed again.\n\n### Specifying text patterns for highlighting\nIf you want to highlight specific text, you can define text patterns using regular expression syntax. If you just want to highlight certain words, just enter them as normal text under \"Text Highlighter Settings\".\n\n<img src=\"https://github.com/shaag7967/multiserialviewer/blob/main/doc/img/highlighter_settings.png?raw=true\" width=\"60%\" alt=\"highlighter settings\">\n\n## More information\n### Configuration folder\nWhen closing this tool, your settings (connections, window sizes/positions and highlighter) are stored in ini/text files. You will find them in your users config folder. On windows this could be e.g. `C:\\Users\\youruser\\AppData\\Local\\MultiSerialViewer`.\n",
"bugtrack_url": null,
"license": null,
"summary": "Shows multiple serial text streams in a single window with individual highlighting options.",
"version": "24.12.1",
"project_urls": {
"GitHub": "https://github.com/shaag7967/multiserialviewer",
"Homepage": "https://github.com/shaag7967/multiserialviewer"
},
"split_keywords": [
"serial",
" debug output",
" uart",
" mcu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7cf8e826fc952dec6111bb4ce2419f01c6d741ff6258923f8bb443adf3391d41",
"md5": "54fe65f38a031a43e70d057892673c01",
"sha256": "b13706754370547ee53eede908755ecdb99b05d3a9e27db4fe2319a3ec0c9287"
},
"downloads": -1,
"filename": "multiserialviewer-24.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54fe65f38a031a43e70d057892673c01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 33863,
"upload_time": "2024-12-15T19:37:37",
"upload_time_iso_8601": "2024-12-15T19:37:37.410279Z",
"url": "https://files.pythonhosted.org/packages/7c/f8/e826fc952dec6111bb4ce2419f01c6d741ff6258923f8bb443adf3391d41/multiserialviewer-24.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24fbfc2831410f71c8e163c16ef9fa99656e325e7fbaa8d1ae91f05cc9e1fdb8",
"md5": "4410d367a8d6e4b0876a51b36f30a328",
"sha256": "ade6fc88e50dbef978d7b56eebcef64913377dd51415685dd876cdaceaaa8773"
},
"downloads": -1,
"filename": "multiserialviewer-24.12.1.tar.gz",
"has_sig": false,
"md5_digest": "4410d367a8d6e4b0876a51b36f30a328",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 27229,
"upload_time": "2024-12-15T19:37:39",
"upload_time_iso_8601": "2024-12-15T19:37:39.834105Z",
"url": "https://files.pythonhosted.org/packages/24/fb/fc2831410f71c8e163c16ef9fa99656e325e7fbaa8d1ae91f05cc9e1fdb8/multiserialviewer-24.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 19:37:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shaag7967",
"github_project": "multiserialviewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyserial",
"specs": [
[
"==",
"3.5"
]
]
},
{
"name": "pyside6",
"specs": [
[
"==",
"6.8.1"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.3.6"
]
]
}
],
"lcname": "multiserialviewer"
}
JSON
