sfDevBuzzer.h

Go to the documentation of this file.

 
#pragma once
 
#include "sfDevBuzzerPitches.h"
#include "sfDevBuzzerRegisters.h"
 
#include <stdint.h>
 
// include the sparkfun toolkit headers
#include <sfTk/sfToolkit.h>
 
// Bus interfaces
#include <sfTk/sfTkII2C.h>
 
#define SFE_QWIIC_BUZZER_DEFAULT_ADDRESS 0x34
#define SFE_QWIIC_BUZZER_DEVICE_ID 0x5E
#define SFE_QWIIC_BUZZER_RESONANT_FREQUENCY 2730
#define SFE_QWIIC_BUZZER_VOLUME_OFF 0
#define SFE_QWIIC_BUZZER_VOLUME_MIN 1
#define SFE_QWIIC_BUZZER_VOLUME_LOW 2
#define SFE_QWIIC_BUZZER_VOLUME_MID 3
#define SFE_QWIIC_BUZZER_VOLUME_MAX 4
 
class sfDevBuzzer
{
  public:
    sfDevBuzzer() : _theBus{nullptr}
    {
    }
 
    sfTkError_t begin(sfTkII2C *theBus = nullptr);
 
    sfTkError_t isConnected();
 
    sfTkError_t deviceId(uint8_t &deviceId);
 
    bool firmwareVersionMajor(uint8_t &versionMajor);
 
    bool firmwareVersionMinor(uint8_t &versionMinor);
 
    sfTkError_t configureBuzzer(const uint16_t toneFrequency = SFE_QWIIC_BUZZER_RESONANT_FREQUENCY,
                                const uint16_t duration = 0, const uint8_t volume = 4);
 
    sfTkError_t on();
 
    sfTkError_t off();
 
    sfTkError_t saveSettings();
 
    sfTkError_t setAddress(const uint8_t &address);
 
    uint8_t address();
 
    bool playSoundEffect(const uint8_t soundEffectNumber, const uint8_t volume);
 
  private:
    sfTkError_t soundEffect0(const uint8_t volume);
 
    sfTkError_t soundEffect1(const uint8_t volume);
 
    sfTkError_t soundEffect2(const uint8_t volume);
 
    sfTkError_t soundEffect3(const uint8_t volume);
 
    sfTkError_t soundEffect4(const uint8_t volume);
 
    sfTkError_t soundEffect5(const uint8_t volume);
 
    sfTkError_t soundEffect6(const uint8_t volume);
 
    sfTkError_t soundEffect7(const uint8_t volume);
 
    sfTkError_t soundEffect8(const uint8_t volume);
 
    sfTkError_t soundEffect9(const uint8_t volume);
 
  protected:
    sfTkII2C *_theBus;
};