Skip to content

Commit 20ddd33

Browse files
committed
docs: fix typos and links
1 parent e044422 commit 20ddd33

File tree

4 files changed

+26
-32
lines changed

4 files changed

+26
-32
lines changed

docs/arduino-variations.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Arduino Variations
2-
====================
1+
Variations from Arduino Standard
2+
================================
33

44
Functions and Options Differences
55
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/builtin-libraries.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
Built in Libraries
2-
=====================
1+
Built-in Libraries
2+
==================
33

44
The XMC for Arduino platform provides a comprehensive set of built-in libraries that enable developers to easily access
5-
and utilize the XMC microcontrollers' features and peripherals; this section lists these libraries, including their
5+
and utilize the XMC microcontrollers' features and peripherals. This section lists these libraries, including their
66
functionality and supported boards.
77

88
DeviceControl XMC
9-
^^^^^^^^^^^^^^^^^^^^
9+
^^^^^^^^^^^^^^^^^
1010

1111
Examples Supported
12-
-------------------
12+
------------------
1313

1414
.. list-table::
1515
:header-rows: 1
@@ -99,7 +99,7 @@ Examples Supported
9999

100100

101101
RTC Library
102-
^^^^^^^^^^^^^^
102+
^^^^^^^^^^^
103103

104104
.. list-table::
105105
:header-rows: 1
@@ -117,7 +117,7 @@ RTC Library
117117

118118

119119
SPI Library
120-
^^^^^^^^^^^^^^
120+
^^^^^^^^^^^
121121

122122
.. list-table::
123123
:header-rows: 1
@@ -142,7 +142,7 @@ SPI Library
142142
143143

144144
Wire Library
145-
^^^^^^^^^^^^^^
145+
^^^^^^^^^^^^
146146

147147
.. list-table::
148148
:header-rows: 1
@@ -217,24 +217,24 @@ Wire Library
217217
218218

219219
I2S Library
220-
^^^^^^^^^^^^^^
220+
^^^^^^^^^^^
221221

222222
This library has been tested with the IM69D130 Microphone Shield2Go with both XMC4700 Relax Kit and XMC1100 XMC2Go.
223223
Please refer to the `README.md <https://github.com/Infineon/XMC-for-Arduino/blob/master/libraries/I2S/README.md>`_ of
224224
the I2S library for pin connections.
225225

226226
Limitations
227-
------------
227+
-----------
228228
With XMC 2Go (possibly also with other XMC1000 family devices), you might easily overflow the I2S buffer and you should
229229
try to reduce the I2S sampling rate if so.
230230

231231
OneWire Library
232-
^^^^^^^^^^^^^^^^
232+
^^^^^^^^^^^^^^^
233233

234234
Library for One wire protocol. It could be used to access 1-wire temperature sensors, memory and other chips.
235235

236236
CAN Library
237-
^^^^^^^^^^^^^^
237+
^^^^^^^^^^^
238238

239239
This library provides support for the CAN protocol. For further details, please refer to the `README.md <https://github.com/Infineon/XMC-for-Arduino/blob/master/libraries/CAN/README.md>`_ file in the CAN library.
240240

@@ -262,7 +262,7 @@ This library provides support for the CAN protocol. For further details, please
262262
| when data is received on the CAN bus. In both examples,
263263
| messages with any ID transmitted on the CAN bus can
264264
| be received. Additionally, messages can be filtered for
265-
| specific IDs using the filter() function.
265+
| specific IDs using the ``filter()`` function.
266266
* - CANLoopBack
267267
- XMC1400 2GO
268268
- | This example demonstrates the loopback mode of CAN.

docs/hw-platforms.rst

+11-16
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ The following XMC microcontroller boards are supported by XMC for Arduino:
1010
- Board Name
1111
- Description
1212
- Form Factor
13-
* - .. image:: img/KIT_XMC14_2GO.png
14-
- Various Kit 2Go boards
15-
- Various Kit 2Go sensorboards.
16-
- Shield2Go
1713
* - .. image:: img/KIT_XMC14_2GO.png
1814
- `KIT_XMC14_2GO`_
1915
- Kit 2Go with XMC1404 and CAN transceiver.
@@ -39,7 +35,6 @@ The following XMC microcontroller boards are supported by XMC for Arduino:
3935
- XMC4400 compatible with multiple form-factors.
4036
- Arduino Uno, Shield2Go, mikroBUS
4137

