Digigurdy-baz
Loading...
Searching...
No Matches
Macros | Variables
Configuration Options

Macros

#define WHITE_OLED
 Enables SD1306 display support, do not use with BLUE_OLED. More...
 
#define BLUE_OLED
 Enables SSH1106 display support, do not use with WHITE_OLED. More...
 
#define BLUE_OLED
 Enables SSH1106 display support, do not use with WHITE_OLED. More...
 
#define USE_TRIGGER
 Enables WAV Trigger support. More...
 
#define USE_TRIGGER
 Enables WAV Trigger support. More...
 
#define USE_TSUNAMI
 Enables Tsunami support. More...
 
#define USE_GEARED_CRANK
 Enables geared-crank support. More...
 
#define LED_KNOB
 Enables an LED buzz indicator on LED_PIN. More...
 
#define USE_PEDAL
 Enables the accessory/vibrato pedal on PEDAL_PIN. More...
 
#define USE_PEDAL
 Enables the accessory/vibrato pedal on PEDAL_PIN. More...
 
#define ALLOW_COMBO_MODE
 Setting this option allows both MIDI-OUT and Trigger/Tsunami use simultaneously. More...
 
#define ALLOW_COMBO_MODE
 Setting this option allows both MIDI-OUT and Trigger/Tsunami use simultaneously. More...
 
#define REV4_MODE
 Setting this option enables EX pins 7-10, and SPI2 display. More...
 
#define REV4_MODE
 Setting this option enables EX pins 7-10, and SPI2 display. More...
 
#define __TSUNAMI_USE_SERIAL1__
 The Serial port to use on the Teensy unit for the Tsunami. More...
 
#define __WT_USE_SERIAL5__
 The Serial port to use on the Teensy unit for the Trigger. More...
 

Variables

const String EXTRA_LINE = " Rev4.0 Test Build "
 This is a freeform line displayed on the About screen. More...
 
const int TSUNAMI_OUT = 0
 The audio output channel used by the Tsunami unit. More...
 
const int LED_PIN = 40
 Pin used for the LED buzz indicator, if LED_KNOB is enabled. More...
 
const int PEDAL_PIN = 38
 Pin used for the accessory pedal, if USE_PEDAL is enabled. More...
 
const float PEDAL_MAX_V = 658.0
 The max voltage reported by the accessory pedal. More...
 
const int pin_array []
 The ordered layout of the keybox keys/buttons. More...
 
const int num_keys = 24
 The number of keys on the keybox. More...
 
const int X_INDEX = 0
 The position of the "X" key on the keybox. More...
 
const int A_INDEX = num_keys - 2
 The position of the "A" key on the keybox. More...
 
const int B_INDEX = num_keys - 5
 The position of the "B" key on the keybox. More...
 
const int BUTTON_1_INDEX = 1
 The position of the "1" key on the keybox. More...
 
const int BUTTON_2_INDEX = 3
 The position of the "2" key on the keybox. More...
 
const int BUTTON_3_INDEX = 4
 The position of the "3" key on the keybox. More...
 
const int BUTTON_4_INDEX = 6
 The position of the "4" key on the keybox. More...
 
const int BUTTON_5_INDEX = 8
 The position of the "5" key on the keybox. More...
 
const int BUTTON_6_INDEX = 9
 The position of the "6" key on the keybox. More...
 
const int TPOSE_UP_INDEX = num_keys - 1
 The position of the "T-UP" key on the keybox. More...
 
const int TPOSE_DN_INDEX = num_keys - 3
 The position of the "T-DOWN" key on the keybox. More...
 
const int CRANK_PIN = 15
 The pin running to the crank. More...
 
const int BUZZ_PIN = 16
 The analog pin running to the buzz potentiometer/knob. More...
 
const int BIG_BUTTON_PIN = 39
 The pin running to the arcade, "auto-crank" button. More...
 
const int EX1_PIN = 19
 The pin to the EX1 button. More...
 
const int EX2_PIN = 13
 The pin to the EX2 button. More...
 
const int EX3_PIN = 12
 The pin to the EX3 button. More...
 
