Metadata-Version: 2.1
Name: serial_y_cable
Version: 0.2.0
Summary: The serial_y_cable Tool
Project-URL: Homepage, https://github.com/chriesibaum/serial_y_cable
Author-email: Thomas <thomas@chriesibaum.com>
License: tbd.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: key-stroke
Requires-Dist: pyserial
Description-Content-Type: text/markdown

# The serial_y_cable Tool

## Usage
```
basic usage of serial_y_cable:

  ┌─────────────────┐                                                                     ┌────────────────────────────────┐
  │ hardware / DUT  ├──  hardware serial dev   ─────┬───────  virtual serial dev 0  ──────┤ application that controls      │
  └─────────────────┘      e.g.://dev/ttyUSB0       │          /tmp/ttyUSB0-V0            │ the hardware / DUT             │
                                                    │                                     └────────────────────────────────┘
                                                    │
                                                    │                                     ┌────────────────────────────────┐
                                                    └───────  virtual serial dev 1  ──────┤ serial terminal for monitoring │
                                                                /tmp/ttyUSB0-V0           │  - e.g. minicom, screen, etc.  │
                                                                                          └────────────────────────────────┘

```


## Limitations

For now only monitoring on both virtual devices is implemented (bytes are only copied from the hardware side to the virtual devices).


## Requirements

The following modules are needed for **serial_y_cable**
- pyserial
- key_stroke

You can install them easily from pypi.org:
```
pip install pyserial key_stroke
```

\
\
The closing word for this week:\
Have fun with the serial_y_cable tool!\
Thomas@chriesibaum.com
