How to add Bitvoicer added to particle library

mtnbkrrick · April 29, 2016, 1:45am

Can someone help to include this arduino library to the spark library? Below is the .cpp then at the bottom half there is the code for the .h Lastly the keywords at the very bottom. Thank you so much in advance!

/*
  BitVoicer.cpp - Implements serial communication with the BitVoicer.
  Created by BitSophia Software Ltd., Dcember 03, 2012.
  Realeased into public domain.
*/

#include "Arduino.h"
#include "wiring_private.h"
#include "BitVoicer11.h"

//Class constructor
//Receives an integer indicating the serial port to be used
BitVoicerSerial::BitVoicerSerial()
{
  //Sets all public variables to NULL, engine status to stopped
  //and the analog voltage reference
  byteData = NULL;
  charData = NULL;
  intData = NULL;
  strData= "";
  cmdData = NULL;
  engineRunning = false;
  _bvAnalogReference = BV_DEFAULT;
}

//Retrieves data from serial buffer and stores it in the
//correct public variable.
//Returns the received data type (byte) or ZERO if corrupted
//data is received or if no data is available
byte BitVoicerSerial::getData()
{
  //Creates internal variables
  byte dataType = 0;
  byte dataLength = 0;
  int bytesAvailable = 0;
  
  //Gives Arduino a time to finish receiving serial
  //data. This delay can be reduced at faster reading
  //speeds or when receiving small datagrams
  if (Serial.available() > 0)
  {
    delay(100);
    bytesAvailable = Serial.available();
  }
  
  //If the received data is smaller than the minimum datagram
  //size or the first byte is not the start of transmission
  //mark, NO operation is performed
  if (bytesAvailable >= 5 && Serial.peek() == 1)
  {
    //Reads the start of transmission mark
    Serial.read();
    //Reads and stores the data type
    dataType = Serial.read();
    //Reads and stores the data length
    dataLength = Serial.read();
    
    //Reads and stores the data for the expected length
    for (int i = 0; i < dataLength; i++)
      _data[i] = Serial.read();
    
    //If the end os transmission mark is not found,
    //returns data type to zero. All data will be
    //disregarded
    if (Serial.read() != 4)
    {
      dataType = 0;
    }
    else
    {
      //Sets the data in the temporary buffer to the correct
      //public variable
      setData(dataType, dataLength);
      //Returns the retrived data type
      return dataType;
    }
  }
  
  //Clears the serial buffer until the start of transmission
  //mark is found and there is 5 bytes available
  for (int i = 0; i < bytesAvailable; i++)
  {
    if (Serial.peek() == 1 && Serial.available() < 5)
      Serial.read();
    else if (Serial.peek() == 1 && Serial.available() >= 5)
      break;
    else
      Serial.read();
  }
  
  //returns ZERO because:
  //- No data was available or
  //- Corrupted data has been received or
  //- The received datagram is invalid
  return dataType;
}

//Retrieves data from _data and sets the 
//respective public variables
void BitVoicerSerial::setData(byte dataType, int dataLength)
{
  //Validates passed variables
  if (dataType == 0 || dataLength <= 0)
  {
    byteData = NULL;
    charData = NULL;
    intData = NULL;
    strData= "";
    cmdData = NULL;
    return;
  }
  
  //Selects the correct procedure for each data type,
  //retrieves the data from internal buffer and
  //sets it in the correct variable
  switch (dataType)
  {
    //Case byte
    case BV_BYTE:
      //Sets byte public variable to the first byte in the
      //internal buffer
      byteData = _data[0];
      charData = NULL;
      intData = NULL;
      strData= "";
      cmdData = NULL;
      break;
    //Case char
    case BV_CHAR:
      byteData = NULL;
      //Sets char public variable to the converted first byte
      //in the internal buffer
      charData = char(_data[0]);
      intData = NULL;
      strData= "";
      cmdData = NULL;
      break;
    //Case int
    case BV_INT:
      byteData = NULL;
      charData = NULL;
      //Converts 2 bytes from internal buffer into
      //Arduino 16 bits int and sets int public variable
      intData = _data[0] | (_data[1] << 8);
      strData= "";
      cmdData = NULL;
      break;
    //Case String
    case BV_STR:
      byteData = NULL;
      charData = NULL;
      intData = NULL;
      strData = "";
      
      //Loops the internal buffer and concatenates the
      //data into the string public variable
      for (int i = 0; i < dataLength; i++)
        strData += char(_data[i]);

      cmdData = NULL;
      break;
    //Case command
    case BV_COMMAND:
      byteData = NULL;
      charData = NULL;
      intData = NULL;
      strData = "";
      //Sets command public variable to the first byte in the
      //internal buffer
      cmdData = _data[0];
      break;
    //Case status
    case BV_STATUS:
      //Checks the received status data and sets the engine
      //status public variable
      engineRunning = _data[0];
  }

}