const int EX4_PIN = 41
 The pin to the EX4 button. More...
 
const int EX5_PIN = 40
 The pin to the EX5 button. More...
 
const int EX6_PIN = 17
 The pin to the EX6 button. More...
 
const int EX7_PIN = 14
 The pin to the EX7 button. More...
 
const int EX8_PIN = 18
 The pin to the EX8 button. More...
 
const int EX9_PIN = 22
 The pin to the EX9 button. More...
 
const int EX10_PIN = 23
 The pin to the EX10 button. More...
 

Detailed Description

These variables/definitions are compile-time configuration options.

Macro Definition Documentation

◆ __TSUNAMI_USE_SERIAL1__

#define __TSUNAMI_USE_SERIAL1__

The Serial port to use on the Teensy unit for the Tsunami.

◆ __WT_USE_SERIAL5__

#define __WT_USE_SERIAL5__

The Serial port to use on the Teensy unit for the Trigger.

◆ ALLOW_COMBO_MODE [1/2]

#define ALLOW_COMBO_MODE

Setting this option allows both MIDI-OUT and Trigger/Tsunami use simultaneously.

Set this only if the MIDI-OUT and Trigger/Tsunami Tx pins are different!

◆ ALLOW_COMBO_MODE [2/2]

#define ALLOW_COMBO_MODE

Setting this option allows both MIDI-OUT and Trigger/Tsunami use simultaneously.

Set this only if the MIDI-OUT and Trigger/Tsunami Tx pins are different!

◆ BLUE_OLED [1/2]

#define BLUE_OLED

Enables SSH1106 display support, do not use with WHITE_OLED.

◆ BLUE_OLED [2/2]

#define BLUE_OLED

Enables SSH1106 display support, do not use with WHITE_OLED.

◆ LED_KNOB

#define LED_KNOB

Enables an LED buzz indicator on LED_PIN.

◆ REV4_MODE [1/2]

#define REV4_MODE

Setting this option enables EX pins 7-10, and SPI2 display.

meant for rev4 boards.

◆ REV4_MODE [2/2]

#define REV4_MODE

Setting this option enables EX pins 7-10, and SPI2 display.

meant for rev4 boards.

◆ USE_GEARED_CRANK

#define USE_GEARED_CRANK

Enables geared-crank support.

Disable for optical-crank support

◆ USE_PEDAL [1/2]

#define USE_PEDAL

Enables the accessory/vibrato pedal on PEDAL_PIN.

◆ USE_PEDAL [2/2]

#define USE_PEDAL

Enables the accessory/vibrato pedal on PEDAL_PIN.

◆ USE_TRIGGER [1/2]

#define USE_TRIGGER

Enables WAV Trigger support.

Cannot be used with USE_TSUNAMI simultaneously

◆ USE_TRIGGER [2/2]

#define USE_TRIGGER

Enables WAV Trigger support.

Cannot be used with USE_TSUNAMI simultaneously

◆ USE_TSUNAMI

#define USE_TSUNAMI

Enables Tsunami support.

Cannot be used with USE_TRIGGER simultaneously

◆ WHITE_OLED

#define WHITE_OLED

Enables SD1306 display support, do not use with BLUE_OLED.

Variable Documentation

◆ A_INDEX

const int A_INDEX = num_keys - 2

The position of the "A" key on the keybox.

This is intended to be the upper rightmost key.

◆ B_INDEX

const int B_INDEX = num_keys - 5

The position of the "B" key on the keybox.

This is intended to be the upper key second from the right.

◆ BIG_BUTTON_PIN

const int BIG_BUTTON_PIN = 39

The pin running to the arcade, "auto-crank" button.

◆ BUTTON_1_INDEX

const int BUTTON_1_INDEX = 1

The position of the "1" key on the keybox.

This is intended to be the leftmost key on the bottom.

◆ BUTTON_2_INDEX

const int BUTTON_2_INDEX = 3

The position of the "2" key on the keybox.

This is intended to be the 2nd key from the left on the bottom.

◆ BUTTON_3_INDEX

