arduinoFFT/README.md

67 wiersze
2.5 KiB
Markdown
Czysty Zwykły widok Historia

2014-07-20 00:55:27 +00:00
arduinoFFT
==========
Fast Fourier Transform for Arduino
2014-07-20 01:01:14 +00:00
This is a fork from https://code.google.com/p/makefurt/ which has been abandoned since 2011.
2014-07-20 01:08:55 +00:00
2014-11-09 08:03:01 +00:00
<del>This is a C++ library for Arduino for computing FFT.</del> Now it works both on Arduino and C projects.
2017-04-25 20:26:25 +00:00
Tested on Arduino 1.6.11
2014-07-20 01:08:55 +00:00
2017-04-25 20:26:25 +00:00
### Installation on Arduino
2014-07-20 01:08:55 +00:00
To install this library, just place this entire folder as a subfolder in your Arduino installation
2014-07-20 01:08:55 +00:00
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)
2017-04-25 20:26:25 +00:00
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)
2014-07-20 01:08:55 +00:00
2017-04-25 20:26:25 +00:00
### Building on Arduino
2014-07-20 01:08:55 +00:00
After this library is installed, you just have to start the Arduino application.
You may see a few warning messages as it's built.
To use this library in a sketch, go to the Sketch | Import Library menu and
select arduinoFTT. This will add a corresponding line to the top of your sketch:
2014-07-30 14:41:55 +00:00
`#include <arduinoFTT.h>`
2014-11-09 08:03:01 +00:00
2017-04-25 20:26:25 +00:00
### TODO
* Ratio table for windowing function.
* Document windowing functions advantages and disadvantages.
* Optimize usage and arguments.
* Add new windowing functions.
2017-08-08 01:25:10 +00:00
* Spectrum table?
2017-04-26 13:46:41 +00:00
### API
* **arduinoFFT**(void);
Constructor
* **~arduinoFFT**(void);
Destructor
* **ComplexToMagnitude**(double *vReal, double *vImag, uint16_t samples);
* **Compute**(double *vReal, double *vImag, uint16_t samples, uint8_t dir);
Calculates the power value according to **Exponent** and calcuates the Fast Fourier Transform.
* **Compute**(double *vReal, double *vImag, uint16_t samples, uint8_t power, uint8_t dir);
Calcuates the Fast Fourier Transform.
* **MajorPeak**(double *vD, uint16_t samples, double samplingFrequency);
* **Revision**(void);
Returns the library revision.
* **Windowing**(double *vData, uint16_t samples, uint8_t windowType, uint8_t dir);
Performs a windowing function on the values array. The possible windowing options are:
* FFT_WIN_TYP_RECTANGLE
* FFT_WIN_TYP_HAMMING
* FFT_WIN_TYP_HANN
* FFT_WIN_TYP_TRIANGLE
* FFT_WIN_TYP_BLACKMAN
* FFT_WIN_TYP_FLT_TOP
* FFT_WIN_TYP_WELCH
* **Exponent**(uint16_t value);
Calculates and returns the base 2 logarithm of the given value.