//Signals the BitVoicer's recognition engine to start or stop
//processing audio streams
void BitVoicerSerial::startStopListening()
{
  //The start/stop signal
  byte signal[] = {255, 255, 255, 255, 0, 0, 0, 0};
  //Sends the signal to the serial port
  for (int i = 0; i < 8; i++)
    Serial.write(signal[i]);
}

//Fast reads the analog input port and sends the result
//to BitVoicer. It receives a delay value that can be used
//to equalize the stream rate
void BitVoicerSerial::processAudio(unsigned int wait)
{
  //Delays the execution for the passed time (microseconds)
  if (wait > 0)
    delayMicroseconds(wait);
  
  //Starts the ADC conversion  
  sbi(ADCSRA, ADSC);
  //Whaits for the ADC convertion to finish
  while (bit_is_set(ADCSRA, ADSC));
  //Sends the 8 bit result to BitVoicer
  Serial.write(ADCH);
}

//Changes the analog voltage reference on the board
//Do NOT use arduino constants when calling this function!!!
//You may end up burning your board
void BitVoicerSerial::setAnalogReference(uint8_t mode)
{
  _bvAnalogReference = mode;
}

//Sets up the microcontroller to perform faster analog 
//conversions on the specified pin
void BitVoicerSerial::setAudioInput(uint8_t pin)
{
  //Check if the pin value is in the accepted range
  if (pin > 5)
    return;
  
  //Sets the analog reference (high two bits of ADMUX),
  //selects the pin (low 4 bits) and sets ADLAR to left-adjust
  //the reslt (writes 1 to ADLAR)
  ADMUX = ((_bvAnalogReference << 5) | (pin & 0x07));
  //Sets the ADC clock to a faster clock
  //Since an 8 bit resolution is sufficient, it does not affect
  //the ADC accuracy
  sbi(ADCSRA, ADPS2);
  sbi(ADCSRA, ADPS1);  
  cbi(ADCSRA, ADPS0);
}

//Returns the ADC and ADMUX to their original settings
void BitVoicerSerial::undoAudioInput()
{
  ADMUX = 0x00;
  sbi(ADCSRA, ADPS2);
  sbi(ADCSRA, ADPS1);  
  sbi(ADCSRA, ADPS0);
}

//BitVoicerSerial.sendToBV()
//Aceita byte, char, int, string
//////////////////////////////////////////////
//Wraps one byte in the BitVoicer Protocol and
//sends it to BitVoicer
void BitVoicerSerial::sendToBV(uint8_t b)
{
  Serial.write(1);
  Serial.write(BV_BYTE);
  Serial.write(1);
  Serial.write(b);
  Serial.write(4);
}

//Wraps one char in the BitVoicer Protocol and
//sends it to BitVoicer
void BitVoicerSerial::sendToBV(char c)
{
  Serial.write(1);
  Serial.write(BV_CHAR);
  Serial.write(1);
  Serial.write((byte)c);
  Serial.write(4);
}

//Wraps one int in the BitVoicer Protocol and
//sends it to BitVoicer
void BitVoicerSerial::sendToBV(int n)
{
  Serial.write(1);
  Serial.write(BV_INT);
  Serial.write(2);
  Serial.write((byte)(n & 0XFF));
  Serial.write((byte)((n >> 8) & 0XFF));
  Serial.write(4);
}

