Skip to content

Commit a08e649

Browse files
santaimpersonatorsantaimpersonator
committed
Update software_overview-arduino.md
Restores default instructions for FastLED library (pull request was merged)
1 parent a51a596 commit a08e649

File tree

1 file changed

+12
-96
lines changed

1 file changed

+12
-96
lines changed

‎docs/software_overview-arduino.md

Lines changed: 12 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -295,101 +295,6 @@ While users are free to choose any Arduino library that provides support for MAX
295295

296296

297297

298-
### WS2812 RGB LED
299-
Users are free to choose any Arduino library that provides support for WS2812 LEDs. However, we recommend the [FastLED Arduino library](https://github.com/FastLED/FastLED/); as it has been tested and verified to work with the RGB LED on the RA6M5 Thing Plus.
300-
301-
302-
!!! warning
303-
While support for the new Renesas Arduino boards has not been officially released for the FastLED Arduino library, the hardware modifications have been integrated into the GitHub repository. Therefore, users can manually download and install the FastLED Arduino library for *unofficial* support of the Renesas Arduino boards.
304-
305-
306-
<div class="grid" markdown>
307-
308-
<div markdown>
309-
310-
!!! tip "Manually Download the Arduino Library"
311-
For users who would like to manually download and install the library, the `*.zip` file can be accessed from the [GitHub repository](https://github.com/FastLED/FastLED/) or downloaded by clicking the button below.
312-
313-
<center>
314-
[:octicons-download-16:{ .heart } Download the Arduino Library](https://github.com/FastLED/FastLED/archive/refs/heads/master.zip){ .md-button .md-button--primary }
315-
</center>
316-
317-
</div>
318-
319-
320-
<div class="grid cards" markdown align="center">
321-
322-
- <a href="https://learn.sparkfun.com/tutorials/15">
323-
<figure markdown>
324-
![Installing an Arduino Library](https://cdn.sparkfun.com/c/264-148/assets/b/e/4/b/2/50f04b99ce395fd95e000001.jpg)
325-
</figure>
326-
327-
---
328-
329-
**Installing an Arduino Library**</a>
330-
331-
</div>
332-
333-
</div>
334-
335-
336-
!!! abstract "Add Support for the RA6M5 Thing Plus"
337-
In addition to manually installing the Arduino library, users will also need to integrate the RA6M5 Thing Plus into the FastLED Arduino library with the [porting instructions](https://github.com/FastLED/FastLED/blob/master/PORTING.md). This requires users to include the {++highlighted lines++} before {==line 94==} in the [`fastpin_arm_renesas.h`](https://github.com/FastLED/FastLED/blob/master/src/platforms/arm/renesas/fastpin_arm_renesas.h#L94) file of the FastLED Arduino library:
338-
339-
340-
??? code "Code Modification"
341-
342-
<div class="language-cpp highlight" markdown>
343-
344-
--8<-- "https://raw.githubusercontent.com/FastLED/FastLED/master/src/platforms/arm/renesas/fastpin_arm_renesas.h:90:92"
345-
{++
346-
#elif defined(ARDUINO_THINGPLUS_RA6M5)
347-
348-
#define MAX_PIN 24
349-
// D0-D06
350-
_FL_DEFPIN( 0, BSP_IO_PORT_01_PIN_12, R_PORT1_BASE ); _FL_DEFPIN( 1, BSP_IO_PORT_04_PIN_06, R_PORT4_BASE ); _FL_DEFPIN( 2, BSP_IO_PORT_04_PIN_05, R_PORT4_BASE );
351-
_FL_DEFPIN( 3, BSP_IO_PORT_04_PIN_04, R_PORT4_BASE ); _FL_DEFPIN( 4, BSP_IO_PORT_04_PIN_03, R_PORT4_BASE ); _FL_DEFPIN( 5, BSP_IO_PORT_04_PIN_02, R_PORT4_BASE );
352-
_FL_DEFPIN( 6, BSP_IO_PORT_02_PIN_07, R_PORT2_BASE );
353-
354-
// D07-D12 (A0-A5)
355-
_FL_DEFPIN( 7, BSP_IO_PORT_00_PIN_14, R_PORT0_BASE ); _FL_DEFPIN( 8, BSP_IO_PORT_00_PIN_15, R_PORT0_BASE ); _FL_DEFPIN( 9, BSP_IO_PORT_05_PIN_05, R_PORT5_BASE );
356-
_FL_DEFPIN(10, BSP_IO_PORT_05_PIN_04, R_PORT5_BASE ); _FL_DEFPIN(11, BSP_IO_PORT_05_PIN_03, R_PORT5_BASE ); _FL_DEFPIN(12, BSP_IO_PORT_05_PIN_02, R_PORT5_BASE );
357-
358-
// D13-D21
359-
_FL_DEFPIN(13, BSP_IO_PORT_01_PIN_05, R_PORT1_BASE ); _FL_DEFPIN(14, BSP_IO_PORT_01_PIN_06, R_PORT1_BASE ); _FL_DEFPIN(15, BSP_IO_PORT_04_PIN_01, R_PORT4_BASE );
360-
_FL_DEFPIN(16, BSP_IO_PORT_04_PIN_00, R_PORT4_BASE ); _FL_DEFPIN(17, BSP_IO_PORT_01_PIN_10, R_PORT1_BASE ); _FL_DEFPIN(18, BSP_IO_PORT_01_PIN_09, R_PORT1_BASE );
361-
_FL_DEFPIN(19, BSP_IO_PORT_01_PIN_11, R_PORT1_BASE ); _FL_DEFPIN(20, BSP_IO_PORT_04_PIN_09, R_PORT4_BASE ); _FL_DEFPIN(21, BSP_IO_PORT_04_PIN_08, R_PORT4_BASE );
362-
363-
// D30-31
364-
_FL_DEFPIN(30, BSP_IO_PORT_03_PIN_04, R_PORT3_BASE ); _FL_DEFPIN(31, BSP_IO_PORT_04_PIN_15, R_PORT4_BASE );
365-
++}
366-
{==#elif defined(ARDUINO_ARCH_RENESAS_PORTENTA)==}
367-
368-
--8<-- "https://raw.githubusercontent.com/FastLED/FastLED/master/src/platforms/arm/renesas/fastpin_arm_renesas.h:96:99"
369-
370-
371-
</div>
372-
373-
374-
!!! info
375-
This information is accurate as of April 2024; however, it may become irrelevant in the future *(once a release is published, with support for the Renesas Arduino boards and RA6M5 Thing Plus)*. At which point, users may disregard this note and/or request for this information to be removed by [filing an issue](../github/file_issue).
376-
377-
378-
379-
!!! tip "How to Define Parameters"
380-
While using the FastLED Arduino library, users need to define the following parameters to the **WS2812 RGB LED** included on the board. However, if additional LEDs are connected externally to the board, then the appropriate values should be provided for the Arduino library.
381-
382-
**`#define NUM_LEDS 1`**
383-
: There is only one WS2812 LED on the board
384-
385-
**`#define DATA_PIN LED_RGB`**
386-
: Declare which pin is connected to the WS2812 LED. On the RA6M5 Thing Plus, it is defined as `D13` or `RGB_LED` in the Arduino core for GPIO `P105`.
387-
388-
**`#define LED_TYPE WS2812`**
389-
: Declare the LED type for the library; the RA6M5 Thing Plus only includes `WS2812` RGB LED on the board.
390-
391-
392-
<!-- Original Instructions (adjust snippet in "software_overview-codeless" when restoring)
393298
### WS2812 RGB LED
394299
While users are free to choose any Arduino library that provides support for WS2812 LEDs, we recommend the [FastLED Arduino library](https://github.com/FastLED/FastLED/). It has been tested and verified to work with the RGB LED on the RA6M5 Thing Plus. The [FastLED Arduino library](https://github.com/FastLED/FastLED/) can be installed from the **Library Manager** in the Arduino IDE by searching for:
395300

@@ -419,9 +324,20 @@ While users are free to choose any Arduino library that provides support for WS2
419324
</div>
420325

421326
</div>
422-
-->
423327

424328

329+
??? tip "How to Define Parameters"
330+
While using the FastLED Arduino library, users need to define the following parameters to the **WS2812 RGB LED** included on the board. However, if additional LEDs are connected externally to the board, then the appropriate values should be provided for the Arduino library.
331+
332+
**`#define NUM_LEDS 1`**
333+
: There is only one WS2812 LED on the board
334+
335+
**`#define DATA_PIN LED_RGB`**
336+
: Declare which pin is connected to the WS2812 LED. On the RA6M5 Thing Plus, it is defined as `D13` or `RGB_LED` in the Arduino core for GPIO `P105`.
337+
338+
**`#define LED_TYPE WS2812`**
339+
: Declare the LED type for the library; the RA6M5 Thing Plus only includes `WS2812` RGB LED on the board.
340+
425341

426342
### DA14531MOD BLE Module
427343
--8<-- "./software-DA14531MOD.md"

0 commit comments

Comments
 (0)