Unverified Commit c32ad457 authored by Earle F. Philhower, III's avatar Earle F. Philhower, III Committed by GitHub

Clean up some minor doc errors/formats (#559)

parent 541e23d6
......@@ -29,5 +29,8 @@ A ``SoftwareSerial`` wrapper is included to provide plug-and-play compatibility
with the Arduino `Software Serial <https://docs.arduino.cc/learn/built-in-libraries/software-serial>`_
library. Use the normal ``#include <SoftwareSerial.h>`` to include it. The following
differences from the Arduino standard are present:
* Inverted mode is not supported
* All ports are always listening. The ``listen`` call is a no-op, and ``isListening()`` always returns ``true`` .
* All ports are always listening
* ``listen`` call is a no-op
* ``isListening()`` always returns ``true``
......@@ -32,15 +32,14 @@ using the ``setFIFOSize`` call prior to calling ``begin()``
Serial1.begin(baud);
The FIFO is normally handled via an interrupt, which reduced CPU load and
makes it less likely to lose characters. However, the FIFO introduces up
to 32 bit-times of delay before serial data is available to the application.
makes it less likely to lose characters.
For applications where this is an issue (i.e. very low baud), use
For applications where an IRQ driven serial port is not appropriate, use
``setPollingMode(true)`` before calling ``begin()``
.. code:: cpp
Serial1.setPollingMode(true);
Serial1.begin(110)
Serial1.begin(300)
For detailed information about the Serial ports, see the
Arduino `Serial Reference <https://www.arduino.cc/reference/en/language/functions/communication/serial/>`_ .
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment