GY-63_MS5611/libraries/AsyncAnalog/README.md
2021-01-29 12:31:58 +01:00

43 lines
1.6 KiB
Markdown

[![Arduino CI](https://github.com/RobTillaart/AsyncAnalog/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/AsyncAnalog/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/AsyncAnalog.svg?maxAge=3600)](https://github.com/RobTillaart/AsyncAnalog/releases)
# AsyncAnalog
Arduino Library for async reading of an analog pin. **\[AVR ONLY\]**
## Description
AsyncAnalog is a library to read the analog port in an asynchronous way.
This means that the user must explicitly **start** the ADC, check if it is **ready**
and read out its **value**.
By using this class, the user prevents the (~112 uSec) blocking of the
**analogRead()** call, and gives the user the ability to do some processing.
The library works only for AVR boards now, other platforms might be supported in the future.
As the UNO has only one ADC that is multiplexed, one can only read one analog pin
in async way simultaneously.
## Interface
- **AsyncAnalog(uint8_t pin)** constructor, defines the analog pin to use.
The library consists of three main function:
- **void start()** triggers a new ADC reading.
- **bool ready()** returns true if sample is complete
- **int value()** returns the value
## Operation
The example **asyncAnalogTest2.ino** shows a loop of 1000 analogReads and prints
over Serial at 115200 baud. The async test does this in less time. Note that faster
baudrates shows an even bigger difference.
During the printing, the sampling continues.