Skip to content

Commit 42e9379

Browse files
committed
Update README.md
1 parent b707f82 commit 42e9379

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This is much more compact but can create problems when the user wants to send a
4848

4949
## PacketSerial
5050

51-
The `PacketSerial` class wraps the standard Arduino `Serial` class to automatically encode and decode byte packets automatically. Thus users can still call methods on the `Serial` object (e.g. `Serial.write()`, the built in `serialEvent()` callback etc), but it is not recommended. Users are advised to let PacketSerial manage all Serial communication via the packet handler callback for incoming packets and the `send(const uint8_t* buffer, size_t size)` method for outgoing packets.
51+
The `PacketSerial` class wraps the standard Arduino `Serial` class to automatically encode and decode byte packets automatically. Thus users can still call methods on the `Serial` object (e.g. `Serial.write()`, the built in `serialEvent()` callback etc), but it is not recommended. Users are advised to let PacketSerial manage all Serial communication via the packet handler callback for incoming packets and the `send(const uint8_t* buffer, size_t size)` method for outgoing packets. Mixing raw Serial calls with PacketSerial may lead to unexpected results, as the endpoint will not know what data is encoded and what data is not.
5252

5353

5454
## Setup
@@ -186,4 +186,4 @@ void reverse(uint8_t* buffer, size_t size)
186186

187187
- openFrameworks
188188
- https://github.com/bakercp/ofxSerial
189-
- See the `ofx::IO::PacketSerial` object which is directly compatible with this library.
189+
- See the `ofx::IO::PacketSerial` object which is directly compatible with this library.

0 commit comments

Comments
 (0)