Dev-Portal

Everything you need to get started on developing effects for Stratus® and Tone Shop™.

Required Hardware

• Stratus multi-effects pedal

Documentation

FAUST - A useful DSP programming language. When using FAUST to generate C++ code, it will already follow the general format necessary for Stratus.

Usage

You must include the provided dsp.hpp file in any algorithms you compile. You can find this header file in the resources folder.

import "dsp.hpp"

class example_effect : public dsp {

}

Compilation

SSH into Stratus, copy your files to Stratus' local filesystem, and build your algorithm with the following command:

  g++ -fPIC -shared -O3 -g -march=armv7-a -mtune=cortex-a8 
-mfloat-abi=hard -mfpu=neon -ftree-vectorize -ffast-math "EFFECT_NAME".cpp -o "EFFECT_NAME".so

These flags will ensure that the most optimized binary is generated.

You can log into Stratus via your terminal with the following command (Mac and Linux only):

ssh root@stratus.local

Please reach out to us via the Developer Application on our website to obtain the root user password.

Testing

To test your effect, you'll need the "development" version of the Chaos Audio mobile app. We'll be rolling out access to this version soon.

Release

The following items are also necessary for every effect to be listed on Tone Shop™:

• Effect name

  This is the name of your effect.

• Effect price

  This is the list price for your effect. If you're interested in charging for your effect, please let us know by emailing support@chaosaudio.com.

• Effect subtitle

  This is a 2-3 word description for your effect.

• Effect description

  This is the full description for your effect. It should include information on usage, information on any knobs/parameters, and a link to any demos available.

• Effect author

  This is your name or company name.

• Effect version number

  This is the most recent version number for your effect. This MUST always be higher than any previous versions. It should be in the format "0.0.0".

• Effect file

  This is the final, compiled binary for your algorithm. Will have file extension ".so".

• Pedal mockup

  This is an image of your effect fully-built. (i.e. roughly the same size as your "pedal background image", but including all knobs, switches, LEDs, labels, audio jacks, etc in their proper positions)

• Pedal preview card

  This is the square image that will show up in Tone Shop™ as users are browsing through effects. We recommend following the same format as other effects currently in Tone Shop.

• Pedal background image

  We recommend an aspect ratio of 230 x 423 (can be higher resolution than this). Feel free to experiment with other aspect ratios. This background artwork should only include your logo, artwork, and pedal name. It should not include knob labels, audio jacks, knobs, switches, LEDs, etc.

• Knob base image (for each knob)

  This is the image associated with your knob that SHOULD NOT rotate when a user adjusts the knob. (i.e. a shadow or light gradient)

• Knob image (for each knob)

  This is the image associated with your knob that DOES rotate when a user adjusts the knob. (i.e. a tick mark or outer texture)

• Knob label image (for each knob)

  This is the image associated with your knob label (name) that is positioned near the knob it is describing. (i.e. "Drive")

• Stomp switch pressed image

  This is the image associated with your effect bypass switch that displays any time a user touches (presses) the bypass switch. (i.e. it should look like the switch is being pressed)

• Stomp switch released image

  This is the image associated with your effect bypass switch that displays any time a user releases (is not touching) the bypass switch. (i.e. it should look like the switch is not being pressed)

• LED ON image

  This is the image that indicates to the user that the effect is ENABLED. (i.e. an LED that is illuminated)

• LED OFF image

  This is the image that indicates to the user that the effect is BYPASSED. (i.e. an LED that is off)

• Audio jack (for each jack, usually two)

  This is the image that is associated with an audio jack that you would like displayed somewhere on the outside border of your pedal background image.

Support

For support, email support@chaosaudio.com.