{ "info": { "author": "Ralf Stemmer", "author_email": "ralf.stemmer@gmx.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: End Users/Desktop", "Intended Audience :: Science/Research", "Intended Audience :: System Administrators", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Communications", "Topic :: Scientific/Engineering", "Topic :: Software Development :: Debuggers", "Topic :: Software Development :: Embedded Systems", "Topic :: System :: Logging", "Topic :: System :: Monitoring", "Topic :: Terminals", "Topic :: Terminals :: Serial", "Topic :: Utilities" ], "description": "\n# sterm\n\nsterm is a minimal serial terminal that focus on being easy to use and not sucking. - This client simply works.\nIt has inline input and supports Unicode (utf-8).\nEach character typed gets directly send to the connected device without buffering.\nIt writes whatever it receives to *stdout* so that also ANSI escape sequences work as expected.\n\n*Ideal for debugging:*\nWith the ``--binary`` option, the received data will be output byte wise as hexadecimal numbers.\n\n*Ideal for a remote Linux shell:*\nWith the ``--noecho`` option, each character typed gets directly send to the connected device without buffering and echoing.\nThis makes the Linux console usage seamlessly like using telnet or ssh.\n\n**Project State:** Alive and maintained\n\n## Installation\n\nThere are two ways to install _sterm_.\nDirectly using `pip` or from the cloned repository.\n\n### Using pip\n\n```bash\npip install sterm\n```\n\n### From Repository\n\n```bash\n# Download\ngit clone https://github.com/rstemmer/sterm.git\ncd sterm\n\n# Dependencies\npip install pyserial\n\n# Install Package\npip install .\n\n```\n\n## Usage\n\n### Command Line Arguments\n\n```bash\nsterm [-h] [--noecho] [--escape character] [--binary] [-b BAUDRATE] [-f FORMAT] [-w logfile] DEVICE\n```\n\n * __-h__: Print help.\n * __-n__: Enable _noecho_ mode. _Default_ is echoing each entered key to _stdout_.\n * __--escape__: Define an alternative escape character. _Default_ is escape (\"\\e\").\n * __--binary__: Print hexadecimal values instead of Unicode characters. (Only applied on output, input will still be UTF-8)\n * __-b__: Baudrate. _Default:_ 115200 baud.\n * __-f__: Configuration-triple: xyz with x = bytelength in bits {5,6,7,8}; y = parity {N,E,O}; z = stopbits {1,2}. _Default:_ \"8N1\" - _8_ data bits, _no_ parity bits and _1_ stop bit.\n * __-w__: Write received data into a file.\n\n_DEVICE_ is the path to the serial terminal.\nFor example _/dev/ttyS0_, _/dev/ttyUSB0_, _/dev/ttyUART0_, _/dev/ttyACM0_, _/dev/pts/42_.\n\nFor details read the man-page.\n\n### Internal commands\n\nThe following strings get not send to the device. Instead they are interpreted by _sterm_.\nThey have a preceded escape character defined with --escape. Default is the escape key (\"\\e\").\n\n * __exit__: quit sterm\n * __version__: print version\n\n### Examples\n\nSend _ping_ to UART0 and exit:\n```\nsterm /dev/ttyUART0\nping\npong\n^[exit\n```\n\nSend _hello_ to a serial device with 9600 baud, 7 data bits, even parity, and 2 stop bits. Then exit:\n```\nsterm -b 9600 -f 7E2 /dev/ttyS0\nhello\nworld\n^[exit\n```\n\nConnecting to a Linux device\n```\nsterm --noecho --escape _ /dev/ttyUSB0\n~# whoami\nroot\n~# _exit\n```\n\nCommunicating with two _sterm_ instances via a pseudo terminal for testing:\n![A picture that demonstrates the possibility of receiving ANSI escape sequences and unicode charaters](/stermscreenshot.png?raw=true \"Testrun showing some capabilities of sterm\")\n\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/rstemmer/sterm", "keywords": "serial-communication serial-terminal terminal uart rs232 monitoring tty pyserial serial", "license": "GPL", "maintainer": "", "maintainer_email": "", "name": "sterm", "package_url": "https://pypi.org/project/sterm/", "platform": "", "project_url": "https://pypi.org/project/sterm/", "project_urls": { "Documentation": "https://github.com/rstemmer/sterm", "Homepage": "https://github.com/rstemmer/sterm", "Source": "https://github.com/rstemmer/sterm", "Tracker": "https://github.com/rstemmer/sterm/issues" }, "release_url": "https://pypi.org/project/sterm/6.0.0a6/", "requires_dist": [ "pyserial" ], "requires_python": ">=3.4", "summary": "A minimal serial / UART command line terminal that focus on being easy to use.", "version": "6.0.0a6" }, "last_serial": 5595752, "releases": { "6.0.0a5": [ { "comment_text": "", "digests": { "md5": "409898b6cf521abb5256e01b830eee42", "sha256": "b6b04420687388b4ae422e7df19faa69035c9cdc1b155a7d14fcf7baacbd6594" }, "downloads": -1, "filename": "sterm-6.0.0a5-py3-none-any.whl", "has_sig": false, "md5_digest": "409898b6cf521abb5256e01b830eee42", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 29040, "upload_time": "2019-07-27T17:31:28", "url": "https://files.pythonhosted.org/packages/92/ef/0cd5c960d5f59790c2365405015000548bd5aacfa3e198df6a899eff587a/sterm-6.0.0a5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8ae3f1e305391a8c481e3b21de20f7f", "sha256": "5d2211dedabff4d2d39b1ed22b3c41b32609f2a67b7ef2bf33e7c845d168fe6c" }, "downloads": -1, "filename": "sterm-6.0.0a5.tar.gz", "has_sig": false, "md5_digest": "f8ae3f1e305391a8c481e3b21de20f7f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 11830, "upload_time": "2019-07-27T17:31:30", "url": "https://files.pythonhosted.org/packages/7b/d2/d68d624479468d3a814c9d9c115e74b9f524c97fcf99eccdbe2ead63406e/sterm-6.0.0a5.tar.gz" } ], "6.0.0a6": [ { "comment_text": "", "digests": { "md5": "1774307b3dc531ff281e224a2e0c7bed", "sha256": "5415296a7af816cf6443c9b4af59c56f020fb8305b50910c003b323a7a5315de" }, "downloads": -1, "filename": "sterm-6.0.0a6-py3-none-any.whl", "has_sig": false, "md5_digest": "1774307b3dc531ff281e224a2e0c7bed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 29114, "upload_time": "2019-07-28T13:58:13", "url": "https://files.pythonhosted.org/packages/18/54/243dae9624fac95fbc59399ff0913db4e8d12ca2ff37f76fa60a7dd625ca/sterm-6.0.0a6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d9c227a8cc501376a622d4387476af48", "sha256": "836c383f48970d66129f24fd411de68a47a23da915cc3a85c395a2293900c7c7" }, "downloads": -1, "filename": "sterm-6.0.0a6.tar.gz", "has_sig": false, "md5_digest": "d9c227a8cc501376a622d4387476af48", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12200, "upload_time": "2019-07-28T13:58:14", "url": "https://files.pythonhosted.org/packages/05/70/aa723ff8ffea3b610f29643f7efbcab659d6d240178338556eb3b717be15/sterm-6.0.0a6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1774307b3dc531ff281e224a2e0c7bed", "sha256": "5415296a7af816cf6443c9b4af59c56f020fb8305b50910c003b323a7a5315de" }, "downloads": -1, "filename": "sterm-6.0.0a6-py3-none-any.whl", "has_sig": false, "md5_digest": "1774307b3dc531ff281e224a2e0c7bed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.4", "size": 29114, "upload_time": "2019-07-28T13:58:13", "url": "https://files.pythonhosted.org/packages/18/54/243dae9624fac95fbc59399ff0913db4e8d12ca2ff37f76fa60a7dd625ca/sterm-6.0.0a6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d9c227a8cc501376a622d4387476af48", "sha256": "836c383f48970d66129f24fd411de68a47a23da915cc3a85c395a2293900c7c7" }, "downloads": -1, "filename": "sterm-6.0.0a6.tar.gz", "has_sig": false, "md5_digest": "d9c227a8cc501376a622d4387476af48", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.4", "size": 12200, "upload_time": "2019-07-28T13:58:14", "url": "https://files.pythonhosted.org/packages/05/70/aa723ff8ffea3b610f29643f7efbcab659d6d240178338556eb3b717be15/sterm-6.0.0a6.tar.gz" } ] }