README_EN.md

This is an automatic translation, may be incorrect in some places. See sources and examples!

Clap

Library is incompatible with the current version of Volanalyzer

Library for recognition of cotton into a microphone (recommended together with VOLANALYZER.H)

• A non -stop survey
• counts the number of cotton

compatibility

Compatible with all arduino platforms (used arduino functions)

Content

• [installation] (# Install)
• [initialization] (#init)
• [use] (#usage)
• [Example] (# Example)
• [versions] (#varsions)
• [bugs and feedback] (#fedback)

Installation

• The library can be found by the name ** clap ** and installed through the library manager in:
  • Arduino ide
  • Arduino ide v2
  • Platformio
• [download the library] (https://github.com/gyverlibs/clap/archive/refs/heads/main.zip) .Zip archive for manual installation:
  • unpack and put in * C: \ Program Files (X86) \ Arduino \ Libraries * (Windows X64)
  • unpack and put in * C: \ Program Files \ Arduino \ Libraries * (Windows X32)
  • unpack and put in *documents/arduino/libraries/ *
  • (Arduino id) Automatic installation from. Zip: * sketch/connect the library/add .Zip library ... * and specify downloaded archive
• Read more detailed instructions for installing libraries [here] (https://alexgyver.ru/arduino-first/#%D0%A3%D1%81%D1%82%D0%B0%BD%D0%BE%BE%BE%BED0%B2%D0%BA%D0%B0_%D0%B1%D0%B8%D0%B1%D0%BB%D0%B8%D0%BE%D1%82%D0%B5%D0%BA)

Update

• I recommend always updating the library: errors and bugs are corrected in the new versions, as well as optimization and new features are added
• through the IDE library manager: find the library how to install and click "update"
• Manually: ** remove the folder with the old version **, and then put a new one in its place.“Replacement” cannot be done: sometimes in new versions, files that remain when replacing are deleted and can lead to errors!

initialization

`CPP CLAP CLAP; `

Usage

`CPP VOID Tick (Int Val);// Call in a magnifying glass, transmit the current volume VOID settrsh (int trsh);// set the volume threshold VOID settimeout (Int Tout);// Set the Timout of the last cotton Bool ISCLAP ();// Cotton check Bool Hasclaps (Uint8_t Claps);// there is a specified number of cotton Bool Hasclaps ();// There are several cotton uint8_t getclaps ();// Get the number of cotton `

Example

`` `CPP // recognition of the number of cotton

#include <volanayzer.h> #include <clap.h>

VOLANALYZER Vol (A0);// microphone on a0 CLAP CLAP;

VOID setup () { Serial.Begin (115200); }

VOID loop () { vol.tick (); CLAP.Tick (vol.getrawmax ()); if (clap.isclap ()) serial.println ("clap"); if (clap.hasclaps (1)) serial.println ("1 class"); if (clap.hasclaps (2)) serial.println ("2 class"); if (clap.hasclaps (3)) serial.println ("3 class"); } `` `

versions

• V1.0

bugs and feedback

Create ** Issue ** when you find the bugs, and better immediately write to the mail [alex@alexgyver.ru] (mailto: alex@alexgyver.ru) The library is open for refinement and your ** pull Request ** 'ow!

When reporting about bugs or incorrect work of the library, it is necessary to indicate:

• Version of the bibliTeki
• What is MK used
• SDK version (for ESP)
• version of Arduino ide
• whether the built -in examples work correctly, in which the functions and designs are used, leading to a bug in your code
• what code has been loaded, what work was expected from it and how it works in reality
• Ideally, attach the minimum code in which the bug is observed.Not a canvas of a thousand lines, but a minimum code