From 484affee0703a6e9984fff971ec104e5217dac43 Mon Sep 17 00:00:00 2001 From: SparkFun Automated Action <36016723+santaimpersonator@users.noreply.github.com> Date: Thu, 30 May 2024 15:26:01 -0600 Subject: [PATCH] Update software_overview-arduino.md Update instructions in response to: https://github.com/sparkfun/SparkFun_Thing_Plus_RA6M5/issues/5 --- docs/software_overview-arduino.md | 46 +++++++++++++++++++++++-------- 1 file changed, 34 insertions(+), 12 deletions(-) diff --git a/docs/software_overview-arduino.md b/docs/software_overview-arduino.md index 9cb8bcb..23052b4 100644 --- a/docs/software_overview-arduino.md +++ b/docs/software_overview-arduino.md @@ -53,10 +53,15 @@ Most users should already be familiar with the Arduino IDE and its use. However, ### Installation !!! success "Installing the *Ported* Renesas-Arduino Core" - In order to program the RA6M5 Thing Plus in the Arduino IDE, users will need to install the **Renesas-Arduino core**. However, until the [RA6M5 Thing Plus is officially adopted into the Renesas-Arduino core](https://github.com/arduino/ArduinoCore-renesas/pull/290), users need to utilize [our port of the **Renesas-Arduino core**](./assets/SFE-Renesas-Arduino_core.zip). + In order to program the RA6M5 Thing Plus in the Arduino IDE, users will need to install the **Arduino Renesas Portenta board** definitions from the Renesas-Arduino core. However, until the [RA6M5 Thing Plus is officially adopted into the Renesas-Arduino core](https://github.com/arduino/ArduinoCore-renesas/pull/290), users need to utilize [our port of the **Renesas-Arduino core**](./assets/SFE-Renesas-Arduino_core.zip). - 1. Before users can install our ported version of the Renesas-Arduino core, they should first install the [*official* Renesas-Arduino core](https://github.com/arduino/ArduinoCore-renesas) in the Arduino IDE. + 1. Before users can install our ported version of the Renesas-Arduino core, they should first install the **Arduino Renesas Portenta board** definitions of the [*official* Renesas-Arduino core](https://github.com/arduino/ArduinoCore-renesas) in the Arduino IDE. - This will ensure that any required compilation and upload tools are installed for the Arduino core. + - In the Board Manager of the Arduino IDE, select and install the **Arduino Renesas Portenta board** definitions from the [Renesas-Arduino core](https://github.com/arduino/ArduinoCore-renesas). +
+ [![Install the Renesas-Arduino Core](./assets/img/hookup_guide/arduino-renesas_core.png){ width="400" }](./assets/img/hookup_guide/arduino-renesas_core.png "Click to enlarge") +
Installing the [Renesas-Arduino core](https://github.com/arduino/ArduinoCore-renesas) in the Arduino IDE.
+
2. Once installed, users will need to locate the `packages` directory for the Arduino cores in the Arduino IDE:
@@ -67,13 +72,13 @@ Most users should already be familiar with the Arduino IDE and its use. However, On Windows, the directory location may vary based on whether the Arduino IDE was installed for an individual user or all users: - - The user's `AppData` directory *(hidden folder)*: + - The user's `AppData` directory *(hidden folder - primary)*: C:\Users\{====}\AppData\Local\Arduino15\packages - - The user's `ArduinoData` directory: + - The user's `ArduinoData` directory (*local*): - C:\Users\{====}\Documents\ArduinoData + C:\Users\{====}\Documents\Arduino\hardware - The `Program Files` or `Program Files(x86)` directories: @@ -86,13 +91,13 @@ Most users should already be familiar with the Arduino IDE and its use. However, With Mac OS, users should check the `Applications` and `Library` directories: - - `Applications` directory: + - `Library` directory (primary): - /Applications/Arduino.app/ + ~/Library/Arduino15/packages/ - - `Library` directory: + - `Applications` directory (*local*): - ~/Library/Arduino15/packages/ + /Applications/Arduino.app/hardware - **Linux** @@ -101,14 +106,31 @@ Most users should already be familiar with the Arduino IDE and its use. However, For Linux, this may be located in the following directories: + - Primary: + + /home/$USER/.arduino15/packages + - Local: - /home/$USER/Arduino + /home/$USER/Arduino/hardware - - Downloaded: + ??? tip + As mentioned in [Arduino's guide for installing the Arduino IDE on Linux](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/#linux), users may need to run the following commands in the terminal: - /home/$USER/.arduino15/packages + ```bash + sudo add-apt-repository universe + sudo apt install libfuse2 + ``` + + In order to utilize the serial terminal or recognize the board in DFU mode, users may also need to run the following commands in the terminal: + + ```bash + usermod -a -G dialout $USERNAME + usermod -a -G plugdev $USERNAME + ``` + - `$USERNAME` is the login username + - After, a restart or logout is required