third_party.pigweed.src/pw_sys_io_arduino/docs.rst
Anthony DiGirolamo 9147aa0128 Arduino: main function wrapper
- Remove simple_printing_main_arduino.cc which used loop() and setup()
- Rename main() in arduino core sources to ArduinoMain()
- Define setup() and loop() in arduino_main_wrapper.cc and call pigweed
  main() in setup() after pw_arduino_Init();
- Switch to pw_unit_test_MAIN = "$dir_pw_unit_test:simple_printing_main"
  in //targets/arduino/target_toolchains.gni
- Add pw_arduino_build/public/pw_arduino_build/init.h facade
- Documentation!
- Fix bug in arduinobuilder.py when using an arduino core which uses
  only one sub-core folder.

Change-Id: I94630b25f6c914ef46bdb9c32e6ddb5154690045
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/18640
Reviewed-by: Armando Montanez <amontanez@google.com>
Commit-Queue: Anthony DiGirolamo <tonymd@google.com>
2020-09-25 23:05:41 +00:00

32 lines
793 B
ReStructuredText

.. default-domain:: cpp
.. highlight:: sh
.. _chapter-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:`chapter-arduino` target documentation for a list of working hardware.
- :ref:`chapter-pw-arduino-build` for caveats when running Pigweed on top of
the Arduino API.