Skip to content

Getting Starting with Tympan

erk1313 edited this page Nov 2, 2018 · 26 revisions

Getting started with Tympan

  1. What's in the Box?

  2. Install Software

  3. Connect the Tympan to Arduino IDE

  4. Try Some Examples

  5. Try More Examples



What's in the Box?

You should have received:

  • A 3D printed case which encloses
    • Tympan Audio Board
    • Modified Teensy 3.6 programmed with the WDRC_8BandFIR_wBT
  • USB Cable
  • Rechargeable Li-ion battery included on Audio Board

Additional items you will need:

  • PC with USB port
  • Software
    • Arduino IDE
    • Teensyduino Add-On
  • Headphones or earbuds
  • External Microphone (optional)
  • Github account (optional)

Install Software

Before being able to use the Typman it will need to be programmed utilizing the Arduino IDE software with Add-Ons. You will also have access to the Tympan Library, an open source platform in Github with example files for trying out different audio algorithms or features of the system.

Go through the following steps to ensure your PC has the correct software before plugging in your Tympan.

Arduinio IDE and Teensyduino Add-On

  • Download and install the latest Arduino IDE software to your PC (not the web-based editor). Make sure the PC has a USB port as you will need it to connect to the Tympan later.

ArduinoDL

  • Open the Arduino after install to fully initialize then close it before the next step

Arduino-DownLoad

  • Download and install the Teensyduino Add-On. It is fine to select all the default options.

  • You will be asked to choose libraries to install and can select them "All", "None" or choose individually.

  • If you prefer not to install all the libraries, it is recommended you start with at least Audio, Bounce2, FreqCount, FreqMeasure, i2c_t3, SerialFlash, Snooze, and SPIFlash.

Tympan Library

  • Go to the Tympan Library in Github.
  • If you are familiar with Github, select Clone or download and clone it directly to where the Arduino IDE looks for libraries. For example C:\Users\amv\Documents\Arduino\libraries\Tympan_Library

Github1

  • If you are not familiar with Github, select Clone or download and select Download ZIP. Extract the file directly to where the Arduino IDE looks for libraries. For example C:\Users\amv\Documents\Arduino\libraries\Tympan_Library

  • Under Windows, Arduino stores all the add-on libraries within the My Documents folder.
  • For some reason, Arduino changes the name of the file by appending the word "master". Rename the file by deleting the word "master" as shown below.

Click this link if you would like more information on Installing an Arduino Library

Connect the Tympan to Arduino IDE

Set up the Arduino IDE

  • Re-open the Arduino IDE
  • Under Tools menu, choose Board and select Teensy 3.6

  • Under Tools menu, choose USB Type and select Serial + MIDI + Audio

Connect Tympan to PC

  • Using the micro USB cable, connect Tympan to PC, you will see red LED lights indicating the Tympan is charging

  • Power the Tympan "On" using the white switch on the side, blue blinking LED light indicates power. You should also see the message that the device drivers are being installed

Select COM port

  • Under Tools menu, select Port and select the Com port paired with the Teensy

NOTE: if you already had the Tympan plugged in, prior to starting this section, you may need to power cycle the unit

Try Some Examples

Audio Pass-Thru

This program is a basic input (microphone) to output (headphones) program and does not apply any gain, so the blue volume (gain) knob will not function.

  • Under File menu, select Examples
  • Scroll down to the bottom of the list and you will see the Tympan Library previously downloaded. If you have not done this, return to the Tympan Library section.
  • Highlight the Tympan Library and select Basic then AudioPassThru
  • Compile or Upload the program by select the right facing arrow

- Plug headphones into the Black headphone jack. If the program uploaded successfully, you should immediately hear the audio as it passes through from microphone to earphone.

  • The program is now loaded on the the Tympan and you can unplug the USB and walk around, hearing things in your environment differently than before

Basic Gain

This is also a basic input and output program, but one that does apply gain.

WARNING NOTE: Before putting on headphones with this program make sure the Gain is turned all the way down, by turning the Blue Knob all the way to the left, then slowly increase the Gain to a comfortable setting.

  • Under File menu, select Examples, Tympan Library, Basic, BasicGain
  • Compile or Upload the program by select the right facing arrow

Open the Serial Monitor

  • Make sure Tympan is connected by USB to your PC

  • Under Tools menu, select Port and select the Com port paired with the Teensy

  • Under Tools menu, select Serial Monitor. A new pop up window will appear

  • Start to slowly turn the Blue Knob and observe the volume level changes in the Serial Monitor window.

After playing with these first two programs, go forth and try out many more examples from the Library!

Try More Examples!

Below is a table with a brief synopsis of some of functionality of the available programs. All should have been added with the Tympan Library

You can’t perform that action at this time.