diff --git a/docs/arduino-deviations.rst b/docs/arduino-deviations.rst index 422aaa9f..3775d95c 100644 --- a/docs/arduino-deviations.rst +++ b/docs/arduino-deviations.rst @@ -50,12 +50,14 @@ XMC1400 Kit for Arduino - Interrupt 1 and serial conflict When using the **KIT_XMC1400_ARDUINO** **Interrupt** 1 does not work when serial (UART) is used. The Pin Mapped to **Interrupt 1** shares the **same hardware bus configuration as UART**. -**Impact..** +**Impact:** + - Interrupt will not trigger. - Serial communication also not work. **Workarounds:** -- use a **Interrupt 0" + +- use **Interrupt 0** Wire/I2C Differences ++++++++++++++++++++ @@ -159,14 +161,18 @@ Analog pins for XMC14_2GO ------------------------- On the **XMC14_2GO board**, **pins 12 and 13 are incorrectly named** + - Correct mapping: - -pin 12 -> 'A1' - -pin 13 -> 'A0' + + - pin 12 -> 'A1' + - pin 13 -> 'A0' **Correct Usage:** -Use the analog pin defintions instead of 12 and 13 numbers: - analogRead(A0); //Instead of using pin 12 - analogRead(A1); //Instead of using pin 13 + +Use the analog pin defintions instead of 12 and 13 numbers:: + + analogRead(A0); //Instead of using pin 12 + analogRead(A1); //Instead of using pin 13 I2C Analog pins ^^^^^^^^^^^^^^^ @@ -197,11 +203,11 @@ function, or other case as described below. - | A10 + A11 are alternate pin | configurations to I2C * - KIT_XMC1400_ARDUINO - - Alternate pin function - - Matches Arduino Uno - - External hard wired pins + - | Alternate pin function + | Matches Arduino Uno + | External hard wired pins - | For 3V3 boards set I2C pins to tristate or open drain to use - | 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 + | For 5V boards refer to `this section `_ on track cuts to enable A4 and A5 to work | Level shifter on the 5V board could interfere with tristate/open drain setting * - KIT_XMC47_RELAX (and variants) - External hard wired pins @@ -228,7 +234,7 @@ via the Tools menu as shown in the picture below. :width: 600 This is generally the case for most of the XMC boards. However, for boards -such as the :ref:`xmc4700-relax`, both the serial +such as the :ref:`KIT_XMC47_RELAX`, both the serial output modes are simultaneously active and need not be selected or enabled from the menu. Note: Please note that the sketch must be recompiled when a different serial diff --git a/docs/hw-platforms.rst b/docs/hw-platforms.rst index d2d16f85..e8e2f8a5 100644 --- a/docs/hw-platforms.rst +++ b/docs/hw-platforms.rst @@ -151,7 +151,7 @@ on the board itself. If you want to use them check out the subsection :ref:`conn .. _connected_pins: Connected I2S and Analog pins ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For the ``KIT_XMC47_RELAX`` the Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino pin number ``14`` & ``20`` (``SDA`` & ``A4``) are connected with each other on the board itself. Although they are different physical pins of the microcontroller, @@ -201,6 +201,14 @@ Legacy Microcontroller Boards - :ref:`XMC1300 Sense2GoL` - XMC1300 - Proprietary + * - v3.x + - :ref:`KIT_XMC_PLT2GO_XMC4200` + - XMC4200 + - Arduino Uno, Shield2Go, mikroBUS + * - v3.x + - :ref:`KIT_XMC_PLT2GO_XMC4400` + - XMC4400 + - Arduino Uno, Shield2Go, mikroBUS * - v1.7.0 - :ref:`XMC4700 Radar Baseboard` - XMC4700 @@ -254,6 +262,60 @@ and XMC1300 32-bit ARM® Cortex®-M0 MCU series. ----------------------------------------------------------------------- +.. _KIT_XMC_PLT2GO_XMC4200: + +KIT_XMC_PLT2GO_XMC4200 +---------------------- + +* Name in Arduino IDE: ``XMC4200 Platform 2GO`` +* `Product Page `__ + +.. image:: img/KIT_XMC_PLT2GO_XMC4200.jpg + :width: 400 + +The XMC4200 Platform 2Go evaluation board consists of a XMC4200 microcontroller with a debugger implemented by a XMC4200 microcontroller. +Please note that there exist versions with 5V and 3.3V. Please be careful which version you have and use with your respective shields. +The one described here is the 5V version as this one is compatible with Arduino shields designed for 5V systems. +This kit is equipped with an ARM® Cortex®-M4 based XMC4200 microcontroller with on-board debugger, Ethernet, CAN and footprints for Arduino, +MikroBUS and Shield2Go form factors. + +Pinout Diagram +^^^^^^^^^^^^^^ +.. image:: img/KIT_XMC_PLT2GO_XMC4200_pinout.png + :width: 700 + +Please note that Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino pin number ``14`` & ``20`` (``SDA`` & ``A4``) are connected with each other +on the board itself. If you want to use them check out the subsection :ref:`connected_pins`. + +----------------------------------------------------------------------- + +.. _KIT_XMC_PLT2GO_XMC4400: + +KIT_XMC_PLT2GO_XMC4400 +---------------------- + +* Name in Arduino IDE: ``XMC4400 Platform 2GO`` +* `Product Page `__ + +.. image:: img/KIT_XMC_PLT2GO_XMC4400.jpg + :width: 400 + +The XMC4400 Platform 2Go evaluation board consists of a XMC4400 microcontroller with a debugger implemented by a XMC4200 microcontroller. +Please note that there exist versions with 5V and 3.3V. Please be careful which version you have and use with your respective shields. +The one described here is the 5V version as this one is compatible with Arduino shields designed for 5V systems. +This kit is equipped with an ARM® Cortex®-M4 based XMC4400 microcontroller with on-board debugger, Ethernet, CAN and footprints for Arduino, +MikroBUS and Shield2Go form factors. + +Pinout Diagram +^^^^^^^^^^^^^^ +.. image:: img/KIT_XMC_PLT2GO_XMC4400_pinout.png + :width: 700 + +Please note that Arduino pin number ``15`` & ``21`` (``SCL`` & ``A5``) and Arduino pin number ``14`` & ``20`` (``SDA`` & ``A4``) are connected with each other +on the board itself. If you want to use them check out the subsection :ref:`connected_pins`. + +----------------------------------------------------------------------- + .. _XMC4700 Radar Baseboard: XMC4700 Radar Baseboard diff --git a/docs/requirements.txt b/docs/requirements.txt index 779f6572..74ecfd94 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,7 @@ # This is a list of python packages used to generate documentation. This file is used with pip: # pip install --user -r requirements.txt # -sphinx>=7.2.6 +sphinx>=7.2.6,<9.0.0 sphinx-tabs sphinxemoji sphinx-rtd-theme