EXAMPLE How to access the Terrarium toggle / footswitches

Robert

Robert

Reverse Engineer
Staff member
The Terrarium platform was designed to work as seamlessly as possible with the libDaisy Petal API, but because the number of toggle switches (and footswitches) deviates from the Petal interface we need to use a different set of constants to address them.

The Terrarium header file (terrarium.h) can be downloaded from this link.

At the top of our source file we need to include the Terrarium header file and direct the compiler to use the "terrarium" namespace.
C++: 
#include "terrarium.h"
using namespace terrarium;

Now we can access the state of the footswitches and toggle switches using the standard Daisy functions by specifying the Terrarium switch constants.

C++: 
if (hw.switches[Terrarium::FOOTSWITCH_1].Pressed())
{
    // Footswitch 1 is pressed
}

C++: 
if (hw.switches[Terrarium::SWITCH_1].Pressed())
{
    // Toggle switch 1 is ON
}

Here is the code in an example project. In this example the footswitches toggle the Terrarium LEDs on and off.
C++: 
// PedalPCB Terrarium Switch Example
#include "daisy_petal.h"
#include "daisysp.h"
#include "terrarium.h"

using namespace daisy;
using namespace daisysp;
using namespace terrarium;

DaisyPetal hw;

dsy_gpio led1;
dsy_gpio led2;

void AudioCallback(float *in, float *out, size_t size)
{
    hw.DebounceControls();
    hw.UpdateAnalogControls();

    if (hw.switches[Terrarium::FOOTSWITCH_1].RisingEdge())
        dsy_gpio_toggle(&led1);

    if (hw.switches[Terrarium::FOOTSWITCH_2].RisingEdge())
        dsy_gpio_toggle(&led2);

}

int main(void)
{
    hw.Init();
    hw.StartAdc();
    hw.StartAudio(AudioCallback);

    led1.pin = hw.seed.GetPin(22);
    led1.mode = DSY_GPIO_MODE_OUTPUT_PP;
    led1.pull = DSY_GPIO_NOPULL;
    dsy_gpio_init(&led1);

    led2.pin = hw.seed.GetPin(23);
    led2.mode = DSY_GPIO_MODE_OUTPUT_PP;
    led2.pull = DSY_GPIO_NOPULL;
    dsy_gpio_init(&led2);
      
    for(;;)
    {
    }
}
 
Last edited by a moderator:
Robert said:
The Terrarium platform was designed to work as seamlessly as possible with the libDaisy Petal API, but because the number of toggle switches (and footswitches) deviates from the Petal interface we need to use a different set of constants to address them.

The Terrarium header file (terrarium.h) can be downloaded from this link.

At the top of our source file we need to include the Terrarium header file and direct the compiler to use the "terrarium" namespace.
C++: 
#include "terrarium.h"
using namespace terrarium;

Now we can access the state of the footswitches and toggle switches using the standard Daisy functions by specifying the Terrarium switch constants.

C++: 
if (hw.switches[Terrarium::FOOTSWITCH_1].Pressed())
{
    // Footswitch 1 is pressed
}

C++: 
if (hw.switches[Terrarium::SWITCH_1].Pressed())
{
    // Toggle switch 1 is ON
}

Here is the code in an example project. In this example the footswitches toggle the Terrarium LEDs on and off.
C++: 
// PedalPCB Terrarium Switch Example
#include "daisy_petal.h"
#include "daisysp.h"
#include "terrarium.h"

using namespace daisy;
using namespace daisysp;
using namespace terrarium;

DaisyPetal hw;

dsy_gpio led1;
dsy_gpio led2;

void AudioCallback(float *in, float *out, size_t size)
{
    hw.DebounceControls();
    hw.UpdateAnalogControls();

    if (hw.switches[Terrarium::FOOTSWITCH_1].RisingEdge())
        dsy_gpio_toggle(&led1);

    if (hw.switches[Terrarium::FOOTSWITCH_2].RisingEdge())
        dsy_gpio_toggle(&led2);

}

