Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ArminJo committed Mar 26, 2019
1 parent 23de59e commit ff888cd
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 9 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ The original **SCANNER** pattern is extended and includes the **CYLON** as well

# Installation
First you need to install "Adafruit NeoPixel" library with *Sketch -> Include Library -> Manage Librarys...*. Use "neoPixel" as filter string.
Then download NeoPatterns.zip file or use the GitHub *clone or download -> Download ZIP* button, and add the .zip file with *Sketch -> Include Library -> add .ZIP Library...*.

Then use the GitHub *clone or download -> Download ZIP* button, and add the .zip file with *Sketch -> Include Library -> add .ZIP Library...*.

### All pixel mappings except NEO_MATRIX_COLUMNS supported
In case you need `NEO_MATRIX_COLUMNS` layout, try to rotate your Matrix and use `NEO_MATRIX_ROWS` or use your own custom mapping function.
Expand Down
2 changes: 1 addition & 1 deletion examples/TwoPatternsOnOneStrip/TwoPatternsOnOneStrip.ino
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

#include <Arduino.h>

//#include "ArduinoUtils.h"
#include "ArduinoUtils.h"
#include <NeoPatterns.h>

#define VERSION_EXAMPLE "1.0"
Expand Down
Binary file removed extras/NeoPatterns.zip
Binary file not shown.
22 changes: 20 additions & 2 deletions src/MatrixNeoPixel.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
/*
* MatrixNeoPixel.h
*
* Created on: 20.02.2019
* Author: Armin
* Implements basic functions for NeoPixel matrix. Tested with 8x8 matrix.
*
* Copyright (C) 2019 Armin Joachimsmeyer
* [email protected]
*
* This file is part of NeoPatterns https://github.com/ArminJo/NeoPatterns.
*
* NeoPatterns is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
*
*/

#ifndef SRC_LIB_NEOPATTERNS_MATRIXNEOPIXEL_H_
Expand Down
22 changes: 20 additions & 2 deletions src/NeoPixel.cpp
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
/*
* NeoPixel.cpp
*
* Created on: 21.02.2019
* Author: Armin
* Implements extensions to Adafruit_NeoPixel functions
*
* Copyright (C) 2019 Armin Joachimsmeyer
* [email protected]
*
* This file is part of NeoPatterns https://github.com/ArminJo/NeoPatterns.
*
* NeoPatterns is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
*
*/

#include "NeoPixel.h"
Expand Down
22 changes: 20 additions & 2 deletions src/NeoPixel.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
/*
* NeoPixel.h
*
* Created on: 21.02.2019
* Author: Armin
* Implements extensions to Adafruit_NeoPixel functions
*
* Copyright (C) 2019 Armin Joachimsmeyer
* [email protected]
*
* This file is part of NeoPatterns https://github.com/ArminJo/NeoPatterns.
*
* NeoPatterns is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
*
*/

#ifndef SRC_LIB_NEOPATTERNS_NEOPIXEL_H_
Expand Down

0 comments on commit ff888cd

Please sign in to comment.