kopia lustrzana https://github.com/kosme/arduinoFFT
Minor fixes to documentation
rodzic
55ec80ebe0
commit
0a3bcad5d2
16
README.md
16
README.md
|
@ -7,25 +7,22 @@ This is a fork from https://code.google.com/p/makefurt/ which has been abandoned
|
||||||
|
|
||||||
<del>This is a C++ library for Arduino for computing FFT.</del> Now it works both on Arduino and C projects.
|
<del>This is a C++ library for Arduino for computing FFT.</del> Now it works both on Arduino and C projects.
|
||||||
|
|
||||||
Tested on Arduino 1.0.5
|
Tested on Arduino 1.6.11
|
||||||
|
|
||||||
Installation on Arduino
|
### Installation on Arduino
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
To install this library, just place this entire folder as a subfolder in your Arduino installation
|
To install this library, just place this entire folder as a subfolder in your Arduino installation
|
||||||
|
|
||||||
|
|
||||||
When installed, this library should look like:
|
When installed, this library should look like:
|
||||||
|
|
||||||
Arduino\libraries\arduinoFTT (this library's folder)
|
Arduino\libraries\arduinoFTT (this library's folder)
|
||||||
Arduino\libraries\arduinoFTT\arduinoFTT.cpp (the library implementation file, uses 32 bits floats vectors)
|
Arduino\libraries\arduinoFTT\arduinoFTT.cpp (the library implementation file, uses 32 bits floats vectors)
|
||||||
Arduino\libraries\arduinoFTT\arduinoFTT.h (the library description file, uses 32 bits floats vectors)
|
Arduino\libraries\arduinoFTT\arduinoFTT.h (the library header file, uses 32 bits floats vectors)
|
||||||
Arduino\libraries\arduinoFTT\keywords.txt (the syntax coloring file)
|
Arduino\libraries\arduinoFTT\keywords.txt (the syntax coloring file)
|
||||||
Arduino\libraries\arduinoFTT\examples (the examples in the "open" menu)
|
Arduino\libraries\arduinoFTT\examples (the examples in the "open" menu)
|
||||||
Arduino\libraries\arduinoFTT\readme.md (this file)
|
Arduino\libraries\arduinoFTT\readme.md (this file)
|
||||||
|
|
||||||
Building on Arduino
|
### Building on Arduino
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
After this library is installed, you just have to start the Arduino application.
|
After this library is installed, you just have to start the Arduino application.
|
||||||
You may see a few warning messages as it's built.
|
You may see a few warning messages as it's built.
|
||||||
|
@ -35,3 +32,8 @@ select arduinoFTT. This will add a corresponding line to the top of your sketch
|
||||||
|
|
||||||
`#include <arduinoFTT.h>`
|
`#include <arduinoFTT.h>`
|
||||||
|
|
||||||
|
### TODO
|
||||||
|
* Ratio table for windowing function.
|
||||||
|
* Document windowing functions advantages and disadvantages.
|
||||||
|
* Optimize usage and arguments.
|
||||||
|
* Add new windowing functions.
|
||||||
|
|
|
@ -36,7 +36,7 @@
|
||||||
#include "types.h"
|
#include "types.h"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#define FFT_LIB_REV 0x02a
|
#define FFT_LIB_REV 0x02c
|
||||||
/* Custom constants */
|
/* Custom constants */
|
||||||
#define FFT_FORWARD 0x01
|
#define FFT_FORWARD 0x01
|
||||||
#define FFT_REVERSE 0x00
|
#define FFT_REVERSE 0x00
|
||||||
|
|
Ładowanie…
Reference in New Issue