From 0a3bcad5d232c1a4fff1d72a2b0a6480bc9c81f9 Mon Sep 17 00:00:00 2001 From: Enrique Condes Date: Tue, 25 Apr 2017 15:26:25 -0500 Subject: [PATCH] Minor fixes to documentation --- README.md | 16 +++++++++------- arduinoFFT.h | 2 +- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8039271..f890862 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,22 @@ This is a fork from https://code.google.com/p/makefurt/ which has been abandoned This is a C++ library for Arduino for computing FFT. 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 - When installed, this library should look like: 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.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\examples (the examples in the "open" menu) 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. 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 ` +### TODO +* Ratio table for windowing function. +* Document windowing functions advantages and disadvantages. +* Optimize usage and arguments. +* Add new windowing functions. diff --git a/arduinoFFT.h b/arduinoFFT.h index e509e9f..59d9e75 100644 --- a/arduinoFFT.h +++ b/arduinoFFT.h @@ -36,7 +36,7 @@ #include "types.h" #endif -#define FFT_LIB_REV 0x02a +#define FFT_LIB_REV 0x02c /* Custom constants */ #define FFT_FORWARD 0x01 #define FFT_REVERSE 0x00