Merge pull request #8 from adafruit/action

Action

Author: ladyada

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,46 @@
+Thank you for opening an issue on an Adafruit Arduino library repository.  To
+improve the speed of resolution please review the following guidelines and
+common troubleshooting steps below before creating the issue:
+
+- **Do not use GitHub issues for troubleshooting projects and issues.**  Instead use
+  the forums at http://forums.adafruit.com to ask questions and troubleshoot why
+  something isn't working as expected.  In many cases the problem is a common issue
+  that you will more quickly receive help from the forum community.  GitHub issues
+  are meant for known defects in the code.  If you don't know if there is a defect
+  in the code then start with troubleshooting on the forum first.
+
+- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
+  check all of the steps and commands to run have been followed.  Consult the
+  forum if you're unsure or have questions about steps in a guide/tutorial.
+
+- **For Arduino projects check these very common issues to ensure they don't apply**:
+
+  - For uploading sketches or communicating with the board make sure you're using
+    a **USB data cable** and **not** a **USB charge-only cable**.  It is sometimes
+    very hard to tell the difference between a data and charge cable!  Try using the
+    cable with other devices or swapping to another cable to confirm it is not
+    the problem.
+
+  - **Be sure you are supplying adequate power to the board.**  Check the specs of
+    your board and plug in an external power supply.  In many cases just
+    plugging a board into your computer is not enough to power it and other
+    peripherals.
+
+  - **Double check all soldering joints and connections.**  Flakey connections
+    cause many mysterious problems.  See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints.
+
+  - **Ensure you are using an official Arduino or Adafruit board.** We can't
+    guarantee a clone board will have the same functionality and work as expected
+    with this code and don't support them.
+
+If you're sure this issue is a defect in the code and checked the steps above
+please fill in the following fields to provide enough troubleshooting information.
+You may delete the guideline and text above to just leave the following details:
+
+- Arduino board:  **INSERT ARDUINO BOARD NAME/TYPE HERE**
+
+- Arduino IDE version (found in Arduino -> About Arduino menu):  **INSERT ARDUINO
+  VERSION HERE**
+
+- List the steps to reproduce the problem below (if possible attach a sketch or
+  copy the sketch code in too): **LIST REPRO STEPS BELOW**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+Thank you for creating a pull request to contribute to Adafruit's GitHub code!
+Before you open the request please review the following guidelines and tips to
+help it be more easily integrated:
+
+- **Describe the scope of your change--i.e. what the change does and what parts
+  of the code were modified.**  This will help us understand any risks of integrating
+  the code.
+
+- **Describe any known limitations with your change.**  For example if the change
+  doesn't apply to a supported platform of the library please mention it.
+
+- **Please run any tests or examples that can exercise your modified code.**  We
+  strive to not break users of the code and running tests/examples helps with this
+  process.
+
+Thank you again for contributing!  We will try to test and integrate the change
+as soon as we can, but be aware we have many GitHub repositories to manage and
+can't immediately respond to every request.  There is no need to bump or check in
+on a pull request (it will clutter the discussion of the request).
+
+Also don't be worried if the request is closed or not integrated--sometimes the
+priorities of Adafruit's GitHub code (education, ease of use) might not match the
+priorities of the pull request.  Don't fret, the open source community thrives on
+forks and GitHub makes it easy to keep your changes in a forked repo.
+
+After reviewing the guidelines above you can delete this text from the pull request.

.github/workflows/githubci.yml

@@ -0,0 +1,32 @@
+name: Arduino Library CI
+
+on: [pull_request, push, repository_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: test platforms
+      run: python3 ci/build_platform.py trinket_m0 metro_m0 metro_m4 cpx_ada
+
+    - name: clang
+      run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r . 
+
+    - name: doxygen
+      env:
+        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
+        PRETTYNAME : "Adafruit ZeroFFT Library"
+      run: bash ci/doxy_gen_and_deploy.sh

.travis.yml

@@ -20,11 +20,19 @@
 
 #include <Arduino.h>
 
-#define FFT_BIN(num, fs, size) (num*((float)fs/(float)size)) ///< return the center frequency of FFT bin 'num' based on the sample rate and FFT stize
-#define FFT_INDEX(freq, fs, size) ((int)((float)freq/((float)fs/(float)size))) ///< return the bin index where the specified frequency 'freq' can be found based on the passed sample rate and FFT size
+#define FFT_BIN(num, fs, size)                                                 \
+  (num *                                                                       \
+   ((float)fs / (float)size)) ///< return the center frequency of FFT bin 'num'
+                              ///< based on the sample rate and FFT stize
+#define FFT_INDEX(freq, fs, size)                                              \
+  ((int)((float)freq /                                                         \
+         ((float)fs /                                                          \
+          (float)size))) ///< return the bin index where the specified frequency
+                         ///< 'freq' can be found based on the passed sample
+                         ///< rate and FFT size
 
 #ifndef ALIGN4
-#define ALIGN4 __attribute__ ((aligned (4))) ///< align to 4 bytes
+#define ALIGN4 __attribute__((aligned(4))) ///< align to 4 bytes
 #endif
 
 #ifndef q15_t
@@ -42,26 +50,29 @@
 #define ZERO_FFT_MAX 4096 ///< the maximum allowed FFT size
 
 #ifdef __cplusplus
-extern "C"{
+extern "C" {
 #endif // __cplusplus
 
 /**************************************************************************/
 /*!
     @brief  run an FFT on an int16_t array. Note that this is run in place.
     @param source the data to FFT
-    @param length the length of the data. This must be a power of 2 and less than or equal to ZERO_FFT_MAX
+    @param length the length of the data. This must be a power of 2 and less
+   than or equal to ZERO_FFT_MAX
     @return 0 on success, -1 on failure
-    @note The FFT is run in place on the data. A hanning window is applied to the input data. The complex portion is discarded, and the real values are returned.
+    @note The FFT is run in place on the data. A hanning window is applied to
+   the input data. The complex portion is discarded, and the real values are
+   returned.
 */
 /**************************************************************************/
 extern int ZeroFFT(q15_t *source, uint16_t length);
 
-extern const q15_t window_hanning_16[]; ///< a hanning window of length 16
-extern const q15_t window_hanning_32[]; ///< a hanning window of length 32
-extern const q15_t window_hanning_64[]; ///< a hanning window of length 64
-extern const q15_t window_hanning_128[]; ///< a hanning window of length 128
-extern const q15_t window_hanning_256[]; ///< a hanning window of length 256
-extern const q15_t window_hanning_512[]; ///< a hanning window of length 512
+extern const q15_t window_hanning_16[];   ///< a hanning window of length 16
+extern const q15_t window_hanning_32[];   ///< a hanning window of length 32
+extern const q15_t window_hanning_64[];   ///< a hanning window of length 64
+extern const q15_t window_hanning_128[];  ///< a hanning window of length 128
+extern const q15_t window_hanning_256[];  ///< a hanning window of length 256
+extern const q15_t window_hanning_512[];  ///< a hanning window of length 512
 extern const q15_t window_hanning_1024[]; ///< a hanning window of length 1024
 extern const q15_t window_hanning_2048[]; ///< a hanning window of length 2048
 extern const q15_t window_hanning_4096[]; ///< a hanning window of length 4096