42-
4338
KIT_XMC14_2GO
4439
-------------
4540

@@ -180,9 +175,9 @@ For the KIT_XMC_PLT2GO_XMC4200, KIT_XMC_PLT2GO_XMC4400 and KIT_XMC47_RELAX_5V_AD
180175
pin number 14 & 20 (SDA & A4) are connected with each other on the board itself. Although they are different physical pins of the microcontroller,
181176
they are connected with each other on the board to comply with the original Arduino UNO Rev3 pin connections. This influences analog measurements on
182177
A4 and A5 if you are using I2C simultaneously. Details of the connection can also be found in the schematics in the user manual of the board here:
183-
`KIT_XMC_PLT2GO_XMC4200 User Manual`_, `KIT_XMC_PLT2GO_XMC4400 User Manual`_ and `KIT_XMC47_RELAX_5V_AD_V1 User Manual`_.
178+
`KIT_XMC_PLT2GO_XMC4200 user manual`_, `KIT_XMC_PLT2GO_XMC4400 user manual`_ and `KIT_XMC47_RELAX_5V_AD_V1 user manual`_.
184179

185-
The User Manual shows on:
180+
The user manual shows on:
186181

187182
* Page 11 details the 3V3 signals on connectors X1 and X2 (figure 7) including ADC channels
188183
* Page 12 below Figure 8 details analog input specifications
@@ -210,12 +205,12 @@ For the KIT_XMC47_RELAX_5V_AD_V1 cut the blue routes on the back side of the PCB
210205
:width: 600
211206

212207

213-
.. _`KIT_XMC14_2GO`: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/?redirId=282145
214-
.. _`KIT_XMC11_BOOT_001`: https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/
215-
.. _`KIT_XMC1400_ARDUINO`: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/
216-
.. _`KIT_XMC_PLT2GO_XMC4200`: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/
217-
.. _`KIT_XMC_PLT2GO_XMC4400`: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/
218-
.. _`KIT_XMC47_RELAX_5V_AD_V1`: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/?redirId=114289
219-
.. _`KIT_XMC_PLT2GO_XMC4200 User Manual`: https://www.infineon.com/dgdl/Infineon-XMC4200_Platform2Go-UserManual-v01_00-EN.pdf?fileId=5546d4626f229553016f8fca76c12c96
220-
.. _`KIT_XMC_PLT2GO_XMC4400 User Manual`: https://www.infineon.com/dgdl/Infineon-XMC4400_Platform2Go-UserManual-v01_00-EN.pdf?fileId=5546d4626f229553016f8fc159482c94
221-
.. _`KIT_XMC47_RELAX_5V_AD_V1 User Manual`: https://www.infineon.com/dgdl/Infineon-Board_User_Manual_XMC4700_XMC4800_Relax_Kit_Series-UM-v01_02-EN.pdf?fileId=5546d46250cc1fdf01513f8e052d07fc
208+
.. _KIT_XMC14_2GO: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/?redirId=282145
209+
.. _KIT_XMC11_BOOT_001: https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/
210+
.. _KIT_XMC1400_ARDUINO: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/
211+
.. _KIT_XMC_PLT2GO_XMC4200: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/
212+
.. _KIT_XMC_PLT2GO_XMC4400: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/
213+
.. _KIT_XMC47_RELAX_5V_AD_V1: https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/?redirId=114289
214+
.. _KIT_XMC_PLT2GO_XMC4200 user manual: https://www.infineon.com/dgdl/Infineon-XMC4200_Platform2Go-UserManual-v01_00-EN.pdf?fileId=5546d4626f229553016f8fca76c12c96
215+
.. _KIT_XMC_PLT2GO_XMC4400 user manual: https://www.infineon.com/dgdl/Infineon-XMC4400_Platform2Go-UserManual-v01_00-EN.pdf?fileId=5546d4626f229553016f8fc159482c94
216+
.. _KIT_XMC47_RELAX_5V_AD_V1 user manual: https://www.infineon.com/dgdl/Infineon-Board_User_Manual_XMC4700_XMC4800_Relax_Kit_Series-UM-v01_02-EN.pdf?fileId=5546d46250cc1fdf01513f8e052d07fc

docs/index.rst

-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ advantage of the advanced features and performance offered by XMC microcontrolle
4141
builtin-libraries
4242
arduino-variations
4343

44-
4544
License
4645
=======
4746

0 commit comments

Comments
 (0)