//Wraps a String object in the BitVoicer Protocol and
//sends it to BitVoicer
void BitVoicerSerial::sendToBV(String s)
{
  Serial.write(1);
  Serial.write(BV_STR);
  Serial.write(s.length());
  
  for (int i = 0; i < s.length(); i++)
    Serial.write((byte)s.charAt(i));
  
  Serial.write(4);
}

/*
  BitVoicer.h - Implements serial communication with the BitVoicer.
  Created by BitSophia Software Ltd., December 03, 2012.
  Realeased into public domain.
*/

#ifndef BitVoicer11_h
#define BitVoicer11_h

#include "Arduino.h"

//Internal BitVoicerSerial buffer
#define BUFFER_SIZE = 64;

//Analog reference constants
#define BV_DEFAULT 3
#define BV_EXTERNAL 1

//Defines BitVoicer constants
#define BV_UNDEFINED 0
#define BV_CHAR 1
#define BV_INT 2
#define BV_BYTE 3
#define BV_STR 4
#define BV_COMMAND 254
#define BV_STATUS 255
#define BV_STARTSAMPLING 1
#define BV_STOPSAMPLING 0
#define BV_ENGINESTOPPED 0
#define BV_ENGINERUNNING 1


//Defines all elements of the class
class BitVoicerSerial
{
  public:
    //Class constructor
    BitVoicerSerial();
    //Method that retrieves data from serial port
    byte getData();
    //Method that sends a start/stop listening signal to BitVoicer
    void startStopListening();
    //BitVoicer's audio processing method
    void processAudio(unsigned int wait);
    //Method that sets up the audio input
    void setAudioInput(uint8_t pin);
    //Sets the analog voltage reference
    void setAnalogReference(uint8_t mode);
    //Method that sets Arduino back to its original input settings
    void undoAudioInput();
    //Sends a byte to BitVoicer
    void sendToBV(uint8_t b);
    //Sends a char to BitVoicer
    void sendToBV(char c);
    //Sends a int to BitVoicer
    void sendToBV(int n);
    //Sends a String object to BitVoicer
    void sendToBV(String s);
    //Stores byte data
    byte byteData;
    //Stores char data
    char charData;
    //Stores int data
    int intData;
    //Stores string data
    String strData;
    //Stores command data
    byte cmdData;
    //Stores engine status
    boolean engineRunning;
  private:
    //Stores temporary data read from the serial port
    byte _data[64];
    //Sets the public variables with the correct data
    //from last read
    void setData(byte dataType, int dataLength);
    //Stores the analog voltage reference
    uint8_t _bvAnalogReference;
};
#endif

BitVoicerSerial	KEYWORD1
startStopListening	KEYWORD2
processAudio	KEYWORD2
setAnalogReference	KEYWORD2
setAudioInput	KEYWORD2
undoAudioInput	KEYWORD2
sendToBV	KEYWORD2
getData	KEYWORD2
byteData	KEYWORD2
charData	KEYWORD2
intData	KEYWORD2
strData	KEYWORD2
cmdData	KEYWORD2
engineRunning	KEYWORD2
BUFFER_SIZE	LITERAL1
BV_UNDEFINED	LITERAL1
BV_CHAR	LITERAL1
BV_INT	LITERAL1
BV_BYTE	LITERAL1
BV_STR	LITERAL1
BV_COMMAND	LITERAL1
BV_STATUS	LITERAL1
BV_STARTSAMPLING	LITERAL1
BV_STOPSAMPLING	LITERAL1
BV_ENGINESTOPPED	LITERAL1
BV_ENGINERUNNING	LITERAL1
BV_DEFAULT	LITERAL1
BV_EXTERNAL	LITERAL1

Topic		Replies	Views
identifier "Serial" is undefined Troubleshooting	3	4916	February 7, 2019
Adafruit VS1053 (mp3) library for music maker shield ported? Troubleshooting	147	22875	March 25, 2019
Photon play sampled music (wav file) using DAC General	29	6279	April 25, 2021
How to record audio and save it to wav file using Electret Mic Amp - MAX9814? Getting Started argon	52	8051	November 1, 2019
LightwaveRF library port for spark Libraries	63	7211	June 3, 2014

How to add Bitvoicer added to particle library

Related topics