seesaw_spectrum.h

#ifndef _SEESAW_SPECTRUM_H
#define _SEESAW_SPECTRUM_H

#include "Adafruit_seesaw.h"
#include <Arduino.h>

/**************************************************************************/
/*!
    @brief  Class that stores state and functions for seesaw audio spectrum
             interface
*/
/**************************************************************************/
class seesaw_Audio_Spectrum : public Adafruit_seesaw {
public:
  /**************************************************************************/
  /*!
    @brief  seesaw_Audio_Spectrum class constructor.
    @param  Wi  TwoWire interface this works through.
  */
  /**************************************************************************/
  seesaw_Audio_Spectrum(TwoWire *Wi = NULL) : Adafruit_seesaw(Wi) {}

  ~seesaw_Audio_Spectrum() {}

  /**************************************************************************/
  /*!
    @brief  Begin communication with Seesaw audio spectrum device.
    @param  addr  Optional i2c address where the device can be found.
                  Defaults to SEESAW_ADDRESS.
    @param  flow  Optional flow control pin.
    @return true on success, false on error.
  */
  /**************************************************************************/
  bool begin(uint8_t addr = SEESAW_ADDRESS, int8_t flow = -1) {
    if (Adafruit_seesaw::begin(addr, flow)) {
      memset(bins, 0, sizeof bins);
      return true;
    }
    return false;
  }

  void getData(void);             // Fetch latest audio spectrum data
  void setRate(uint8_t value);    // Set audio sampling rate 0-31
  void setChannel(uint8_t value); // Set ADC input channel
  uint8_t getRate(void);          // Query current audio sampling rate 0-31
  uint8_t getChannel(void);       // Query current ADC channel

  /**************************************************************************/
  /*!
    @brief   Get value of individual spectrum bin, as determined during
             most recent get_data() call.
    @param   idx  Spectrum bin index (0-63) to query.
    @return  Level: 0 (silent) to 255 (loudest) for bin.
  */
  /**************************************************************************/
  uint8_t getLevel(uint8_t idx) const { return bins[idx < 64 ? idx : 63]; }

  /**************************************************************************/
  /*!
    @brief   Get pointer to spectrum bin buffer directly. Use with caution!
    @return  uint8_t base pointer to 64 spectrum bins.
  */
  /**************************************************************************/
  uint8_t *getBuffer(void) const { return (uint8_t *)bins; }

private:
  uint8_t bins[64]; // Audio spectrum "bins"
};

#endif // end _SEESAW_SPECTRUM_H