From 9431770dd47dc90154bd3a63d53cdfb131091b3c Mon Sep 17 00:00:00 2001 From: hirsch Date: Fri, 24 Jun 2016 10:14:00 -0400 Subject: [PATCH] Update README --- Makefile | 1 - README.md | 51 +++++++++++++++++++++++++++++++++++++++------------ 2 files changed, 39 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index 7a54e13..5cb97c1 100644 --- a/Makefile +++ b/Makefile @@ -7,7 +7,6 @@ DEP = $(subst .cpp,.d,$(SRC)) # The -M* switches automatically generate .d dependency files CPPFLAGS += -MP -MMD $(INCDIRS) -# LDLIBS = -ljack -lrtmidi -lusb-1.0 LDLIBS = -lrtmidi -lusb-1.0 BIN = mustang_midi diff --git a/README.md b/README.md index 0958f3f..a3da2a1 100644 --- a/README.md +++ b/README.md @@ -10,34 +10,61 @@ Mustang Floor pedal with whatever extensions are necessary to expose features added to the 'v2' series. Currently only patch change and effects on/off are implemented. -Intended to build on Linux systems with the idea of deploying on -RaspberryPi. +I am developing on a Ubuntu Precise desktop machine, but the code is +routinely tested on a Raspberry Pi 'B' and Beagelbone Green to ensure +these remain viable deployment targets. At this point I'm still +experiencing issues with USB latency on the RPi and am currently +recommending the BBG for real-world use. A special thanks to the original developer and contributors to 'PLUG', -from whence the USB interface code is stolen. +from whence the Mustang USB interface code is stolen. # Prerequisites -I'm working on Ubuntu Precise, YMMV for other distributions. + + For Ubuntu Precise or Debian Jessie: - + libjack-dev - + librtmidi-dev (2.0.1 - May need changes for newer versions) - + libusb-1.0 + - libasound2 + - librtmidi-dev + - libusb-1.0-0-dev + - libjack0 (Precise) + - libjackQ (Jessie) + +Would appreciate feedback on requirements for other distributions. + +# OS Configuration + + + Add the id of the user who will be running the bridge to the + 'audio' and 'plugdev' groups. That user should then log out and back + in to make the groups effective. + + + As root, copy the file '50-mustang.rules' to /etc/udev/rules.d and + refresh the system with 'udevadm control --reload'. + +There may be slight differences in requirements for other distributions. # Build - +``` $ make opt - +``` or - +``` $ make debug - +``` as appropriate # Run Both the amplifier and MIDI source should be connected first, then: - +``` $ mustang_midi _midi_port#_ _midi_listen_channel#_ +``` +NOTE: RPi and BBG are a bit fussy about enumeration of new USB +devices. If you are not getting proper communication, quit the program +and try replugging both the Fender amp and MIDI controller **after** +those devices are powered up. +NOTE2: I've had success using a passive USB hub with the single USB on +the BBG, but YMMV since most USB<->5Pin MIDI converters draw some +degree of bus power. A powered hub might be necessary in some +situations.