Skip to content

Latest commit

 

History

History
162 lines (112 loc) · 6.72 KB

README.md

File metadata and controls

162 lines (112 loc) · 6.72 KB
Raw

[ENGLISH]

Breath

Breath es una librería que facilita el uso del sensor de presión (MPS20N0040D - HX710B) para la detección de soplo en proyectos como instrumentos electrónicos de viento (EWI).

Características

  • Codigo optimizado para obtener lecturas rapidas.
  • Creado para Leer valores de soplo con el sensor (MPS20N0040D - HX710B), no funciona para obtener valores de presion.
  • Calibración automática del valor inicial del sensor a 0.
  • Ajuste de sensibilidad mediante un factor de resistencia.
  • Configuración de límites de lectura y de salida máxima para adaptarse a las necesidades del proyecto.

Requisitos

  • Placa: Probado en placas Esp32, Esp32-S2, Esp32-C3 y Esp32-S3
  • Sensor: (MPS20N0040D - HX710B)
  • IDE de Arduino: Recomendado 1.8.10 o superior

Instalación

  1. Descarga el archivo ZIP de la librería desde GitHub.
  2. En el IDE de Arduino, ve a Sketch > Include Library > Add .ZIP Library....
  3. Selecciona el archivo ZIP descargado para instalar la librería.

O tambien puedes Extraer el archivo ZIP del paso 1 en tu directorio de librerías de Arduino.

Codigo de ejemplo

#include <Breath.h>
#define OUTPUT_PIN 13
#define CLOCK_PIN 12
Breath breath(OUTPUT_PIN, CLOCK_PIN);

void setup() {
  Serial.begin(115200);
  breath.setResistance(3);  // Ajustar la resistencia de soplo (1 = mínima, 5 = máxima).
  breath.setMaxOut(127);    // Establecer el valor máximo de salida.
}

void loop() {
  int16_t breathValue = breath.read();
  Serial.println(breathValue);
  delay(100);
}

API

Constructor

Breath(byte output_pin, byte clock_pin): Inicializa la clase Breath con el pin de salida de datos del sensor y el pin de reloj.

Métodos

  • int16_t read(): Lee el valor del sensor, aplica la calibración y devuelve un valor ajustado que varía entre 0 y el valor máximo configurado.
  • void setResistance(uint8_t level): Ajusta la sensibilidad del sensor, donde level puede ser un valor de 1 (mínima resistencia) a 5 (máxima resistencia).
  • void setMaxOut(uint8_t maxOut): Define el valor máximo de salida que se obtendrá al leer el sensor.
  • void setMaxRead(uint16_t mRead): Establece el límite superior de la lectura antes de aplicar el ajuste de salida.

Notas

  • El sensor de presión MPS20N0040D necesita una alimentación estable y debe ser conectado adecuadamente al ESP32.
  • La librería incluye una función para ajustar la resistencia de soplo, permitiendo adaptarla a diferentes niveles de sensibilidad según la necesidad del proyecto.
  • Los valores que establescas por medio de las funciones setMaxOut y setMaxRead afectan la sensibilidad y resistencia
  • El valor recomendado para setMaxOut es 127 ya que es el maximo que se envia como parametro de velocidad segun el estandar MIDI
  • El valor recomendaddo para setMaxRead es 255 pero puede ajustarse en un rango de 200 a 500, puedes probar con cual funciona mejor.

Ejemplos

En la carpeta de examples del repositorio, encontrarás ejemplos adicionales que muestran cómo utilizar la librería Breath con el ESP32.

Contribuciones

Las contribuciones son bienvenidas. Si encuentras un problema o tienes una sugerencia, por favor abre un issue o envía un pull request.

[SPANISH]

Breath

Breath is a library that facilitates the use of the (MPS20N0040D - HX710B) pressure sensor for blow detection in projects such as electronic wind instruments (EWI).

Characteristics

  • Code optimized for fast readings.
  • Created to read breath values ​​with the (MPS20N0040D - HX710B) sensor, it does not work to obtain pressure values.
  • Automatic calibration of the initial sensor value to 0.
  • Sensitivity adjustment using a resistance factor.
  • Setting read and maximum output limits to suit project needs.

Requirements

  • Board : Tested on Esp32, Esp32-S2, Esp32-C3 and Esp32-S3 boards
  • Sensor : (MPS20N0040D - HX710B)
  • Arduino IDE : Recommended 1.8.10 or higher

Instalation

  1. Download the library ZIP file from GitHub .
  2. In the Arduino IDE, go to Sketch > Include Library > Add .ZIP Library... .
  3. Select the downloaded ZIP file to install the library.

Or you can extract the ZIP file from step 1 into your Arduino libraries directory.

Sample code

#include <Breath.h>
#define OUTPUT_PIN 13
#define CLOCK_PIN 12
Breath breath(OUTPUT_PIN, CLOCK_PIN);

void setup() {
  Serial.begin(115200);
  breath.setResistance(3);  // Ajustar la resistencia de soplo (1 = mínima, 5 = máxima).
  breath.setMaxOut(127);    // Establecer el valor máximo de salida.
}

void loop() {
  int16_t breathValue = breath.read();
  Serial.println(breathValue);
  delay(100);
}

API

Builder

Breath(byte output_pin, byte clock_pin): Initializes the Breath class with the sensor data output pin and the clock pin.

Methods

  • int16_t read(): Reads the sensor value, applies calibration, and returns an adjusted value ranging from 0 to the maximum configured value.
  • void setResistance(uint8_t level): Sets the sensitivity of the sensor, where level can be a value from 1 (minimum resistance) to 5 (maximum resistance).
  • void setMaxOut(uint8_t maxOut): Defines the maximum output value that will be obtained when reading the sensor.
  • void setMaxRead(uint16_t mRead): Sets the upper limit of the read before applying output adjustment.

NOTES

  • The MPS20N0040D pressure sensor needs a stable power supply and must be properly connected to the ESP32.
  • The library includes a function to adjust the blowing resistance, allowing it to be adapted to different sensitivity levels according to the needs of the project.
  • The values ​​you set using the setMaxOut and setMaxRead functions affect the sensitivity and resistance
  • The recommended value for setMaxOut is 127 as it is the maximum that is sent as a velocity parameter according to the MIDI standard.
  • The recommended value for setMaxRead is 255 but it can be adjusted in a range from 200 to 500, you can try which one works best.

Examples

In the examples folder of the repository, you will find additional examples that show how to use the Breath library with the ESP32.

Contributions

Contributions are welcome. If you find a problem or have a suggestion, please open an issue or send a pull request.