README.md

Table of Contents

• Setup
• Getting Started
• Colors
• Displaying Text
  • Basics
  • Speed
  • Completion
• TODO

Setup

Add this to your pom.xml:

<dependency>
  <groupId>io.cassaundra</groupId>
  <artifactId>rocket</artifactId>
  <version>2.0.0</version>
</dependency>

Alternatively, with Gradle:

dependencies {
  compile 'io.cassaundra:rocket:2.0.0'
}

Getting Started

val rocket = Rocket()

with(rocket) {
	// Allow MIDI scanning to begin
	beginMidiScan()
	
	// Listen for input events
	addListener(object : LaunchpadListener {
		override fun onPadDown(pad: Pad) {
			setPad(pad, Color.WHITE)
		}
	
		override fun onPadUp(pad: Pad) {
			setPad(pad, Color.OFF)
		}
	
		override fun onButtonDown(button: Button) {
			if(button.isTop)
				setButton(button, Color.RED)
			else
				setButton(button, Color.BLUE)
		}
	
		override fun onButtonUp(button: Button) {
			setButton(button, Color.OFF)
		}
	})
}

Similarly, in Java...

Rocket rocket = new Rocket();

// Allow MIDI scanning to begin
rocket.beginMidiScan();

// Listen for input events
rocket.addListener(new LaunchpadListener() {
    public void onPadDown(Pad pad) {
        rocket.setPad(pad, Color.WHITE);
    }

    public void onPadUp(@NotNull Pad pad) {
        rocket.setPad(pad, Color.OFF);
    }

    public void onButtonDown(@NotNull Button button) {
        if(button.isTop())
            rocket.setButton(button, Color.RED);
        else
            rocket.setButton(button, Color.BLUE);
    }

    public void onButtonUp(@NotNull Button button) {
        rocket.setButton(button, Color.OFF);
    }
});

Now you're on your way to creating a full Launchpad app!

Colors

You can use custom colors by specifying RGB int values between 0 and 63 inclusive.

val color = Color(42, 0, 30)

In Java,

Color color = new Color(42, 0, 30);

If you want to convert an HSV value to a Launchpad color, use Color.fromHSV, with each value a float in the range 0 to 1.

Color.fromHSV(.5f, 1f, 1f)

Displaying Text

Basics

You can call the Launchpad's built-in MIDI command for displaying text with Launchpad.displayText.

rocket.displayText(
    "Hello world!"
)

In Java,

rocket.displayText(
    "Hello world!"
);

Speed

You can control the text scrolling speed per-character with seven different available speeds in TextSpeed.

rocket.displayText(
    "Hello! ${TextSpeed.SPEED_1}Let's take this slower."
)

In Java,

rocket.displayText(
    "Hello! " + TextSpeed.SPEED_1 + "Let's take this slower."
);

Completion

If you need to know when text has finished scrolling, you can use the onComplete argument.

rocket.displayText(
    "Hello world!",
    onComplete = Runnable { println("Done!") }
)

In Java,

rocket.displayText(
    "Hello world!"
);

Utils

Pad.Util provides several useful utility functions, like rectangles, line segments, and more.

TODO

• Add contributing documentation
• Add support for multiple Launchpads (I have only one)
• Use Gradle instead of Maven
• Add more unit tests!