Skip to content

Home

Jump to bottom
hgeithner-creare edited this page Aug 11, 2021 · 8 revisions

Welcome to the Tympan_Library wiki!

Docs

Getting Started docs are here.

The rest of the Wiki docs are here.

WDRC Calculator is here with a slightly modified version for mobile here.

The Web GUI for creating your own audio processing chain is here.

Travis CI Integration

Tympan_Library uses Travis for continuous integration testing. Detailed CI reports from the latest builds are found on the Tympan_Library Travis page.

The Typman_Library Travis CI job is specified in the repository's travis.yml file. The Travis job uses PlatformIO to simulate installing the Arduino IDE, installing Teensyduino (and the Teensy Loader), installing Tympan_Library and the required Arduino libraries, and building the Tympan_Library example sketches.

The PlatformIO configuration for the Tympan_Library is specified in the platformio.ini file. It looks something like this:

[env:teensy_device]
platform = teensy@4.4.0
framework = arduino
board = teensy36
build_flags = -D USB_EVERYTHING
lib_deps =
    /home/travis/build/Tympan/Tympan_Library
    https://github.com/PaulStoffregen/Audio.git
    https://github.com/PaulStoffregen/SD.git

As of 2019-Aug-21, we have had to specify the platform as teensy@4.4.0, as opposed to just teensy. This was required because the default PlatformIO teensyloader was pointing to teensyduino 1.45 instead of teensyduino 1.47, and only teensyduino 1.47 is compatible with the latest versions of the Audio library. It is useful to know that when a user downloads and runs the Teensyduino installer, it installs the latest versions of libraries, not a pegged version.

Setting build_flags equal to -D USB_EVERYTHING is equivalent to setting the USB type to "Serial + MIDI + Audio" in the Arduino IDE. We also found that the build process was using the default Arduino Audio and SD libraries instead of those that are installed during the Teensyduino installation. The way to get around this is to specifically point to the Teensy Audio library and SD library github repos.

Useful links:

Clone this wiki locally