int main(void)
{
    hw.Init();
    hw.StartAdc();
    hw.StartAudio(AudioCallback);

    led1.pin = hw.seed.GetPin(22);
    led1.mode = DSY_GPIO_MODE_OUTPUT_PP;
    led1.pull = DSY_GPIO_NOPULL;
    dsy_gpio_init(&led1);

    led2.pin = hw.seed.GetPin(23);
    led2.mode = DSY_GPIO_MODE_OUTPUT_PP;
    led2.pull = DSY_GPIO_NOPULL;
    dsy_gpio_init(&led2);
     
    for(;;)
    {
    }
}
Click to expand...
I have a general hardware question about the Toggle switches and pots. Is there a specific value range or will it be dependent on what kind of pedal we’re developing? Or should I just get all 500k A or B and call it good?

Are the toggle switches SPDT ON/ON or ON/off/ON?

thanks!
 
The pots on the Daisy Petal were all B10K so that's what I used in the Terrarium prototypes. I would assume B100K would work perfectly fine as well, and probably put less of a load on the voltage regulator in the Seed.

The toggle switches are all SPDT ON/ON.

I'll get the build docs posted in the next day or two.
 
Which way does the Daisy Seed fit on the Terrarium? Is the micro USB jack supposed to be closer to the audio IN or the audio OUT?
 
The Micro USB goes on the left end, closest to the IN.

I'll update the silkscreen to make this more obvious. There's a pin 1 indicator on the board but that gets covered up by the pinheaders.
 
Robert said:
The pots on the Daisy Petal were all B10K so that's what I used in the Terrarium prototypes. I would assume B100K would work perfectly fine as well, and probably put less of a load on the voltage regulator in the Seed.
Click to expand...
Has anyone tried pots other than B10k?
 
Robert said:
C++: 
if (hw.switches[Terrarium::SWITCH_1].Pressed())
{
    // Toggle switch 1 is ON
}

C++: 
    if (hw.switches[Terrarium::FOOTSWITCH_1].RisingEdge())
Click to expand...

Is there any difference between how the first example above has Pressed, but most of the other things have RisingEdge? Are the two terms interchangeable or are they specific functions?
 
I used Pressed in the first example just so it was a more intuitive read for folks who aren't familiar with the functions. "Pressed" is obvious, "RisingEdge" might not be so obvious to someone just getting started.

There are three functions for accessing switches, RisingEdge, FallingEdge, and Pressed.

RisingEdge returns true the moment the switch is pressed.
FallingEdge returns true the moment the switch is released.
Pressed returns true for the entire duration that the switch is held down (or switched on, in the case of a toggle switch).

RisingEdge and FallingEdge only return true at the moment the switch transition occurs. This is useful when you want to detect an instantaneous button press.

We use RisingEdge for bypass switching because we only want to toggle from Active/Bypass once when the footswitch is pressed down. If we used Pressed, the algorithm would rapidly switch on and off many times while the footswitch was still pressed down.

You would use Pressed if you wanted to use a footswitch as a momentary control. (momentary kill switch, set delay feedback to max, etc)
 
zgrav said:
Where would I put the terrarium.h file? in the folder with the daisy libraries?
Click to expand...

Sorry I didn't see this until just now. I've been putting the terrarium.h file in each of my project folders.

You could put it in one of the daisy library folders (libdaisy, daisysp) if you wanted, but I personally like to keep those folders untouched.
 
Last edited by a moderator:
It’s generally not a good idea to have multiple copies of the same file floating around. On Linux and Mac OS, you can use symbolic links to manage this better . On Windows, I don't know.
 
I keep it in the project folder so each project is self contained.

If I zip up the folder and send it to someone else they have everything they need that isn't standard libDaisy / daisySP code, I don't have to include a separate file with instructions on how/where to place the file (which might vary depending on where each person keeps their libraries).

