Skip to content

Commit

Permalink
Merge pull request #303 from Infineon/docs/rtd-staging
Browse files Browse the repository at this point in the history 
First full iteration of the docs migration to rtd
  • Loading branch information
@ederjc
ederjc authored Sep 23, 2024
2 parents 346d23e + dc2d60f commit 36351aa
Show file tree
Hide file tree
Showing 33 changed files with 294 additions and 155 deletions.
50 changes: 26 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,48 @@
# Infineon's XMC Microcontroller Boards for Arduino
# Arduino Core for Infineon's XMC™ Microcontrollers

This repository integrates [Infineon's](https://www.infineon.com/) XMC microcontrollers into the [Arduino IDE](https://www.arduino.cc/en/main/software).
![compile examples badge](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/compile-platform-examples.yml/badge.svg)
![build docs badge](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/docs.yml/badge.svg)

The [XMC microcontroller family](https://www.infineon.com/cms/de/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) from Infineon is a powerful and versatile platform for embedded system development. The XMC for Arduino library provides a comprehensive set of APIs, examples, and tools for developing a wide range of applications, allowing developers to leverage the ease of use and flexibility of the Arduino platform while harnessing the advanced features and performance of the XMC microcontrollers.
This project integrates Infineon's 32-bit XMC™ Industrial Arm® Cortex®-M Microcontroller into the [Arduino](https://www.arduino.cc/en/Guide/Introduction) ecosystem.

The [XMC™ microcontroller family](https://www.infineon.com/cms/de/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) from Infineon is a powerful and versatile platform for embedded system development. The XMC for Arduino core provides a comprehensive set of APIs, examples, and tools for developing a wide range of applications, allowing developers to leverage the ease of use and flexibility of the Arduino platform while harnessing the advanced features and performance of the XMC™ microcontrollers.

## Supported Microcontroller Boards

<table>
<table style="text-align : center">
<tr>
<td><img src="docs/img/KIT_XMC14_2GO.png" width="300"></td>
<td><img src="docs/img/XMC1100_Boot-Kit.jpg" width="300"></td>
<td><img src="docs/img/XMC1400_Arduino_Kit.jpg" width="300"></td>
<td><img src="docs/img/KIT_XMC14_2GO.png" width="200"></td>
<td><img src="docs/img/KIT_XMC11_BOOT_001.jpg" width="200"></td>
<td><img src="docs/img/KIT_XMC1400_ARDUINO.jpg" width="200"></td>
<td><img src="docs/img/KIT_XMC13_BOOT_001.jpg" width="200"></td>
</tr>
<tr>
<td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/?redirId=282145">KIT_XMC14_2GO</a></td>
<td style="test-align : center"><a href="https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/">KIT_XMC11_BOOT_001</a></td>
<td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/">KIT_XMC1400_ARDUINO</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/?redirId=282145">KIT_XMC14_2GO</a></td>
<td><a href="https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/">KIT_XMC11_BOOT_001</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/">KIT_XMC1400_ARDUINO</a></td>
<td><a href="https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc13_boot_001/">KIT_XMC13_BOOT_001</a></td>
</tr>
</table>

<table>
<tr>
<td><img src="docs/img/XMC4200-Platform2go.jpg" width="300"></td>
<td><img src="docs/img/XMC4400-Platform2GO-Kit.jpg" width="300"></td>
<td><img src="docs/img/XMC4700_Relax_Kit_5VShields.jpg" width="300"></td>
<td><img src="docs/img/KIT_XMC_PLT2GO_XMC4200.jpg" width="200"></td>
<td><img src="docs/img/KIT_XMC_PLT2GO_XMC4400.jpg" width="200"></td>
<td><img src="docs/img/KIT_XMC47_RELAX_5V_AD_V1.jpg" width="200"></td>
</tr>
<tr>
<td style="test-align: center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/">KIT_XMC_PLT2GO_XMC4200</a></td>
<td style="test-align: center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/">KIT_XMC_PLT2GO_XMC4400</a></td>
<td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/?redirId=114289">KIT_XMC47_RELAX_5V_AD_V1</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/">KIT_XMC_PLT2GO_XMC4200</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/">KIT_XMC_PLT2GO_XMC4400</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/?redirId=114289">KIT_XMC47_RELAX_5V_AD_V1</a></td>
</tr>
</table>

### Library Installation

In order to get started, please visit the instalation instructions [here](Link Docs Instalation Instructions).
More information about supported boards can be found [here](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html).

## Getting Started

## Additional Information
For installation & getting started instructions please refer to [our docs](https://xmc-arduino.readthedocs.io/en/latest/index.html).

More information can be found within the library [docs] (Link Docs).
## Contributing

We welcome community contributions! Please refer to our [contribution guidelines](CONTRIBUTING.md). Your help is greatly appreciated 👐

## License

Expand Down
38 changes: 19 additions & 19 deletions docs/arduino-variations.rst → docs/arduino-deviations.rst
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Variations from Arduino Standard
================================
Deviations from Arduino Language Reference
==========================================

Functions and Options Differences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Extra modes (if patches applied)
---------------------------------
--------------------------------

This section covers the differences between standard Arduino and XMC-for-Arduino

GPIO
+++++
++++

Extra pinMode types added that most engineers want

Expand All @@ -24,7 +24,7 @@ Extra functions (than standard Arduino AVR)
--------------------------------------------

GPIO
+++++
++++
Does what the function names says but must have been configured as output

.. code-block::
Expand All @@ -35,7 +35,7 @@ Arduino Function Differences
-------------------------------

Input Mode Pins
++++++++++++++++
+++++++++++++++

On standard Arduino boards, GPIO is by default either a function
like Serial or in INPUT mode.
Expand All @@ -45,7 +45,7 @@ to be in INPUT Mode that needs Inputs.


Wire/I2C Differences
+++++++++++++++++++++
++++++++++++++++++++

The method in Wire class for 'begin' is not the same as AVR Arduino,
and has different modes for Master and Slave
Expand All @@ -66,7 +66,7 @@ Currently the address is NOT optional for XMC as this currently assumes this
must be Slave mode configuration and sets the I2C configuration differently.

Tone
++++++
++++

Number of Tone pins is determined by pins_arduino.h define NUM_TONE_PINS.
This allows for use in other modules and for variations between boards as
Expand All @@ -92,7 +92,7 @@ However this does mean you can have more tone pins, just much lower frequency ra


Analog Functions and improvements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

wiring_analog after V1.2.1
-----------------------------
Expand All @@ -106,7 +106,7 @@ current maximum value possible.


Extra functions
----------------
---------------

These functions return the analogue resolution as number of bits

Expand All @@ -127,15 +127,15 @@ The gain factor values can be found :ref:`here <gain_factor>`.


Default Values
----------------
--------------

Read resolution default is 10 bits (0 to 1023)

Write resolution default is 8 bits (0 to 255)


Error and Return Codes by Function
-----------------------------------
----------------------------------

Where possible functions do :command:`NOT` action invalid parameters passed in.

Expand Down Expand Up @@ -189,7 +189,7 @@ This should enable checks in software for valid operation
and debugging problem code.

AREF Analogue Reference
------------------------
-----------------------

On all boards the Analogue Reference is set to use the internal power supply
(however noisy), so the AREF pin is an :command:`OUTPUT` of the AREF in use.
Expand All @@ -214,7 +214,7 @@ the same on these boards.


Analog amplifiers at the ADC inputs with adjustible gain
----------------------------------------------------------
--------------------------------------------------------
Each analog input channel can be configured to be amplified by an adjustable
gain factor, for XMC1000 series. To configure the gain, the gain value is to
be selected in the analogRead_variableGain() function which translates to a
Expand All @@ -241,7 +241,7 @@ For more information, please refer to the application note
`here <https://www.infineon.com/dgdl/Infineon-VADC-XMC1200_XMC1300-AP32304-AN-v01_10-EN.pdf?fileId=5546d4624e765da5014ed981f63136d6>`_.

I2C Analog pins
^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^

Arduino Uno R3 format dictates that A4 and A5 are also used
for I2C operations, so when I2C is enabled analogue inputs A4
Expand Down Expand Up @@ -284,10 +284,10 @@ function, or other case as described below.

Serial selection
^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^

Serial Output Selection
-------------------------
-----------------------
On the XMC boards, two kinds of serial outputs are possible, namely:

* SERIAL DEBUG (via PC)
Expand All @@ -297,7 +297,7 @@ If these two outputs share the same instance of the internal USIC channel,
only one of the two could be used at a given time. The selection can be made
via the Tools menu as shown in the picture below.

.. image:: img/serial_selection.png
.. image:: img/arduino_ide_serial_selection.png
:width: 600

This is generally the case for most of the XMC boards. However, for boards
Expand Down
Loading

0 comments on commit 36351aa

Please sign in to comment.