You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/builtin-libraries.rst
+13-13
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
-
Builtin Libraries
2
-
=====================
1
+
Built-in Libraries
2
+
==================
3
3
4
4
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
6
6
functionality and supported boards.
7
7
8
8
DeviceControl XMC
9
-
^^^^^^^^^^^^^^^^^^^^
9
+
^^^^^^^^^^^^^^^^^
10
10
11
11
Examples Supported
12
-
-------------------
12
+
------------------
13
13
14
14
.. list-table::
15
15
:header-rows: 1
@@ -99,7 +99,7 @@ Examples Supported
99
99
100
100
101
101
RTC Library
102
-
^^^^^^^^^^^^^^
102
+
^^^^^^^^^^^
103
103
104
104
.. list-table::
105
105
:header-rows: 1
@@ -117,7 +117,7 @@ RTC Library
117
117
118
118
119
119
SPI Library
120
-
^^^^^^^^^^^^^^
120
+
^^^^^^^^^^^
121
121
122
122
.. list-table::
123
123
:header-rows: 1
@@ -142,7 +142,7 @@ SPI Library
142
142
143
143
144
144
Wire Library
145
-
^^^^^^^^^^^^^^
145
+
^^^^^^^^^^^^
146
146
147
147
.. list-table::
148
148
:header-rows: 1
@@ -217,24 +217,24 @@ Wire Library
217
217
218
218
219
219
I2S Library
220
-
^^^^^^^^^^^^^^
220
+
^^^^^^^^^^^
221
221
222
222
This library has been tested with the IM69D130 Microphone Shield2Go with both XMC4700 Relax Kit and XMC1100 XMC2Go.
223
223
Please refer to the `README.md <https://github.com/Infineon/XMC-for-Arduino/blob/master/libraries/I2S/README.md>`_ of
224
224
the I2S library for pin connections.
225
225
226
226
Limitations
227
-
------------
227
+
-----------
228
228
With XMC 2Go (possibly also with other XMC1000 family devices), you might easily overflow the I2S buffer and you should
229
229
try to reduce the I2S sampling rate if so.
230
230
231
231
OneWire Library
232
-
^^^^^^^^^^^^^^^^
232
+
^^^^^^^^^^^^^^^
233
233
234
234
Library for One wire protocol. It could be used to access 1-wire temperature sensors, memory and other chips.
235
235
236
236
CAN Library
237
-
^^^^^^^^^^^^^^
237
+
^^^^^^^^^^^
238
238
239
239
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.
240
240
@@ -262,7 +262,7 @@ This library provides support for the CAN protocol. For further details, please
262
262
|when data is received on the CAN bus. In both examples,
263
263
|messages with any ID transmitted on the CAN bus can
264
264
|be received. Additionally, messages can be filtered for
265
-
|specific IDs using the filter() function.
265
+
|specific IDs using the ``filter()`` function.
266
266
* - CANLoopBack
267
267
- XMC1400 2GO
268
268
- | This example demonstrates the loopback mode of CAN.
.. _`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
.. _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
0 commit comments