Skip to content

Commit 1ac561c

Browse files
authored
Merge pull request #1373 from arduino/karlsoderby/led-matrix-suggestions
Update led-matrix.md
2 parents 17028ee + fc6730e commit 1ac561c

File tree

1 file changed

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

1 file changed

+57
-17
lines changed

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

Lines changed: 57 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -395,54 +395,94 @@ To write more advanced sketches on your own, you may use the full API of the lib
395395

396396
## Members
397397

398-
**public ArduinoLEDMatrix()**
398+
### `ArduinoLEDMatrix()`
399399

400-
Construct a new `LEDMatrix` object.
400+
Construct a new LED matrix object. This will be used to access the methods in the library.
401401

402-
**public void autoscroll(int32_t interval_ms)**
402+
```
403+
ArduinoLEDMatrix LEDMatrix;
404+
```
405+
406+
407+
### `autoscroll()`
403408

404409
Enable autoscrolling through the frames in a sequence.
405410

411+
406412
**Parameters**
407-
* `interval_ms` Sets the time in milliseconds that should be spent on a frame before switching to the next frame in the sequence.
408413

409-
**public void begin()**
414+
- `interval_ms` Sets the time in milliseconds that should be spent on a frame before switching to the next frame in the sequence.
415+
416+
417+
### `begin()`
410418

411419
Starts the LED matrix.
412420

413-
**public void next()**
421+
```arduino
422+
LEDMatrix.begin()
423+
```
424+
425+
### `next()`
414426

415427
Manually moves to the next frame in the sequence.
416428

417-
**public void loadFrame(const uint32_t buffer[3])**
429+
```
430+
LEDMatrix.next()
431+
```
432+
433+
### `loadFrame()`
434+
435+
Loads a single frame that is not part of a sequence.
418436

419-
loads a single frame that is not part of a sequence.
437+
```arduino
438+
LEDMatrix.loadFrame(buffer[i])
439+
```
420440

421441
**Parameters**
422-
* `buffer[3]` an array of three 32bit integers, where each bit represents an LED.
423442

424-
**public void renderFrame(uint8_t frameNumber)**
443+
- `buffer[3]` an array of three 32bit integers, where each bit represents an LED.
425444

426-
Render a specific frame from a sequence
445+
### `renderFrame()`
427446

428-
**public void loadSequence(const uint32_t frames[][4])**
447+
Render a specific frame from a sequence.
448+
449+
```
450+
LEDMatrix.renderFrame(frameNumber)
451+
```
452+
453+
**Parameters**
454+
455+
- `int` - frame to load.
456+
457+
### `loadSequence()`
429458

430459
Loads an animation sequence into the buffer but does not display it.
431460

461+
```arduino
462+
LEDMatrix.frames[][4]
463+
```
464+
432465
**Parameters**
433-
* `frameNumber` Specifies which frame of the sequence should be rendered.
434466

435-
**public void play(bool loop)**
467+
- `frameNumber` Specifies which frame of the sequence should be rendered.
468+
469+
### `play()`
436470

437471
Starts playing the loaded sequence.
438472

473+
```
474+
LEDMatrix.play(state) //true or false
475+
```
476+
439477
**Parameters**
440-
* `loop` true to enable looping the sequence, false to play once.
441478

442-
**public bool sequenceDone()**
479+
- `loop` true to enable looping the sequence, false to play once.
480+
481+
### `sequenceDone()`
443482

444483
Check for if the sequence is finished playing or if the frame should be advanced another step.
445484

446485
**Returns**
447-
false if the sequence is not finished, true if it is.
486+
487+
- `false` if the sequence is not finished, `true` if it is.
448488

0 commit comments

Comments
 (0)