xref: /aosp_15_r20/external/pigweed/pw_sys_io_arduino/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_sys_io_arduino:
2
3-----------------
4pw_sys_io_arduino
5-----------------
6
7``pw_sys_io_arduino`` implements the ``pw_sys_io`` facade over
8`Arduino's Serial interface <https://www.arduino.cc/reference/en/language/functions/communication/serial/>`_.
9
10On initialization it runs Arduino's first ``Serial`` interface at a 115200 baud
11rate:
12
13.. code-block:: cpp
14
15   Serial.begin(115200);
16
17   // Wait for serial port to be available
18   while (!Serial) {}
19
20After ``Serial.begin(115200)`` it will busy wait until a host connects to the
21serial port.
22
23.. seealso::
24   - :ref:`target-arduino` target documentation for a list of working hardware.
25   - :ref:`module-pw_arduino_build` for caveats when running Pigweed on top of
26     the Arduino API.
27