# Robot Framework - SerialLibrary
## Overview
PySerial Robot Framework Library is a Python library for interacting with serial devices using Robot Framework. This library provides keywords for connecting to serial devices, reading and writing data, setting timeouts, and more.
## Installation
```bash
pip install robotframework-pyserial
```
## Documentation
For detailed documentation of each keyword and usage examples, refer to the documentation in the below link,
https://reharish.github.io/robotframework-pyserial
## Project Inspiration
- [zilogic-systems/parrot](https://github.com/zilogic-systems/parrot) - Embedded Test Automation Framework, based on Robot Framework.
- [pySerial](https://github.com/pyserial/pyserial) - Python serial port access library
## Usage
To use the PySerial Robot Framework Library in your Robot Framework test suites, you need to import it at the beginning of your test suite file:
```robot
*** Settings ***
Library SerialLibrary
*** Test Cases ***
Example Test
Connect COM1 9600
Set Timeout 5
Write Hello, world!
${data}= Read
Should Be Equal ${data} Hello, world!
Disconnect from Serial
```
## Keywords
| Keyword | Description |
|--------------------------|------------------------------------------------|
| **Connect** | Connects to a serial device. |
| **Disconnect** | Disconnects from the serial device. |
| **Set Timeout** | Sets the read timeout for the serial device. |
| **Set Write Timeout** | Sets the write timeout for the serial device. |
| **Set Unicode** | Sets the Unicode encoding for data communication. |
| **Read** | Reads data from the serial device. |
| **Write** | Writes data to the serial device. |
| **Read until** | Reads data from the serial device until a specified string is encountered. |
| **Read All** | Reads all the data from the input buffer. |
| **Reset Input Buffer** | Clear the input buffer for the serial device. |
| **Reset Output Buffer** | Clear the output buffer for the serial device. |
| **Save buffer to file** | Saves the data buffer into a file. |
## Contributors
- Harishbabu Rengaraj([@reharish](https://github.com/reharish))
- Abisheak Kumarasamy ([@abi-sheak](https://github.com/abi-sheak))
- Karl Palsson ([@karlp](https://github.com/karlp))
## License
- See the `LICENSE` file for details.
Raw data
{
"_id": null,
"home_page": "https://reharish.github.io/cv",
"name": "robotframework-pyserial",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "reharish",
"author_email": "rengarajharish@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5a/ce/c1f3b068ce2441116693ae40360e8054be70674529241fa2806a83871c24/robotframework_pyserial-1.3.0.tar.gz",
"platform": null,
"description": "# Robot Framework - SerialLibrary\n\n## Overview\n\nPySerial Robot Framework Library is a Python library for interacting with serial devices using Robot Framework. This library provides keywords for connecting to serial devices, reading and writing data, setting timeouts, and more.\n\n## Installation\n\n\n\n```bash\npip install robotframework-pyserial\n```\n\n\n## Documentation\n\n\n\nFor detailed documentation of each keyword and usage examples, refer to the documentation in the below link,\n\nhttps://reharish.github.io/robotframework-pyserial\n\n## Project Inspiration\n\n- [zilogic-systems/parrot](https://github.com/zilogic-systems/parrot) - Embedded Test Automation Framework, based on Robot Framework.\n\n- [pySerial](https://github.com/pyserial/pyserial) - Python serial port access library\n\n## Usage\n\nTo use the PySerial Robot Framework Library in your Robot Framework test suites, you need to import it at the beginning of your test suite file:\n\n```robot\n*** Settings ***\nLibrary SerialLibrary\n\n*** Test Cases ***\nExample Test\n Connect COM1 9600\n Set Timeout 5\n Write Hello, world!\n ${data}= Read\n Should Be Equal ${data} Hello, world!\n Disconnect from Serial\n```\n\n## Keywords\n\n| Keyword | Description |\n|--------------------------|------------------------------------------------|\n| **Connect** | Connects to a serial device. |\n| **Disconnect** | Disconnects from the serial device. |\n| **Set Timeout** | Sets the read timeout for the serial device. |\n| **Set Write Timeout** | Sets the write timeout for the serial device. |\n| **Set Unicode** | Sets the Unicode encoding for data communication. |\n| **Read** | Reads data from the serial device. |\n| **Write** | Writes data to the serial device. |\n| **Read until** | Reads data from the serial device until a specified string is encountered. |\n| **Read All** | Reads all the data from the input buffer. |\n| **Reset Input Buffer** | Clear the input buffer for the serial device. |\n| **Reset Output Buffer** | Clear the output buffer for the serial device. |\n| **Save buffer to file** | Saves the data buffer into a file. |\n\n\n## Contributors\n\n- Harishbabu Rengaraj([@reharish](https://github.com/reharish))\n- Abisheak Kumarasamy ([@abi-sheak](https://github.com/abi-sheak))\n- Karl Palsson ([@karlp](https://github.com/karlp))\n\n\n## License\n\n- See the `LICENSE` file for details.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Robotframework implementation of beloved pyserial module",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://reharish.github.io/cv"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a27158f52d5e50be909ae408295b44f3298000b2387b05063cf3cc6c02fdc291",
"md5": "a8f5011b77fd314a20c2a564cfd7ce9f",
"sha256": "f574ccea89a27694ae72b286797f9172ad68a9aa0bf6fad0117bc9edc027f67c"
},
"downloads": -1,
"filename": "robotframework_pyserial-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8f5011b77fd314a20c2a564cfd7ce9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8637,
"upload_time": "2024-09-20T07:54:53",
"upload_time_iso_8601": "2024-09-20T07:54:53.720995Z",
"url": "https://files.pythonhosted.org/packages/a2/71/58f52d5e50be909ae408295b44f3298000b2387b05063cf3cc6c02fdc291/robotframework_pyserial-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5acec1f3b068ce2441116693ae40360e8054be70674529241fa2806a83871c24",
"md5": "0406470023fa40765eb217e6321fedf0",
"sha256": "0036bdf821d9c6c966a01e014a514b5da5d15aaf3ced86c7a35c0c5100303e10"
},
"downloads": -1,
"filename": "robotframework_pyserial-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "0406470023fa40765eb217e6321fedf0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7861,
"upload_time": "2024-09-20T07:54:54",
"upload_time_iso_8601": "2024-09-20T07:54:54.961750Z",
"url": "https://files.pythonhosted.org/packages/5a/ce/c1f3b068ce2441116693ae40360e8054be70674529241fa2806a83871c24/robotframework_pyserial-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 07:54:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "robotframework-pyserial"
}
JSON