Getting Started with Tympan Rev E
Note: If you have the older version of Tympan (Rev D) please visit the page: Getting Started with Tympan Rev D
- A 3D printed case which encloses:
- Tympan Audio Board
- Modified Teensy 4.1 add-on programmed with the WDRC_8BandFIR_wBT
- USB Cable
- Rechargeable Li-ion battery included with Audio Board
- PC with USB port
- Software
- Arduino IDE
- Teensyduino Add-On
- Headphones or earbuds
- External Microphone (optional)
- Github account (optional)
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.
- Download and install the latest 1.8.x version of the Arduino IDE software to your PC (not the web-based editor). Do not use any of the newer 2.x versions of the Arduino IDE.
- Open the Arduino after install to fully initialize then close it before the next step
- Download and install the Teensyduino Add-On. It is fine to select all the default options. (For information on the installation on Macintosch and Linux and alternative ways to perform the installation please visit the Teensyduino download and installation page on the PJRC website .)
- 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.
- Go to the Tympan Library in Github.
- If you are familiar with Github, select Code and clone it directly to where the Arduino IDE looks for libraries. For example
C:\Users\HGeithner\Documents\Arduino\libraries\Tympan_Library. Once cloned, be sure you are using themainbranch and not some side branch.
- If you are not familiar with Github, select Code and select Download ZIP. Extract the file directly to where the Arduino IDE looks for libraries. For example
C:\Users\HGeithner\Documents\Arduino\libraries
- Under Windows, Arduino stores all the add-on libraries within the My Documents folder.
- Github changes the name of the file by appending the word "main". Rename the file by deleting "-main" as shown below.
Click this link if you would like more information on Installing an Arduino Library
- Re-open the Arduino IDE
- Under Tools menu, choose Board and select Teensy 4.1 (select Teensy 3.6 for RevD)
- Using the micro USB cable, connect Tympan to PC, you will see a red LED light on the side of the Tympan indicating that the device is charging.
- Power the Tympan "On" using the white switch on the side, green blinking LED light indicates power. You should also see the message that the device drivers are being installed
- 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
This program is a basic input (microphone) to output (headphones) program and does not apply any gain, so the black 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
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 Black 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
-
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 Black 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!
In trying these two examples, you probably noticed that it can take several minutes to compile and upload a sketch to the Tympan. Several minutes can feel like a long time. Sorry! Do be aware, though, that it only takes this long to compile a program the first time that you compile it. If you make changes to the program and re-compile, it re-compiles much faster. Phew.
Some people (people like me), can tolerate that long compile time as long as they are sure that the computer is doing something. The Arduino IDE, however, does not give you many messages as long as everything is compiling OK. While it is nice to be protected from useless text, I would actually prefer to see that the computer is doing something.
If you would be comforted by seeing more messages during the compilation process, you can configure the Arduino IDE to be more verbose. Simply go under the Arduino IDE's "File" menu, select "Preferences", find the text "Show verbose output during:" and check the box for "compilation". Remember, this is totally optional!
Below is a table with a brief synopsis of the functionality of some available programs. All should have been added with the Tympan Library plus more!
