Skip to content

Commit 843a0d7

Browse files
LinjingZhangLinjingZhang
committed
docs: Change XMC47 board to more generic name.
Signed-off-by: zhanglinjing <Linjing.Zhang@infineon.com>
1 parent 5bb25bf commit 843a0d7

6 files changed

Lines changed: 33 additions & 33 deletions

File tree

‎docs/arduino-deviations.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ function, or other case as described below.
153153
* - Board
154154
- Functionality
155155
- Note
156-
* - XMC1100 Boot Kit
156+
* - KIT_XMC11_BOOT_001
157157
- NOT supported
158158
- | A4 + A5 are separate
159159
| A6 + A7 are alternate pin
@@ -166,12 +166,12 @@ function, or other case as described below.
166166
* - KIT_XMC1400_ARDUINO
167167
- Alternate pin function
168168
- Matches Arduino Uno
169-
* - XMC4400 Platform 2Go
169+
* - KIT_XMC_PLT2GO_XMC4400
170170
- External hard wired pins
171171
- | For 3V3 boards set I2C pins to tristate or open drain to use
172172
| For 5V boards refer to [this section](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html#connected-i2s-and-analog-pins) on track cuts to enable A4 and A5 to work
173173
| Level shifter on the 5V board could interfere with tristate/open drain setting
174-
* - KIT_XMC47_RELAX_5V_AD_V1 (and variants)
174+
* - KIT_XMC47_RELAX (and variants)
175175
- External hard wired pins
176176
- | For 3V3 boards set I2C pins to tristate or open drain to use
177177
| For 5V boards see [this section](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html#connected-i2s-and-analog-pins) board page on track cuts to enable A4 and A5 to work

‎docs/builtin-libraries.rst‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Examples Supported
2424
| KIT_XMC14_2GO
2525
| KIT_XMC1400_ARDUINO
2626
| KIT_XMC_PLT2GO_XMC4400
27-
| KIT_XMC47_RELAX_5V_AD_V1
27+
| KIT_XMC47_RELAX
2828
- | Simple die temperature measurement
2929
| for XMC devices which demonstrates
3030
| themeasure temperature of die using
@@ -35,7 +35,7 @@ Examples Supported
3535
| KIT_XMC13_BOOT_001
3636
| KIT_XMC14_2GO
3737
| KIT_XMC1400_ARDUINO
38-
| KIT_XMC47_RELAX_5V_AD_V1
38+
| KIT_XMC47_RELAX
3939
- | Simple example to check heap memory
4040
| during run time for XMC devices which
4141
| demonstrates the ability to check on
@@ -49,7 +49,7 @@ Examples Supported
4949
- | Demonstrates the use of an alarm to
5050
| wake up an xmc1100 from sleep mode.
5151
* - SleepModeXMC4700
52-
- | KIT_XMC47_RELAX_5V_AD_V1
52+
- | KIT_XMC47_RELAX
5353
- | Simple Sleep Mode for XMC4700
5454
| Relax Kit V1 demonstrates the use of
5555
| an alarm to wake up an XMC4700 from
@@ -65,7 +65,7 @@ Examples Supported
6565
| KIT_XMC11_BOOT_001
6666
| KIT_XMC13_BOOT_001
6767
| KIT_XMC_PLT2GO_XMC4400
68-
| KIT_XMC47_RELAX_5V_AD_V1
68+
| KIT_XMC47_RELAX
6969
- | Simple example to check stack memory
7070
| during run time for XMC devices which
7171
| demonstrates the ability to check on
@@ -84,11 +84,11 @@ Examples Supported
8484
- Boards
8585
- Description
8686
* - DMA_Memory
87-
- | KIT_XMC47_RELAX_5V_AD_V1
87+
- | KIT_XMC47_RELAX
8888
- | Demonstrates how to setup an DMA, to transfer
8989
| data between two places in memory.
9090
* - DMA_UART
91-
- | KIT_XMC47_RELAX_5V_AD_V1
91+
- | KIT_XMC47_RELAX
9292
- | Demonstrates how to setup an DMA, to transfer
9393
| data between two places in memory.
9494
@@ -104,11 +104,11 @@ RTC Library
104104
- Boards
105105
- Description
106106
* - AlarmRTC
107-
- KIT_XMC47_RELAX_5V_AD_V1
107+
- KIT_XMC47_RELAX
108108
- | Demonstrates how to set an RTC alarm for the
109-
| KIT_XMC47_RELAX_5V_AD_V1 V1.
109+
| KIT_XMC47_RELAX V1.
110110
* - SimpleRTC
111-
- KIT_XMC47_RELAX_5V_AD_V1
111+
- KIT_XMC47_RELAX
112112
- Demonstrates the use of the RTC library for the XMC4700.
113113

114114

@@ -129,7 +129,7 @@ SPI Library
129129
| KIT_XMC14_2GO
130130
| KIT_XMC1400_ARDUINO
131131
| KIT_XMC_PLT2GO_XMC4400
132-
| KIT_XMC47_RELAX_5V_AD_V1
132+
| KIT_XMC47_RELAX
133133
- | SPI example which communicates between the
134134
| MOSI and MISO pin of the same board. Connect
135135
| the MOSI pin to the MOSI pin as hardware
@@ -152,7 +152,7 @@ Wire Library
152152
| KIT_XMC14_2GO
153153
| KIT_XMC1400_ARDUINO
154154
| KIT_XMC_PLT2GO_XMC4400
155-
| KIT_XMC47_RELAX_5V_AD_V1
155+
| KIT_XMC47_RELAX
156156
- | Demonstrates use of the Wire library. Reads data
157157
| from an I2C/TWI slave device. Refer to the "Wire Slave
158158
| Sender" example for use with this. Then it
@@ -167,7 +167,7 @@ Wire Library
167167
| KIT_XMC14_2GO
168168
| KIT_XMC1400_ARDUINO
169169
| KIT_XMC_PLT2GO_XMC4400
170-
| KIT_XMC47_RELAX_5V_AD_V1
170+
| KIT_XMC47_RELAX
171171
- | Demonstrates use of the Wire library. Writes data to
172172
| an I2C/TWI slave device. Refer to the "Wire Slave
173173
| Receiver" example for use with this. Then it
@@ -182,7 +182,7 @@ Wire Library
182182
| KIT_XMC14_2GO
183183
| KIT_XMC1400_ARDUINO
184184
| KIT_XMC_PLT2GO_XMC4400
185-
| KIT_XMC47_RELAX_5V_AD_V1
185+
| KIT_XMC47_RELAX
186186
- | Demonstrates use of the Wire library. Receives data as
187187
| an I2C/TWI slave device. Refer to the "Wire Slave
188188
| Writer" example for use with this. Then it
@@ -197,7 +197,7 @@ Wire Library
197197
| KIT_XMC14_2GO
198198
| KIT_XMC1400_ARDUINO
199199
| KIT_XMC_PLT2GO_XMC4400
200-
| KIT_XMC47_RELAX_5V_AD_V1
200+
| KIT_XMC47_RELAX
201201
- | Demonstrates use of the Wire library. Receives data as
202202
| an I2C/TWI slave device. Refer to the "Wire Master
203203
| Reader" example for use with this. Then it
@@ -210,7 +210,7 @@ Wire Library
210210
I2S Library
211211
^^^^^^^^^^^
212212

213-
This library has been tested with the IM69D130 Microphone Shield2Go with both KIT_XMC47_RELAX_5V_AD_V1 and XMC1100 XMC2Go.
213+
This library has been tested with the IM69D130 Microphone Shield2Go with both KIT_XMC47_RELAX and KIT_XMC_2GO_XMC1100_V1.
214214
Please refer to the `README.md <https://github.com/Infineon/XMC-for-Arduino/blob/master/libraries/I2S/README.md>`_ of
215215
the I2S library for pin connections.
216216

@@ -236,15 +236,15 @@ This library provides support for the CAN protocol. For further details, please
236236
- Boards
237237
- Description
238238
* - CANSender
239-
- XMC1400 2GO
239+
- KIT_XMC14_2GO
240240
- | This example demonstrates how to send a CAN message.
241241
| It supports two different message/frame formats:
242242
| standard and extended. The CAN standard frame uses
243243
| an 11-bit identifier, while the CAN extended frame
244244
| uses a 29-bit identifier.
245245
* - | CANReceiver/
246246
| CANReceiverCallback
247-
- XMC1400 2GO
247+
- KIT_XMC14_2GO
248248
- | This example demonstrates how to receive a CAN
249249
| message. There are two methods for receiving messages:
250250
| the default method runs a loop that continuously
@@ -255,7 +255,7 @@ This library provides support for the CAN protocol. For further details, please
255255
| be received. Additionally, messages can be filtered for
256256
| specific IDs using the ``filter()`` function.
257257
* - CANLoopBack
258-
- XMC1400 2GO
258+
- KIT_XMC14_2GO
259259
- | This example demonstrates the loopback mode of CAN.
260260
| In this mode, the CAN transmitter is internally connected
261261
| to its receiver, allowing the message to be sent and

‎docs/hw-platforms.rst‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ The following XMC microcontroller boards are supported by XMC for Arduino:
3434
- :ref:`KIT_XMC_PLT2GO_XMC4400`
3535
- XMC4400
3636
- Arduino Uno, Shield2Go, mikroBUS
37-
* - .. image:: img/KIT_XMC47_RELAX_5V_AD_V1.jpg
38-
- :ref:`KIT_XMC47_RELAX_5V_AD_V1`
37+
* - .. image:: img/KIT_XMC47_RELAX.jpg
38+
- :ref:`KIT_XMC47_RELAX`
3939
- XMC4700
4040
- Arduino Uno
4141

@@ -183,25 +183,25 @@ on the board itself. If you want to use them check out the subsection :ref:`conn
183183

184184
-----------------------------------------------------------------------
185185

186-
.. _KIT_XMC47_RELAX_5V_AD_V1:
186+
.. _KIT_XMC47_RELAX:
187187

188-
KIT_XMC47_RELAX_5V_AD_V1
188+
KIT_XMC47_RELAX
189189
------------------------
190190

191191
* Legacy name: ``XMC4700 Relax Kit``
192192
* `Product Page <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/>`__
193193

194-
.. image:: img/KIT_XMC47_RELAX_5V_AD_V1.jpg
194+
.. image:: img/KIT_XMC47_RELAX.jpg
195195
:width: 400
196196

197-
The KIT_XMC47_RELAX_5V_AD_V1 board consists of a XMC4700 microcontroller with a debugger implemented by a XMC4200 microcontroller.
197+
The KIT_XMC47_RELAX board consists of a XMC4700 microcontroller with a debugger implemented by a XMC4200 microcontroller.
198198
Please note that there exist versions with 5V and 3.3V.
199199
Please be careful which version you have and use with your respective shields.
200200
The one described here is the 5V version as this one is compatible with Arduino shields designed for 5V systems.
201201

202202
Pinout Diagram
203203
^^^^^^^^^^^^^^
204-
.. image:: img/KIT_XMC47_RELAX_5V_AD_V1_pinout.png
204+
.. image:: img/KIT_XMC47_RELAX_pinout.png
205205
:width: 700
206206

207207
Please note that Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino pin number ``14`` & ``20`` (``SDA`` & ``A4``) are connected with each other
@@ -214,11 +214,11 @@ on the board itself. If you want to use them check out the subsection :ref:`conn
214214
Connected I2S and Analog pins
215215
-----------------------------
216216

217-
For the ``KIT_XMC_PLT2GO_XMC4200``, ``KIT_XMC_PLT2GO_XMC4400`` and ``KIT_XMC47_RELAX_5V_AD_V1`` the Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino
217+
For the ``KIT_XMC_PLT2GO_XMC4200``, ``KIT_XMC_PLT2GO_XMC4400`` and ``KIT_XMC47_RELAX`` the Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino
218218
pin number ``14`` & ``20`` (``SDA`` & ``A4``) are connected with each other on the board itself. Although they are different physical pins of the microcontroller,
219219
they are connected with each other on the board to comply with the original Arduino UNO Rev3 pin connections. This influences analog measurements on
220220
``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:
221-
`KIT_XMC_PLT2GO_XMC4200 user manual`_, `KIT_XMC_PLT2GO_XMC4400 user manual`_ and `KIT_XMC47_RELAX_5V_AD_V1 user manual`_.
221+
`KIT_XMC_PLT2GO_XMC4200 user manual`_, `KIT_XMC_PLT2GO_XMC4400 user manual`_ and `KIT_XMC47_RELAX user manual`_.
222222

223223
The user manual shows on:
224224

@@ -242,14 +242,14 @@ For the ``KIT_XMC_PLT2GO_XMC4400`` by cutting the marked blue routes on the back
242242
.. image:: img/kit_xmc_plt2go_xmc4400_cut_routes.png
243243
:width: 300
244244

245-
For the ``KIT_XMC47_RELAX_5V_AD_V1`` cut the blue routes on the back side of the PCB as indicated here:
245+
For the ``KIT_XMC47_RELAX`` cut the blue routes on the back side of the PCB as indicated here:
246246

247247
.. image:: img/kit_xmc47_relax_cut_routes.jpg
248248
:width: 300
249249

250250
.. _KIT_XMC_PLT2GO_XMC4200 user manual: https://www.infineon.com/dgdl/Infineon-XMC4200_Platform2Go-UserManual-v01_00-EN.pdf?fileId=5546d4626f229553016f8fca76c12c96
251251
.. _KIT_XMC_PLT2GO_XMC4400 user manual: https://www.infineon.com/dgdl/Infineon-XMC4400_Platform2Go-UserManual-v01_00-EN.pdf?fileId=5546d4626f229553016f8fc159482c94
252-
.. _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
252+
.. _KIT_XMC47_RELAX user manual: https://www.infineon.com/dgdl/Infineon-Board_User_Manual_XMC4700_XMC4800_Relax_Kit_Series-UM-v01_02-EN.pdf?fileId=5546d46250cc1fdf01513f8e052d07fc
253253

254254
-----------------------------------------------------------------------
255255

docs/img/KIT_XMC47_RELAX_5V_AD_V1.jpg renamed to docs/img/KIT_XMC47_RELAX.jpg

File renamed without changes.

docs/img/KIT_XMC47_RELAX_5V_AD_V1_pinout.png renamed to docs/img/KIT_XMC47_RELAX_pinout.png

File renamed without changes.

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Welcome to Infineon's XMC Microcontroller Boards for Arduino!
99
.. image:: img/KIT_XMC11_BOOT_001.jpg
1010
:width: 200
1111

12-
.. image:: img/KIT_XMC47_RELAX_5V_AD_V1.jpg
12+
.. image:: img/KIT_XMC47_RELAX.jpg
1313
:width: 200
1414

1515
The XMC microcontroller family from Infineon offers a powerful and versatile platform for embedded system development.

0 commit comments

Comments
 (0)