1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
.. _usart:
=======
USART
=======
.. contents::
:local:
Hardware/Circuit Design
-----------------------
The Maple has 3 separate USART devices: ``Serial1``, ``Serial2``, and
``Serial3``. In the most simple use case, the RX and TX pins are used
to send data at a predetermined baudrate with the line voltage level
relative to ground.
+-----------+--------+-----+
|Port |Function|Pin |
+===========+========+=====+
|``Serial1``|TX |D7 |
| | | |
| |RX |D8 |
| | | |
| |CK |D6 |
+-----------+--------+-----+
|``Serial2``|TX |D1 |
| | | |
| |RX |D0 |
| | | |
| |CK |D10 |
| | | |
| |CTS |D2 |
| | | |
| |RTS |D3 |
+-----------+--------+-----+
|``Serial3``|TX |D29 |
| | | |
| |RX |D30 |
| | | |
| |CK |D31 |
| | | |
| |CTS |D32 |
| | | |
| |RTS |D33 |
+-----------+--------+-----+
.. TODO make above less ugly
Compatible Devices and Specifications
-------------------------------------
We have successfully used the Maple USART ports with an FT232R-based USB-serial converter at up to 115200 baud; higher speeds should certainly be possible.
Function Reference
------------------
In the following, you may replace ``SerialN`` with ``Serial1``,
``Serial2``, or ``Serial3``.
``SerialN.begin(baudrate)``
``SerialN.begin`` is usually called in `setup()`_ to configure the
baudrate of the given serial port and to set up the header pins
appropriately. It can be called at any time to reconfigure a port
or to change the baudrate. 9600 baud is the generic speed most
widely supported by other devices and terminals.
``SerialN.print(...)``/\ ``SerialN.println(...)``
Writes data into the port buffer to be transmitted as soon as
possible. Accepts strings (``char*``). If a raw integer is
passed, the corresponding ASCII character will be transmitted; to
print out a number in human readable form add a second parameter
with the base system.
For example, to print out the decimal number '1234' use
``SerialN.print(1234, DEC)``; to print out the binary number
'1001', use ``SerialN.print(9, BIN)``.
``SerialN.available()``/\ ``SerialN.read()``
``SerialN.read()`` will return the next unread character that has
been received over the port. ``SerialN.available()`` returns how
many such bytes are available (or zero if none are). If none are
available, ``SerialN.read()`` will block/fail, so the usual
program structure is to poll with ``SerialN.available`` and only
read if a nonzero value is returned.
Recommended Reading
-------------------
* `Wikipedia article on Universal asynchronous receiver/transmitter (USART) <http://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter>`_
* `Arduino reference on Serial <http://arduino.cc/en/Reference/Serial>`_
* STMicro documentation for STM32F103RB microcontroller:
* `All <http://www.st.com/mcu/devicedocs-STM32F103RB-110.html>`_
* `Datasheet <http://www.st.com/stonline/products/literature/ds/13587.pdf>`_ (pdf)
* `Reference Manual <http://www.st.com/stonline/products/literature/rm/13902.pdf>`_ (pdf)
|
