Skip to content

Commit

Permalink
minor fixes and rc3
Browse files Browse the repository at this point in the history
  • Loading branch information
noah1510 committed Feb 16, 2021
1 parent 5400142 commit caa370b
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = LedController
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 2.0.0-rc2
PROJECT_NUMBER = 2.0.0-rc3

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
4 changes: 2 additions & 2 deletions doc/pages/movement.doc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Index 0 of the row corresponds to row 0 of the Matrix, in other words the left s
The function will retun a ByteRow with the same length as the input.
The returned ByteRow is the Row that was shifted out as because of the movement.

Check [LedControllerDemoRocketMulti.ino](@ref LedControllerDemoRocketMulti.ino) to see how this can be implemented.
Check [Led-matrix-rocket-multi.ino](@ref Led-matrix-rocket-multi.ino) to see how this can be implemented.


\~german
Expand Down Expand Up @@ -102,6 +102,6 @@ Index 0 der ByteRow entspricht der Zeile 0 der Matrix , in anderen Worten das Se
Die Funktion gibt eine ByteRow mit der gleichen Länge wie die Eingabe zurück.
Der Rückgabewert entspricht der Rausgeschobenen Zeile.

Schaue [LedControllerDemoRocketMulti.ino](@ref LedControllerDemoRocketMulti.ino) an um zu sehen wie dies implementiert werden kann.
Schaue [Led-matrix-rocket-multi.ino](@ref Led-matrix-rocket-multi.ino) an um zu sehen wie dies implementiert werden kann.

