Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme for Jlink driver #272

Merged
merged 2 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,17 @@ Additionally, please consult the [releases](https://github.com/Infineon/XMC-for-

### Prework for SEGGER J-Link

In order to use the Infineon XMC microcontrollers by this repository and program them, you need [SEGGER J-Link](https://www.segger.com/downloads/jlink) installed on your PC. Please follow this link [SEGGER J-Link](https://www.segger.com/downloads/jlink) and install the J-Link Software and Documentation Pack for your respective operating system (OS).
If you have already installed '[DAVE™ - Development Platform for XMC™ Microcontrollers](https://www.infineon.com/cms/de/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-registered-cortex-registered-m/dave-version-4-free-development-platform-for-code-generation/channel.html?channel=db3a30433580b37101359f8ee6963814)', you might skip this step as you should have the respective drivers on your system.
![J-Link](https://github.com/infineon/assets/master/Pictures/J-Link_Packages.png)
In order to use Infineon's XMC microcontroller boards in Arduino you need [SEGGER J-Link](https://www.segger.com/downloads/jlink) installed on your machine first. Please follow [this link](https://www.segger.com/downloads/jlink) and install the J-Link Software and Documentation Pack for your respective operating system (OS).

![J-Link](resources/wiki/image/jlink_install.png)

If you are downloading J-Link for the first time, make sure to check this box: Install USB Driver for J-Link.

![J-Link-driver](resources/wiki/image/J-Link_Installer_options_page.png)

### Required tools

XMC-for-Arduino requires Python 3.x and `pyserial`. Make sure Python is installed in your machine and available in the system path.
XMC-for-Arduino requires Python 3.x and `pyserial`. Make sure Python is installed on your machine and available in the system path.

You can check if it was successfully installed by opening your command line or terminal and typing:
```
Expand All @@ -67,11 +71,11 @@ With [pip](https://pip.pypa.io/en/stable/installation/) available, install the m
```

### Integration in Arduino IDE
Please first download the Arduino IDE. This library only tested for Arduino IDE >=1.5, recommended to use Arduino IDE >=2.0.
Please first download the Arduino IDE. This package is only tested for Arduino IDE >=1.5. We recommended to use Arduino IDE >=2.0.

![Preferences](resources/wiki/image/preference.png)

Paste the following URL into the 'Additional Boards Manager URLs' input field under **File** > **Preferences** to add Infineon's microcontroller boards to the Arduino IDE.
Paste the following URL into the 'Additional boards manager URLs' input field under **File** > **Preferences** to add Infineon's XMC microcontroller boards to the Arduino IDE.

https://github.com/Infineon/XMC-for-Arduino/releases/latest/download/package_infineon_index.json

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/wiki/image/jlink_install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.