third_party.pigweed.src/pw_sys_io_arduino/docs.rst
Wyatt Hepler f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00

28 lines
746 B
ReStructuredText

.. _module-pw_sys_io_arduino:
-----------------
pw_sys_io_arduino
-----------------
``pw_sys_io_arduino`` implements the ``pw_sys_io`` facade over
`Arduino's Serial interface <https://www.arduino.cc/reference/en/language/functions/communication/serial/>`_.
On initialization it runs Arduino's first ``Serial`` interface at a 115200 baud
rate:
.. code-block:: cpp
Serial.begin(115200);
// Wait for serial port to be available
while (!Serial) {
}
After ``Serial.begin(115200)`` it will busy wait until a host connects to the
serial port.
.. seealso::
- :ref:`target-arduino` target documentation for a list of working hardware.
- :ref:`module-pw_arduino_build` for caveats when running Pigweed on top of
the Arduino API.