const int BUTTON_3_INDEX = 4

The position of the "3" key on the keybox.

This is intended to be the 3rd key from the left on the bottom.

◆ BUTTON_4_INDEX

const int BUTTON_4_INDEX = 6

The position of the "4" key on the keybox.

This is intended to be the 4th key from the left on the bottom.

◆ BUTTON_5_INDEX

const int BUTTON_5_INDEX = 8

The position of the "5" key on the keybox.

This is intended to be the 5th key from the left on the bottom.

◆ BUTTON_6_INDEX

const int BUTTON_6_INDEX = 9

The position of the "6" key on the keybox.

This is intended to be the 6th key from the left on the bottom.

◆ BUZZ_PIN

const int BUZZ_PIN = 16

The analog pin running to the buzz potentiometer/knob.

Warning
This pin must be analog-capable.

◆ CRANK_PIN

const int CRANK_PIN = 15

The pin running to the crank.

Warning
If using a geared crank, this pin must be analog-capable.

◆ EX10_PIN

const int EX10_PIN = 23

The pin to the EX10 button.

◆ EX1_PIN

const int EX1_PIN = 19

The pin to the EX1 button.

◆ EX2_PIN

const int EX2_PIN = 13

The pin to the EX2 button.

◆ EX3_PIN

const int EX3_PIN = 12

The pin to the EX3 button.

◆ EX4_PIN

const int EX4_PIN = 41

The pin to the EX4 button.

◆ EX5_PIN

const int EX5_PIN = 40

The pin to the EX5 button.

◆ EX6_PIN

const int EX6_PIN = 17

The pin to the EX6 button.

◆ EX7_PIN

const int EX7_PIN = 14

The pin to the EX7 button.

◆ EX8_PIN

const int EX8_PIN = 18

The pin to the EX8 button.

◆ EX9_PIN

const int EX9_PIN = 22

The pin to the EX9 button.

◆ EXTRA_LINE

const String EXTRA_LINE = " Rev4.0 Test Build "

This is a freeform line displayed on the About screen.

◆ LED_PIN

const int LED_PIN = 40

Pin used for the LED buzz indicator, if LED_KNOB is enabled.

◆ num_keys

const int num_keys = 24

The number of keys on the keybox.

This must/should be set to the length of pin_array[] - 1.

◆ PEDAL_MAX_V

const float PEDAL_MAX_V = 658.0

The max voltage reported by the accessory pedal.

This should be set to the max voltage your pedal will output.

  • Value need not be exact
  • Value is on a 0-1023 scale: 1023 = 3.3V

◆ PEDAL_PIN

const int PEDAL_PIN = 38

Pin used for the accessory pedal, if USE_PEDAL is enabled.

◆ pin_array

const int pin_array[]
Initial value:
= {-1, 2, 24, 3, 25, 26, 4, 27, 5, 28, 29, 6, 30,
7, 31, 8, 32, 33, 11, 34, 10, 35, 36, 9, 37}

The ordered layout of the keybox keys/buttons.

  • This both determines which Teensy pins compose the keybox, and the order they are in.

index 0 is unused and would theoretically not affect the note being played.

  • index 1 raises the note played by 1 semitone, index 2 by 2 semitones, etc.
  • pin_array can be extended or shortened for larger/smaller keyboxes

◆ TPOSE_DN_INDEX

const int TPOSE_DN_INDEX = num_keys - 3

The position of the "T-DOWN" key on the keybox.

This is intended to be the bottom second key from the right.

◆ TPOSE_UP_INDEX

const int TPOSE_UP_INDEX = num_keys - 1

The position of the "T-UP" key on the keybox.

This is intended to be the bottom right key.

◆ TSUNAMI_OUT

const int TSUNAMI_OUT = 0

The audio output channel used by the Tsunami unit.

0 == 1L, 1 == 1R, etc.

◆ X_INDEX

const int X_INDEX = 0

The position of the "X" key on the keybox.

  • This is intended to be the upper leftmost key.

Note that the first key position is 0. This is the index in pin_array - 1!