Skip to content

Commit 4daa5f1

Browse files
committed
Fixes plerup#199, documentation clarification
1 parent 7326874 commit 4daa5f1

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,10 @@ data until the next read call.
5757
For the swsertest.ino example, this results in the following optimized
5858
constructor arguments to spend only the minimum RAM on buffers required:
5959

60-
The octet buffer capacity (``bufCapacity``) is 93 (91 characters net plus two tolerance).
61-
The signal edge detection buffer capacity (``isrBufCapacity``) is 10, as each octet has
62-
10 bits on the wire, which are immediately received during the write, and each
60+
The octet buffer capacity (``bufCapacity``) is 95 (93 characters net plus two tolerance).
61+
The signal edge detection buffer capacity (``isrBufCapacity``) is 11, as each
62+
single octet can have up to 11 bits on the wire,
63+
which are immediately received during the write, and each
6364
write call causes the signal edge detection to promote the previously sent and
6465
received bits to the octet buffer.
6566

examples/swsertest/swsertest.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ SoftwareSerial swSer;
3131
void setup() {
3232
Serial.begin(115200);
3333
// Important: the buffer size optimizations here, in particular the isrBufSize (11) that is only sufficiently
34-
// large to hold a single 8N1 word, are on the basis that any char written to the loopback SoftwareSerial
34+
// large to hold up to a single word (up to 8E2), are on the basis that any char written to the loopback SoftwareSerial
3535
// adapter gets read before another write is performed.
3636
// Block writes with a size greater than 1 would usually fail. Do not copy this into your own project without
3737
// reading the documentation.

0 commit comments

Comments
 (0)