Also the terrarium.h file is a work in progress, so it's a safeguard against any versioning issues.

Eventually it will be moved into it's own folder, but for now it's just a simple include so that would be overkill. In it's current (unpublished) state there is also some function implementation in the header, which of course is frowned upon, but it just makes things easier to work with at the moment.
 
Robert said:
Sorry I didn't see this until just now. I've been putting the terrarium.h file in each of my project folders.

You could put it in one of the daisy library folders (libdaisy, daisysp) if you wanted, but I personally like to keep those folders untouched.
Click to expand...
One solution to this would be to make a Terrarium repo on github which contains this file and add it to your projects as a submodule (I am probably going to end up doing this). This would be the same process that happens with the "DaisySP" and "daisyLib" submodules that get pulled down for the DaisyExamples repo.

Also, the file should probably have ifndef/def/endifs

C++: 
#ifndef TERRARIUM_HEADER
#define TERRARIUM_HEADER
namespace terrarium
{
    class Terrarium
    {
        public:
            enum Sw
            {
                FOOTSWITCH_1 = 4,
                FOOTSWITCH_2 = 5,
                SWITCH_1 = 2,
                SWITCH_2 = 1,
                SWITCH_3 = 0,
                SWITCH_4 = 6
            };
    };
}
#endif

It might be overkill at this point since it is only this header file ... but ... I imagine perhaps more will be added to this file in the future?
 
varlogtim said:
One solution to this would be to make a Terrarium repo on github which contains this file and add it to your projects as a submodule (I am probably going to end up doing this). This would be the same process that happens with the "DaisySP" and "daisyLib" submodules that get pulled down for the DaisyExamples repo.

Also, the file should probably have ifndef/def/endifs

C++: 
#ifndef TERRARIUM_HEADER
#define TERRARIUM_HEADER
namespace terrarium
{
    class Terrarium
    {
        public:
            enum Sw
            {
                FOOTSWITCH_1 = 4,
                FOOTSWITCH_2 = 5,
                SWITCH_1 = 2,
                SWITCH_2 = 1,
                SWITCH_3 = 0,
                SWITCH_4 = 6
            };
    };
}
#endif

It might be overkill at this point since it is only this header file ... but ... I imagine perhaps more will be added to this file in the future?
Click to expand...
See this post:

Mismatch of DaisyPetal.KNOB_X -> POT_X numbers

I just soldered up my Terrarium and have been exploring the inputs. I wrote the following code to verify the hardware inputs: #include "daisy_petal.h" #include "terrarium.h" using namespace daisy; using namespace terrarium; DaisyPetal petal; void pot_led_flash_control(uint8_t pot_num) {...
forum.pedalpcb.com forum.pedalpcb.com
 
Some minor changes for using the example with the current library:

Old:
void AudioCallback(float *in, float *out, size_t size)
{
hw.Debounce();
hw.UpdateAnalogControls();

New:
void AudioCallback(const float *in, float *out, size_t size)
{
hw.ProcessDigitalControls();
hw.ProcessAnalogControls();
 
Last edited:
You must log in or register to reply here.

Similar threads

untamedfrontier
EXAMPLE Chorus Example
Replies
3
Views
1K
Plate of Shrimp
Plate of Shrimp
Robert
  • Sticky
EXAMPLE How to control Terrarium LEDs
Replies
7
Views
3K
jocano
J
untamedfrontier
EXAMPLE Distortion
Replies
16
Views
2K
untamedfrontier
untamedfrontier
V
Mismatch of DaisyPetal.KNOB_X -> POT_X numbers
Replies
1
Views
541
varlogtim
V
JTEX
Momentary Pushbuttons to Toggle Dual Coil Latching Relays On/Off
2 3
Replies
40
Views
2K
sonic_explorer
sonic_explorer
Back
Top