|
3 | 3 | A Python implementation of virtual serial ports. Useful for developing and |
4 | 4 | testing programs which need to talk to a serial port. |
5 | 5 |
|
6 | | -[](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/demo.gif) |
| 6 | +You can: |
7 | 7 |
|
8 | | -Example uses: |
| 8 | +* Create a virtual port which echoes back any data sent to it: |
| 9 | + [](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_1_loopback.gif?raw=true) |
9 | 10 |
|
10 | | -* Create a virtual port which echoes back any data sent to it. |
11 | | -* Create a two or more ports; sending data to one sends data to the others. |
| 11 | +* Create a two or more ports; sending data to one sends data to the others: |
| 12 | + [](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_2.gif?raw=true) |
12 | 13 |
|
13 | | -Should work on Python 3.5+, however is only tested on supported |
| 14 | +* Monitor what is being sent between the ports: |
| 15 | + [](https://github.com/ezramorris/PyVirtualSerialPorts/blob/main/images/demo_2_loopback_debug.gif?raw=true) |
| 16 | + |
| 17 | +It should work on Python 3.5+, however is only tested on supported |
14 | 18 | [Python versions]. |
15 | 19 |
|
16 | 20 | Has no dependencies other than the Python standard library. |
17 | 21 |
|
18 | 22 | Currently works on *nix type systems. Tested on Ubuntu and MacOS, but should |
19 | | -work on others (BSD, etc.). Windows support is being worked on. |
| 23 | +work on others e.g. BSD. Windows support is being worked on. |
20 | 24 |
|
21 | 25 | ## Installation |
22 | 26 |
|
23 | | -### Current user |
| 27 | +### Install for current user |
24 | 28 |
|
25 | 29 | $ pip3 install PyVirtualSerialPorts |
26 | 30 |
|
27 | | -### System-wide |
| 31 | +### Install system-wide |
28 | 32 |
|
29 | 33 | $ sudo pip3 install PyVirtualSerialPorts |
30 | 34 |
|
@@ -99,7 +103,7 @@ with VirtualSerialPorts(2) as ports: |
99 | 103 | ``` |
100 | 104 |
|
101 | 105 | `ports` is a list of strings, which can be used to open the ports, e.g with |
102 | | -PySerial. A complete example is in example.py. |
| 106 | +PySerial. A complete example is in [example.py](example.py). |
103 | 107 |
|
104 | 108 | It can also be used without a context manager as follows: |
105 | 109 |
|
|
0 commit comments