mozzi_analog.h

/*
 * mozzi_analog.h
 *
 * This file is part of Mozzi.
 *
 * Copyright 2012-2024 Tim Barrass and the Mozzi Team
 *
 * Mozzi is licensed under the GNU Lesser General Public Licence (LGPL) Version 2.1 or later.
 *
 */
 
 
#ifndef MOZZI_ANALOG_H_
#define MOZZI_ANALOG_H_
 
#include "Arduino.h"
 
#include "hardware_defines.h"
 
// for setupFastAnalogRead()
enum ANALOG_READ_SPEED {FAST_ADC,FASTER_ADC,FASTEST_ADC};
 
void setupFastAnalogRead(int8_t speed=FAST_ADC);
 
 
 
/*  @ingroup analog
Set up for asynchronous analog input, which enables analog reads to take 
place in the background without blocking the processor.
@param speed FAST_ADC, FASTER_ADC or FASTEST_ADC.  See setupFastAnalogRead();
*/
void setupMozziADC(int8_t speed=FAST_ADC);
 
 
 
inline void disconnectDigitalIn(uint8_t channel_num) {
#if IS_AVR()
    DIDR0 |= 1<<channel_num;
#else
    (void) channel_num; // unused, suppress warning
#endif
}
 
inline void reconnectDigitalIn(uint8_t channel_num) {
#if IS_AVR()
    DIDR0 &= ~(1<<channel_num);
#else
    (void) channel_num; // unused, suppress warning
#endif
}
 
inline void adcDisconnectAllDigitalIns() {
#if IS_AVR()
    for (uint8_t i = 0; i<NUM_ANALOG_INPUTS; i++){
        DIDR0 |= 1<<i;
    }
#endif
}
 
 
inline void adcReconnectAllDigitalIns() {
#if IS_AVR()
    for (uint8_t i = 0; i<NUM_ANALOG_INPUTS; i++){
        DIDR0 &= ~(1<<i);
    }
#endif
}
 
/* @ingroup analog
Starts an analog to digital conversion of the voltage on a specified channel.  Unlike
Arduino's analogRead() function which waits until a conversion is complete before
returning, adcStartConversion() only sets the conversion to begin, so you can use
the cpu for other things and call for the result later with adcGetResult().
@param channel is the analog channel number (0 to ....), which is not necessarily the same as the pin number
Use adcPinToChannelNum() to convert the pin number to its channel number.
@note Timing: about 1us when used in updateControl() with MOZZI_CONTROL_RATE 64.
*/
void adcStartConversion(uint8_t channel);
 
template<byte RES> uint16_t mozziAnalogRead(uint8_t pin);
 
inline uint16_t mozziAnalogRead16(uint8_t pin) { return mozziAnalogRead<16>(pin); };
 
#if defined(FOR_DOXYGEN_ONLY) || defined(MOZZI_ANALOG_READ_RESOLUTION)
inline uint16_t mozziAnalogRead(uint8_t pin) { return mozziAnalogRead<MOZZI_ANALOG_READ_RESOLUTION>(pin); }
#else
MOZZI_DEPRECATED("2.0", "This use of mozziAnalogRead() is not portable. Refer to the API documentation for suggested alternatives.") inline uint16_t mozziAnalogRead(uint8_t pin) { return mozziAnalogRead<MOZZI__INTERNAL_ANALOG_READ_RESOLUTION>(pin); }
#endif
 
uint8_t adcPinToChannelNum(uint8_t pin);
 
 
#endif /* MOZZI_ANALOG_H_ */