This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
MCU-OLED-SSD1306.ino

MCU-OLED-SSD1306

An example demonstrating the use of DisplayElements to display information from the DAW on a small OLED display.

Boards:
Teensy 3.x

Connections

Add a capacitor between the reset pin of the display and ground, and a resistor from reset to 3.3V. The values are not critical, 0.1µF and 10kΩ work fine.
You do need some way to reset the display, without it, it won't work.
Alternatively, you could use an IO pin from the Teensy to reset the display, but this just "wastes" a pin.

Behavior

Mapping

Map "Control Surface" as a Mackie Control Universal unit in your DAW.

Note
There seem to be some differences in the way some applications handle VU meters: some expect the hardware to decay automatically, some don't.
If you notice that the meters behave strangely, try both MCU::VUDecay::Hold and MCU::VUDecay::Default, or try a different decay time.

Written by PieterP, 2019-11-12
https://github.com/tttapa/Control-Surface

#include <Encoder.h> // Include the Encoder library.
// This must be done before the Control Surface library.
#include <Control_Surface.h> // Include the Control Surface library
// Include the display interface you'd like to use
// ----------------------------- MIDI Interface ----------------------------- //
// ========================================================================== //
/*
Instantiate a MIDI interface to use for the Control Surface.
*/
// USBDebugMIDI_Interface midi(115200);
// ----------------------------- Display setup ------------------------------ //
// ========================================================================== //
/*
Instantiate and initialize the SSD1306 OLED display
*/
constexpr uint8_t SCREEN_WIDTH = 128;
constexpr uint8_t SCREEN_HEIGHT = 64;
constexpr int8_t OLED_DC = 17; // Data/Command pin of the display
constexpr int8_t OLED_reset = -1; // Use the external RC circuit for reset
constexpr int8_t OLED_CS = 10; // Chip Select pin of the display
constexpr uint32_t SPI_Frequency = SPI_MAX_SPEED;
// Instantiate the displays
Adafruit_SSD1306 ssd1306Display = {
SCREEN_WIDTH, SCREEN_HEIGHT, &SPI, OLED_DC,
OLED_reset, OLED_CS, SPI_Frequency,
};
// --------------------------- Display interface ---------------------------- //
// ========================================================================== //
// Implement the display interface, specifically, the begin and drawBackground
// methods.
class MySSD1306_DisplayInterface : public SSD1306_DisplayInterface {
public:
MySSD1306_DisplayInterface(Adafruit_SSD1306 &display)
void begin() override {
// Initialize the Adafruit_SSD1306 display
if (!disp.begin())
FATAL_ERROR(F("SSD1306 allocation failed."), 0x1306);
// If you override the begin method, remember to call the super class method
}
void drawBackground() override { disp.drawLine(1, 8, 126, 8, WHITE); }
} display = ssd1306Display;
// ------------------------------- Bank setup ------------------------------- //
// ========================================================================== //
/*
Create a bank and a bank selector to change its setting.
*/
Bank<4> bank(2); // Create a new bank with two tracks per bank
// Create a new bank selector to control the bank using two push buttons
IncrementDecrementSelector<4> bankselector = {bank, {5, 6}, Wrap::Wrap};
// -------------------------- MIDI Input Elements --------------------------- //
// ========================================================================== //
/*
Define all elements that listen for MIDI messages.
*/
// Time display keeps track of the bar counter
MCU::TimeDisplay timedisplay = {};
// Play / Record
// Mute
{bank, MCU::MUTE_1},
{bank, MCU::MUTE_2},
};
// Solo
{bank, MCU::SOLO_1},
{bank, MCU::SOLO_2},
};
// Record arm / ready
{bank, MCU::REC_RDY_1},
{bank, MCU::REC_RDY_2},
};
// VU meters
{bank, 1, MCU::VUDecay::Hold},
{bank, 2, MCU::VUDecay::Hold},
};
// VPot rings
{bank, 1},
{bank, 2},
};
// ---------------------------- Display Elements ---------------------------- //
// ========================================================================== //
/*
Define all display elements that display the state of the input elements.
*/
// Time display
MCU::TimeDisplayDisplay timedisplaydisplay = {
// position (0, 0), font size (1)
display, timedisplay, {0, 0}, 1, WHITE,
};
// Play / Record
NoteBitmapDisplay playDisp = {
display, play, XBM::play_7, {16 + 64, 0}, WHITE,
};
NoteBitmapDisplay recordDisp = {
display, record, XBM::record_7, {26 + 64, 0}, WHITE,
};
// Mute
NoteBitmapDisplay muteDisp[] = {
{display, mute[0], XBM::mute_10B, {14, 50}, WHITE},
{display, mute[1], XBM::mute_10B, {14 + 64, 50}, WHITE},
};
// Solo
NoteBitmapDisplay soloDisp[] = {
{display, solo[0], XBM::solo_10B, {14, 50}, WHITE},
{display, solo[1], XBM::solo_10B, {14 + 64, 50}, WHITE},
};
NoteBitmapDisplay rudeSoloDisp = {
display, rudeSolo, XBM::solo_7, {36 + 64, 0}, WHITE};
// Record arm / ready
NoteBitmapDisplay recrdyDisp[] = {
{display, recrdy[0], XBM::rec_rdy_10B, {14 + 14, 50}, WHITE},
{display, recrdy[1], XBM::rec_rdy_10B, {14 + 14 + 64, 50}, WHITE},
};
// VU meters
MCU::VUDisplay vuDisp[] = {
// position (32+11, 60), width (16), bar height (3) px, bar spacing (1) px
{display, vu[0], {32 + 11, 60}, 16, 3, 1, WHITE},
{display, vu[1], {32 + 11 + 64, 60}, 16, 3, 1, WHITE},
};
// VPot rings
MCU::VPotDisplay vpotDisp[] = {
// position (0, 10), outer radius (16) px, inner radius (13) px
{display, vpot[0], {0, 10}, 16, 13, WHITE},
{display, vpot[1], {64, 10}, 16, 13, WHITE},
};
// Bank seting
BankDisplay bankDisp[] = {
// first track of the bank (1), position (0, 50), font size (2)
{display, bank, 1, {0, 50}, 2, WHITE},
{display, bank, 2, {64, 50}, 2, WHITE},
};
// --------------------------------- Setup ---------------------------------- //
// ========================================================================== //
void setup() {
// The default SPI MOSI pin (11) is used for I²S, so we need to use the
// alternative MOSI pin (7)
SPI.setMOSI(7);
// Correct relative mode for MCU rotary encoders
Control_Surface.begin(); // Initialize Control Surface
}
// ---------------------------------- Loop ---------------------------------- //
// ========================================================================== //
void loop() {
Control_Surface.loop(); // Refresh all elements
}
USBMIDI_Interface
A class for MIDI interfaces sending MIDI messages over a USB MIDI connection.
Definition: USBMIDI_Interface.hpp:43
NoteBitmapDisplay
A class that displays a bitmap depending on the state of a MIDINote.
Definition: NoteBitmapDisplay.hpp:10
MACKIE_CONTROL_RELATIVE
Relative mode used by the Mackie Control Universal protocol.
Definition: RelativeCCSender.hpp:62
XBM::solo_10B
const XBitmap solo_10B
XBitmap solo_10B (10px × 10px)
Definition: XBitmaps.hpp:115
Bank
A class that groups Bankable BankableMIDIOutputs and BankableMIDIInputs, and allows the user to chang...
Definition: Bank.hpp:77
MCU::Bankable::VPotRing
A class for MIDI input elements that represent Mackie Control Universal V-Pots.
Definition: VPotRing.hpp:213
NoteValue
Definition: NoteCCRange.hpp:134
MCU::VPotDisplay
Definition: VPotDisplay.hpp:12
XBM::rec_rdy_10B
const XBitmap rec_rdy_10B
XBitmap rec_rdy_10B (10px × 10px)
Definition: XBitmaps.hpp:80
XBM::play_7
const XBitmap play_7
XBitmap play_7 (7px × 7px)
Definition: XBitmaps.hpp:66
MCU::RECORD
constexpr uint8_t RECORD
Definition: MCU.hpp:127
MCU::MUTE_2
constexpr uint8_t MUTE_2
Definition: MCU.hpp:37
MCU::TimeDisplayDisplay
Definition: TimeDisplayDisplay.hpp:11
MCU::SOLO_1
constexpr uint8_t SOLO_1
Definition: MCU.hpp:27
MCU::Bankable::VU
A class for MIDI input elements that represent Mackie Control Universal VU meters.
Definition: VU.hpp:353
MCU::REC_RDY_1
constexpr uint8_t REC_RDY_1
Definition: MCU.hpp:18
MCU::VUDecay::Hold
constexpr unsigned int Hold
Don't decay automatically, hold the latest value until a new one is received.
Definition: VU.hpp:41
IncrementDecrementSelector
Selector with two buttons (one to increment, one to decrement).
Definition: IncrementDecrementSelector.hpp:67
BankDisplay
A class for displaying the setting of a Bank object.
Definition: SelectorDisplay.hpp:37
Control_Surface.h
The main header file that includes all Control-Surface header files.
MCU::MUTE_1
constexpr uint8_t MUTE_1
Definition: MCU.hpp:36
RelativeCCSender::setMode
static void setMode(relativeCCmode mode)
Definition: RelativeCCSender.hpp:105
SSD1306_DisplayInterface
This class creates a mapping between the Adafruit_SSD1306 display driver and the general display inte...
Definition: DisplayInterfaceSSD1306.hpp:13
Control_Surface
Control_Surface_ & Control_Surface
A predefined instance of the Control Surface to use in the Arduino sketches.
Definition: Control_Surface_Class.cpp:171
SSD1306_DisplayInterface::drawBackground
void drawBackground() override=0
Draw a custom background.
MCU::TimeDisplay
Definition: TimeDisplay.hpp:12
SPI_MAX_SPEED
constexpr static Frequency SPI_MAX_SPEED
Definition: Settings.hpp:113
MCU::SOLO_2
constexpr uint8_t SOLO_2
Definition: MCU.hpp:28
MCU::REC_RDY_2
constexpr uint8_t REC_RDY_2
Definition: MCU.hpp:19
FATAL_ERROR
#define FATAL_ERROR(x, e)
Definition: Error.hpp:35
Control_Surface_::begin
void begin()
Initialize the Control_Surface.
Definition: Control_Surface_Class.cpp:22
Wrap::Wrap
When the maximum (minimum) setting is reached, wrap around to the minimum (maximum) setting.
DisplayInterfaceSSD1306.hpp
MCU::VUDisplay
Definition: VUDisplay.hpp:10
MCU::PLAY
constexpr uint8_t PLAY
Definition: MCU.hpp:126
XBM::mute_10B
const XBitmap mute_10B
XBitmap mute_10B (10px × 10px)
Definition: XBitmaps.hpp:38
Bankable::NoteValue
Definition: NoteCCRange.hpp:210
XBM::record_7
const XBitmap record_7
XBitmap record_7 (7px × 7px)
Definition: XBitmaps.hpp:101
DisplayInterface::begin
virtual void begin()
Initialize the display.
Definition: DisplayInterface.cpp:7
Control_Surface_::loop
void loop()
Update all MIDI elements, send MIDI events and read MIDI input.
Definition: Control_Surface_Class.cpp:45
XBM::solo_7
const XBitmap solo_7
XBitmap solo_7 (7px × 7px)
Definition: XBitmaps.hpp:129
MCU::RUDE_SOLO
constexpr uint8_t RUDE_SOLO
Definition: MCU.hpp:146
MIDI_Notes::F
constexpr int8_t F
Definition: Notes.hpp:23