Skip to content

Commit 4e290ea

Browse files
committed
docs: Update docs according name change of boards.
Signed-off-by: zhanglinjing <Linjing.Zhang@infineon.com>
1 parent 1e5ba3c commit 4e290ea

3 files changed

Lines changed: 82 additions & 82 deletions

File tree

docs/arduino-deviations.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,20 +158,20 @@ function, or other case as described below.
158158
- | A4 + A5 are separate
159159
| A6 + A7 are alternate pin
160160
| configurations to I2C
161-
* - XMC1300 Boot Kit
161+
* - KIT_XMC13_BOOT_001
162162
- | NOT same pin format
163163
| as Arduino Uno R3
164164
- | A10 + A11 are alternate pin
165165
| configurations to I2C
166-
* - XMC1400 Arduino Kit
166+
* - KIT_XMC1400_ARDUINO
167167
- Alternate pin function
168168
- Matches Arduino Uno
169169
* - XMC4400 Platform 2Go
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-
* - XMC4700 Relax Kit (and variants)
174+
* - KIT_XMC47_RELAX_5V_AD_V1 (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: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,41 @@ Examples Supported
1818
- Boards
1919
- Description
2020
* - DieTemperatureMeasurement
21-
- | XMC1100 XMC 2GO
22-
| XMC1100 Boot Kit
21+
- | KIT_XMC_2GO_XMC1100_V1
22+
| KIT_XMC11_BOOT_001
2323
| XMC1100 H-Bridge 2GO
24-
| XMC1300 Boot Kit
25-
| XMC1400 2GO Kit
26-
| XMC1400 Arduino Kit
27-
| XMC4400 Platform 2Go
28-
| XMC4700 Relax Kit
24+
| KIT_XMC13_BOOT_001
25+
| KIT_XMC14_2GO
26+
| KIT_XMC1400_ARDUINO
27+
| KIT_XMC_PLT2GO_XMC4400
28+
| KIT_XMC47_RELAX_5V_AD_V1
2929
- | Simple die temperature measurement
3030
| for XMC devices which demonstrates
3131
| themeasure temperature of die using
3232
| sensor.
3333
* - HeapMemoryMeasurement
34-
- | XMC1100 XMC 2GO
35-
| XMC1100 Boot Kit
34+
- | KIT_XMC_2GO_XMC1100_V1
35+
| KIT_XMC11_BOOT_001
3636
| XMC1100 H-Bridge 2GO
37-
| XMC1300 Boot Kit
38-
| XMC1400 2GO Kit
39-
| XMC1400 Arduino Kit
40-
| XMC4700 Relax Kit
37+
| KIT_XMC13_BOOT_001
38+
| KIT_XMC14_2GO
39+
| KIT_XMC1400_ARDUINO
40+
| KIT_XMC47_RELAX_5V_AD_V1
4141
- | Simple example to check heap memory
4242
| during run time for XMC devices which
4343
| demonstrates the ability to check on
4444
| free heap memory.
4545
* - SleepModeXMC1100
46-
- | XMC1100 XMC 2GO
47-
| XMC1100 Boot Kit
46+
- | KIT_XMC_2GO_XMC1100_V1
47+
| KIT_XMC11_BOOT_001
4848
| XMC1100 H-Bridge 2GO
49-
| XMC1300 Boot Kit
50-
| XMC1400 2GO Kit
51-
| XMC1400 Arduino Kit
49+
| KIT_XMC13_BOOT_001
50+
| KIT_XMC14_2GO
51+
| KIT_XMC1400_ARDUINO
5252
- | Demonstrates the use of an alarm to
5353
| wake up an xmc1100 from sleep mode.
5454
* - SleepModeXMC4700
55-
- | XMC4700 Relax Kit
55+
- | KIT_XMC47_RELAX_5V_AD_V1
5656
- | Simple Sleep Mode for XMC4700
5757
| Relax Kit V1 demonstrates the use of
5858
| an alarm to wake up an XMC4700 from
@@ -64,12 +64,12 @@ Examples Supported
6464
| mode, LED2 will stop blinking, until
6565
| device wakes up.
6666
* - StackMemoryMeasurement
67-
- | XMC1100 XMC 2GO
68-
| XMC1100 Boot Kit
67+
- | KIT_XMC_2GO_XMC1100_V1
68+
| KIT_XMC11_BOOT_001
6969
| XMC1100 H-Bridge 2GO
70-
| XMC1300 Boot Kit
71-
| XMC4400 Platform 2Go
72-
| XMC4700 Relax Kit
70+
| KIT_XMC13_BOOT_001
71+
| KIT_XMC_PLT2GO_XMC4400
72+
| KIT_XMC47_RELAX_5V_AD_V1
7373
- | Simple example to check stack memory
7474
| during run time for XMC devices which
7575
| demonstrates the ability to check on
@@ -88,11 +88,11 @@ Examples Supported
8888
- Boards
8989
- Description
9090
* - DMA_Memory
91-
- | XMC4700 Relax Kit
91+
- | KIT_XMC47_RELAX_5V_AD_V1
9292
- | Demonstrates how to setup an DMA, to transfer
9393
| data between two places in memory.
9494
* - DMA_UART
95-
- | XMC4700 Relax Kit
95+
- | KIT_XMC47_RELAX_5V_AD_V1
9696
- | Demonstrates how to setup an DMA, to transfer
9797
| data between two places in memory.
9898
@@ -108,11 +108,11 @@ RTC Library
108108
- Boards
109109
- Description
110110
* - AlarmRTC
111-
- XMC4700 Relax Kit
111+
- KIT_XMC47_RELAX_5V_AD_V1
112112
- | Demonstrates how to set an RTC alarm for the
113-
| XMC4700 Relax Kit V1.
113+
| KIT_XMC47_RELAX_5V_AD_V1 V1.
114114
* - SimpleRTC
115-
- XMC4700 Relax Kit
115+
- KIT_XMC47_RELAX_5V_AD_V1
116116
- Demonstrates the use of the RTC library for the XMC4700.
117117

118118

@@ -127,14 +127,14 @@ SPI Library
127127
- Description
128128
* - | SPI_MOSI_to_MISO
129129
| _SameDevice
130-
- | XMC1100 XMC 2GO
131-
| XMC1100 Boot Kit
130+
- | KIT_XMC_2GO_XMC1100_V1
131+
| KIT_XMC11_BOOT_001
132132
| XMC1100 H-Bridge 2GO
133-
| XMC1300 Boot Kit
134-
| XMC1400 2GO Kit
135-
| XMC1400 Arduino Kit
136-
| XMC4400 Platform 2Go
137-
| XMC4700 Relax Kit
133+
| KIT_XMC13_BOOT_001
134+
| KIT_XMC14_2GO
135+
| KIT_XMC1400_ARDUINO
136+
| KIT_XMC_PLT2GO_XMC4400
137+
| KIT_XMC47_RELAX_5V_AD_V1
138138
- | SPI example which communicates between the
139139
| MOSI and MISO pin of the same board. Connect
140140
| the MOSI pin to the MOSI pin as hardware
@@ -151,14 +151,14 @@ Wire Library
151151
- Boards
152152
- Description
153153
* - master_reader
154-
- | XMC1100 XMC 2GO
155-
| XMC1100 Boot Kit
154+
- | KIT_XMC_2GO_XMC1100_V1
155+
| KIT_XMC11_BOOT_001
156156
| XMC1100 H-Bridge 2GO
157-
| XMC1300 Boot Kit
158-
| XMC1400 2GO Kit
159-
| XMC1400 Arduino Kit
160-
| XMC4400 Platform 2Go
161-
| XMC4700 Relax Kit
157+
| KIT_XMC13_BOOT_001
158+
| KIT_XMC14_2GO
159+
| KIT_XMC1400_ARDUINO
160+
| KIT_XMC_PLT2GO_XMC4400
161+
| KIT_XMC47_RELAX_5V_AD_V1
162162
- | Demonstrates use of the Wire library. Reads data
163163
| from an I2C/TWI slave device. Refer to the "Wire Slave
164164
| Sender" example for use with this. Then it
@@ -167,14 +167,14 @@ Wire Library
167167
| pins of one board to the SDA and SCL pin of the
168168
| other board.
169169
* - master_writer
170-
- | XMC1100 XMC 2GO
171-
| XMC1100 Boot Kit
170+
- | KIT_XMC_2GO_XMC1100_V1
171+
| KIT_XMC11_BOOT_001
172172
| XMC1100 H-Bridge 2GO
173-
| XMC1300 Boot Kit
174-
| XMC1400 2GO Kit
175-
| XMC1400 Arduino Kit
176-
| XMC4400 Platform 2Go
177-
| XMC4700 Relax Kit
173+
| KIT_XMC13_BOOT_001
174+
| KIT_XMC14_2GO
175+
| KIT_XMC1400_ARDUINO
176+
| KIT_XMC_PLT2GO_XMC4400
177+
| KIT_XMC47_RELAX_5V_AD_V1
178178
- | Demonstrates use of the Wire library. Writes data to
179179
| an I2C/TWI slave device. Refer to the "Wire Slave
180180
| Receiver" example for use with this. Then it
@@ -183,14 +183,14 @@ Wire Library
183183
| pins of one board to the SDA and SCL pin of the
184184
| other board.
185185
* - slave_receiver
186-
- | XMC1100 XMC 2GO
187-
| XMC1100 Boot Kit
186+
- | KIT_XMC_2GO_XMC1100_V1
187+
| KIT_XMC11_BOOT_001
188188
| XMC1100 H-Bridge 2GO
189-
| XMC1300 Boot Kit
190-
| XMC1400 2GO Kit
191-
| XMC1400 Arduino Kit
192-
| XMC4400 Platform 2Go
193-
| XMC4700 Relax Kit
189+
| KIT_XMC13_BOOT_001
190+
| KIT_XMC14_2GO
191+
| KIT_XMC1400_ARDUINO
192+
| KIT_XMC_PLT2GO_XMC4400
193+
| KIT_XMC47_RELAX_5V_AD_V1
194194
- | Demonstrates use of the Wire library. Receives data as
195195
| an I2C/TWI slave device. Refer to the "Wire Slave
196196
| Writer" example for use with this. Then it
@@ -199,14 +199,14 @@ Wire Library
199199
| pins of one board to the SDA and SCL pin of the
200200
| other board.
201201
* - slave_sender
202-
- | XMC1100 XMC 2GO
203-
| XMC1100 Boot Kit
202+
- | KIT_XMC_2GO_XMC1100_V1
203+
| KIT_XMC11_BOOT_001
204204
| XMC1100 H-Bridge 2GO
205-
| XMC1300 Boot Kit
206-
| XMC1400 2GO Kit
207-
| XMC1400 Arduino Kit
208-
| XMC4400 Platform 2Go
209-
| XMC4700 Relax Kit
205+
| KIT_XMC13_BOOT_001
206+
| KIT_XMC14_2GO
207+
| KIT_XMC1400_ARDUINO
208+
| KIT_XMC_PLT2GO_XMC4400
209+
| KIT_XMC47_RELAX_5V_AD_V1
210210
- | Demonstrates use of the Wire library. Receives data as
211211
| an I2C/TWI slave device. Refer to the "Wire Master
212212
| Reader" example for use with this. Then it
@@ -219,7 +219,7 @@ Wire Library
219219
I2S Library
220220
^^^^^^^^^^^
221221

222-
This library has been tested with the IM69D130 Microphone Shield2Go with both XMC4700 Relax Kit and XMC1100 XMC2Go.
222+
This library has been tested with the IM69D130 Microphone Shield2Go with both KIT_XMC47_RELAX_5V_AD_V1 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

docs/hw-platforms.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ The following XMC microcontroller boards are supported by XMC for Arduino:
4747
KIT_XMC11_BOOT_001
4848
------------------
4949

50-
* Name in Arduino IDE: ``XMC1100 Boot Kit``
50+
* Legacy name: ``XMC1100 Boot Kit``
5151
* `Product Page <https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/>`__
5252

5353
.. image:: img/KIT_XMC11_BOOT_001.jpg
5454
:width: 400
5555

56-
The XMC1100 Boot Kit board consists of a XMC1100 microcontroller with a debugger implemented by a XMC4200 microcontroller.
56+
The KIT_XMC11_BOOT_001 board consists of a XMC1100 microcontroller with a debugger implemented by a XMC4200 microcontroller.
5757
The board shares the same power supply and board shape as other shields for Arduino.
5858

5959
Pinout Diagram
@@ -71,7 +71,7 @@ nor share the same pins/resources. This is different from the original Arduino U
7171
KIT_XMC13_BOOT_001
7272
------------------
7373

74-
* Name in Arduino IDE: ``XMC1300 Boot Kit``
74+
* Legacy name: ``XMC1300 Boot Kit``
7575
* `Product Page <https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc13_boot_001/>`__
7676

7777
.. image:: img/KIT_XMC13_BOOT_001.jpg
@@ -86,13 +86,13 @@ XMC1302 Microcontroller in TSSOP-38 with 200KB Flash and full peripheral set of
8686
KIT_XMC14_2GO
8787
-------------
8888

89-
* Name in Arduino IDE: ``XMC1400 XMC2GO``
89+
* Legacy name: ``XMC1400 XMC2GO``
9090
* `Product Page <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/>`__
9191

9292
.. image:: img/KIT_XMC14_2GO.png
9393
:width: 400
9494

95-
The XMC1400 Kit 2Go provides an easy way to evaluate almost all capabilities of the XMC1400 microcontroller.
95+
The KIT_XMC14_2GO provides an easy way to evaluate almost all capabilities of the XMC1400 microcontroller.
9696
The kit is powered via USB, interfaces to other Infineon sensor boards and provides multiple interfaces including a
9797
CAN bus. The software development is supported via ModusToolbox™ and the Arduino IDE.
9898

@@ -109,13 +109,13 @@ Pinout Diagram
109109
KIT_XMC1400_ARDUINO
110110
-------------------
111111

112-
* Name in Arduino IDE: ``XMC1400 Kit for Arduino``
112+
* Legacy name: ``XMC1400 Kit for Arduino``
113113
* `Product Page <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/>`__
114114

115115
.. image:: img/KIT_XMC1400_ARDUINO.jpg
116116
:width: 400
117117

118-
The XMC1400 Kit for Arduino consists of a XMC1400 microcontroller with a debugger implemented by a XMC4200 microcontroller.
118+
The KIT_XMC1400_ARDUINO consists of a XMC1400 microcontroller with a debugger implemented by a XMC4200 microcontroller.
119119
The board shares the same power supply and board shape as other shields for Arduino.
120120

121121
Pinout Diagram
@@ -134,13 +134,13 @@ Arduino UNO Rev3 implementation. Please look at the pinout diagram for more info
134134
KIT_XMC_PLT2GO_XMC4200
135135
----------------------
136136

137-
* Name in Arduino IDE: ``XMC4200 Platform 2GO``
137+
* Legacy name: ``XMC4200 Platform 2GO``
138138
* `Product Page <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/>`__
139139

140140
.. image:: img/KIT_XMC_PLT2GO_XMC4200.jpg
141141
:width: 400
142142

143-
The XMC4200 Platform 2Go evaluation board consists of a XMC4200 microcontroller with a debugger implemented by a XMC4200 microcontroller.
143+
The _KIT_XMC_PLT2GO_XMC4200 board consists of a XMC4200 microcontroller with a debugger implemented by a XMC4200 microcontroller.
144144
Please note that there exist versions with 5V and 3.3V. Please be careful which version you have and use with your respective shields.
145145
The one described here is the 5V version as this one is compatible with Arduino shields designed for 5V systems.
146146
This kit is equipped with an ARM® Cortex®-M4 based XMC4200 microcontroller with on-board debugger, Ethernet, CAN and footprints for Arduino,
@@ -161,13 +161,13 @@ on the board itself. If you want to use them check out the subsection :ref:`conn
161161
KIT_XMC_PLT2GO_XMC4400
162162
----------------------
163163

164-
* Name in Arduino IDE: ``XMC4400 Platform 2GO``
164+
* Legacy name: ``XMC4400 Platform 2GO``
165165
* `Product Page <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/>`__
166166

167167
.. image:: img/KIT_XMC_PLT2GO_XMC4400.jpg
168168
:width: 400
169169

170-
The XMC4400 Platform 2Go evaluation board consists of a XMC4400 microcontroller with a debugger implemented by a XMC4200 microcontroller.
170+
The KIT_XMC_PLT2GO_XMC4400 board consists of a XMC4400 microcontroller with a debugger implemented by a XMC4200 microcontroller.
171171
Please note that there exist versions with 5V and 3.3V. Please be careful which version you have and use with your respective shields.
172172
The one described here is the 5V version as this one is compatible with Arduino shields designed for 5V systems.
173173
This kit is equipped with an ARM® Cortex®-M4 based XMC4400 microcontroller with on-board debugger, Ethernet, CAN and footprints for Arduino,
@@ -188,13 +188,13 @@ on the board itself. If you want to use them check out the subsection :ref:`conn
188188
KIT_XMC47_RELAX_5V_AD_V1
189189
------------------------
190190

191-
* Name in Arduino IDE: ``XMC4700 Relax Kit``
191+
* Legacy name: ``KIT_XMC47_RELAX_5V_AD_V1``
192192
* `Product Page <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/>`__
193193

194194
.. image:: img/KIT_XMC47_RELAX_5V_AD_V1.jpg
195195
:width: 400
196196

197-
The XMC4700 Relax Kit board consists of a XMC4700 microcontroller with a debugger implemented by a XMC4200 microcontroller.
197+
The KIT_XMC47_RELAX_5V_AD_V1 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.
@@ -286,7 +286,7 @@ KIT_XMC_2GO_XMC1100_V1
286286
----------------------
287287

288288
* Replaced by :ref:`KIT_XMC14_2GO`
289-
* Name in Arduino IDE: ``XMC1100 XMC2Go``
289+
* Legacy name: ``XMC1100 XMC2Go```
290290

291291
The XMC1100 2Go board consists of a XMC1100 microcontroller with a debugger implemented by a XMC4200 microcontroller.
292292

0 commit comments

Comments
 (0)