Skip to content

Commit 119fd1b

Browse files
committed
Update API table
1 parent afedee8 commit 119fd1b

File tree

1 file changed

+17
-34
lines changed
  • content/hardware/02.hero/boards/uno-r4-wifi/tutorials/led-matrix

1 file changed

+17
-34
lines changed

content/hardware/02.hero/boards/uno-r4-wifi/tutorials/led-matrix/led-matrix.md

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -381,21 +381,18 @@ Have fun creating interactive interfaces or animation on your UNO R4 WiFi!
381381

382382
To write more advanced sketches on your own, you may use the full API of the library as found below.
383383

384-
Members | Descriptions
385-
------------------------------------------------------------------------------------------|---------------------------------------------
386-
`public ` [`ArduinoLEDMatrix`](#)`()` | The main class for controlling the LED matrix.
387-
`public void` [`autoscroll`](#)`(int32_t interval_ms)` | Sets the time in ms for each frame to be displayed.
388-
`public void` [`on`](#)`(size_t pin)` | Turn an individual pixel on.
389-
`public void` [`off`](#)`(size_t pin)` | Turn an individual pixel off.
390-
`public void` [`begin`](#)`()` | Start the LED matrix.
391-
`public void` [`next`](#)`()` | Manually move to the next frame in the sequence.
392-
`public void` [`loadFrame`](#)`(const uint32_t buffer[3])` | Load a new single frame that is not in any sequence.
393-
`public void` [`renderFrame`](#)`(uint8:t frameNumber)` | Render the loaded frame.
394-
`public void` [`loadSequence`](#)`(uint8_t *arr)` | Loads the pixels into the buffer but does not display them.
395-
`public void` [`play`](#)`(bool loop = false)` | Start playing the sequence of frames, with the option to loop indefinitely or play once.
396-
`public bool` [`sequenceDone`](#)`()` | checks if the sequence has finished playing.
397-
`public void` [`loadPixels`](#)`(uint8_t *arr, size_t size)` | Loads the pixels into the buffer but does not display them.
398-
`public void` [`loadWrapper`](#)`(`[`const uint32_t frames[][4], uint32_t howMany`](#)`)` | Sets the current frame to number 0 in the sequence.
384+
Members | Descriptions
385+
-------------------------------------------------------------|---------------------------------------------
386+
`public ` [`ArduinoLEDMatrix`](#)`()` | The main class for controlling the LED matrix.
387+
`public void` [`autoscroll`](#)`(int32_t interval_ms)` | Sets the time in ms for each frame to be displayed.
388+
`public void` [`begin`](#)`()` | Start the LED matrix.
389+
`public void` [`next`](#)`()` | Manually move to the next frame in the sequence.
390+
`public void` [`loadFrame`](#)`(const uint32_t buffer[3])` | Load a new single frame that is not in any sequence.
391+
`public void` [`renderFrame`](#)`(uint8:t frameNumber)` | Render the loaded frame.
392+
`public void` [`loadSequence`](#)`(uint8_t *arr)` | Loads the pixels into the buffer but does not display them.
393+
`public void` [`play`](#)`(bool loop = false)` | Start playing the sequence of frames, with the option to loop indefinitely or play once.
394+
`public bool` [`sequenceDone`](#)`()` | checks if the sequence has finished playing.
395+
`public void` [`loadPixels`](#)`(uint8_t *arr, size_t size)` | Loads the pixels into the buffer but does not display them.
399396

400397
## Members
401398

@@ -410,20 +407,6 @@ Enable autoscrolling through the frames in a sequence.
410407
**Parameters**
411408
* `interval_ms` Sets the time in milliseconds that should be spent on a frame before switching to the next frame in the sequence.
412409

413-
414-
**public void on(size_t pin)**
415-
416-
Turn on an individual LED.
417-
418-
**Parameters**
419-
* `pin` Defines which LED should be turned on. Accepted values are 0-95.
420-
**public void off(size_t pin)**
421-
422-
Turn off an individual LED.
423-
424-
**Parameters**
425-
* `pin` Defines which LED should be turned off. Accepted values are 0-95.
426-
427410
**public void begin()**
428411

429412
Starts the LED matrix.
@@ -443,6 +426,10 @@ loads a single frame that is not part of a sequence.
443426

444427
Render a specific frame from a sequence
445428

429+
**public void loadSequence(const uint8_t *arr[][4])**
430+
431+
Sets the current frame to frame 0 in the sequence.
432+
446433
**Parameters**
447434
* `frameNumber` Specifies which frame of the sequence should be rendered.
448435

@@ -467,8 +454,4 @@ Loads the pixels into the frame but does not load them.
467454
**Parameters**
468455
* `arr` Pointer to an array that holds the frame
469456

470-
* `size` the amount of pixels in your frame.
471-
472-
**public void loadWrapper(const uint32_t frames[][4], uint32_t howMany)**
473-
474-
Sets the current frame to frame 0 in the sequence.
457+
* `size` the amount of pixels in your frame.

0 commit comments

Comments
 (0)