*/
4 changes: 2 additions & 2 deletions doc/pages/multi_row.doc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When you create a new LedController object it is required to specifiy the dimens
For this example the type of the LedController would be `LedController<4,2>` because there are 4 columns and 2 rows.
These dimensions can be an arbitary size as long as you have enough memory (you will notice if you don't have enough).

The example [LedControllerDemoRocketMulti](@ref LedControllerDemoRocketMulti.ino) will be used to demonstrate each of the parts that need to be done.
The example [LedControllerDemoRocketMulti](@ref Led-matrix-rocket-multi.ino) will be used to demonstrate each of the parts that need to be done.

\section valid_multi_conf Creating a valid controller_configuration

Expand Down Expand Up @@ -75,7 +75,7 @@ Wenn ein neues LedController objekt erstellt wird, müssen die Dimensionen der m
In diesem Beispiel wäre der Datentyp des LedController `LedController<4,2>`, da es 4 Splaten und 2 Zeilen hat.
Die Dimensionen können beliebig groß sein, solang man genug Arbeitsspeicher und Hardware besitzt.

Das Beispiel [LedControllerDemoRocketMulti](@ref LedControllerDemoRocketMulti.ino) wird genutzt um zu zeigen wie man mehrere Zeilen nutzt.
Das Beispiel [LedControllerDemoRocketMulti](@ref Led-matrix-rocket-multi.ino) wird genutzt um zu zeigen wie man mehrere Zeilen nutzt.

\section valid_multi_conf Erstellen einer gültigen controller_configuration

Expand Down
4 changes: 2 additions & 2 deletions doc/pages/usage.doc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This is used to configure the setup of the LedController which can get complex.
controller_configuration has no constructor and is more like an struct with methods than it is a 'real' class.
Because it is a template you need to know the dimension of your Matrix which causes the type to be `controller_configuration<sements_x,segments_y>`.
To see how you can use more than one row with the LedController go [here](@ref multi_row).
The rest of the example will use `controller_configuration<4,1>` like in the [rocket example](@ref LedControllerDemoRocket.ino).
The rest of the example will use `controller_configuration<4,1>` like in the [rocket example](@ref Led-matrix-rocket.ino).

If you want to use Hardware Spi set useHardwareSpi to true, otherwise set it to false.
If you use hardware SPI you only need to specify the CS pin, if not you also need to CLK and MOSI pins.
Expand Down Expand Up @@ -118,7 +118,7 @@ controller_configuration hat keinen Konstruktor und ist dadurch mehr wie ein str
Weil alle Klassen der Bibliothek ein template sind müssen die Dimensionen der Matrix angegeben werden.
Dadurch wird der Datentyp der controller_configuration `controller_configuration<Segmente_x,Segmente_y>`.
Um zu sehen wie man mehrere Zeilen mit einem LedController steuern kann schau [diese](@ref multi_row) Seite an.
Der Rest der Seite wird `controller_configuration<4,1>` verwenden wie im [Beispiel Rakete](@ref LedControllerDemoRocket.ino).
Der Rest der Seite wird `controller_configuration<4,1>` verwenden wie im [Beispiel Rakete](@ref Led-matrix-rocket.ino).

Wenn Hardware SPI verwendet werden soll muss useHardwareSpi auf true gesetzt werden, ansonsten auf false.
Falls hardware SPI verwendet wird dann muss nur der CS pin angegeben werden, ansonsten wird noch der CLK und MOSI pin benötigt.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
/**
* @file Led-matrix-rocket-hwSPI.ino
* @author Noa Sakurajin ([email protected])
* @brief LedControllerDemoRocket.ino with hardware spi
* @brief Led-matrix-rocket.ino with hardware spi
* @version 0.1
* @date 2020-12-30
*
* @copyright Copyright (c) 2020
*
*/

//Since this is just LedControllerDemoRocket.ino with hardware SPI, view its site for more details.
//Since this is just Led-matrix-rocket.ino with hardware SPI, view its site for more details.
#include "LedController.hpp"

#define CS 15
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ void setup(){

}

//This is basically the same as LedControllerDemoRocket.ino
//This is basically the same as Led-matrix-rocket.ino
void loop(){
lc.clearMatrix();

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
/**
* @file Led-matrix-rocket-hwSPI.ino
* @author Noa Sakurajin ([email protected])
* @brief LedControllerDemoRocket.ino with hardware spi
* @brief Led-matrix-rocket.ino with hardware spi
* @version 0.1
* @date 2020-12-30
*
* @copyright Copyright (c) 2020
*
*/

//Da dieses Beispiel einfach LedControllerDemoRocket.ino mit hardware SPI ist, schau auf dessen Seite für Details.
//Da dieses Beispiel einfach Led-matrix-rocket.ino mit hardware SPI ist, schau auf dessen Seite für Details.
#include "LedController.hpp"

#define CS 15
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ void setup(){

}

//Das ist mehr oder weniger identisch zu LedControllerDemoRocket.ino
//Das ist mehr oder weniger identisch zu Led-matrix-rocket.ino
void loop(){
lc.clearMatrix();

Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=LedController
version=2.0.0-rc2
version=2.0.0-rc3
author=Noa Sakurajin <[email protected]>
maintainer=Noa Sakurajin <[email protected]>
sentence=The better LedControl library for the MAX7219 and the MAX7221 Led display drivers.
Expand Down
24 changes: 22 additions & 2 deletions src/LedController_template.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -1134,10 +1134,30 @@ class LedController {
* @example Led-matrix-counting.ino
*
* \~english
* An example on how to use the LedController to create a counter.
* An example on how to use the LedController to create a counter usind a Led Matrix.
*
* \~german
* Ein Beispiel wie man den LedController nutzen kann um einen Zähler zu erstellen.
* Ein Beispiel wie man den LedController nutzen kann um einen Zähler mit einer Led Matrix zu erstellen.
*/

/**
* @example Led-matrix-message.ino
*
* \~english
* An example on how to use the LedController to display a message.
*
* \~german
* Ein Beispiel wie man den LedController nutzen kann um eine Nachricht auszugeben.
*/

/**
* @example 7-Segment-counting.ino
*
* \~english
* An example on how to use the LedController to create a counter using 7-Segment displays.
*
* \~german
* Ein Beispiel wie man den LedController nutzen kann um einen Zähler mit 7-Segment Anzeigen zu erstellen.
*/

/**
Expand Down

0 comments on commit caa370b

Please sign in to comment.