UPDATE: update README

uncertainty-cc · Jun 15, 2022 · 0c9f301 · 0c9f301
1 parent 03a00e3
commit 0c9f301
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -136,3 +136,11 @@ while True:
     ser.transmit(buffer)
 
 ```
+
+Packet receiving timeout, blocking vs non-blocking
+
+```python
+buffer = ser.receive(timeout=None)  # blocking (default)
+buffer = ser.receive(timeout=0)     # non-blocking, return b"" if no data
+buffer = ser.receive(timeout=1)     # timeout for 1 sec, return b"" if no data
+```