YuuichiAkagawa / USBH_MIDI

USB MIDI 1.0 class driver for Arduino USB Host Shield 2.0 Library

USBH_MIDI v1.0.0

USB-MIDI 1.0 class driver for Arduino USB Host Shield 2.0 Library

USBH_MIDI is USB-MIDI class driver for Arduino USB Host Shield 2.0 Library.
USBH_MIDI is included in USB Host Shield 2.0 Library. You don't need install separatery.

If you want use with Arduino MIDI Library, try the Transport

for single device

File->Examples->USBH_MIDI->USB_MIDI_converter

for single device with SysEx support

File->Examples->USBH_MIDI->USB_MIDI_converter_wSysEx

for multiple device (with USB hub)

File->Examples->USBH_MIDI->USB_MIDI_converter_multi

for bidirectional conversion

File->Examples->USBH_MIDI->bidirectional_converter

Examine the descriptor of your USB-MIDI device.

File->Examples->USBH_MIDI->USB_MIDI_desc If your device does not work, please report this information.

API

• uint8_t RecvData(uint8_t *outBuf)

  Receive MIDI message (3 bytes)
  return value is MIDI message length(0-3)

• uint8_t RecvData(uint16_t *bytes_rcvd, uint8_t *dataptr)

  Receive raw USB-MIDI Event Packets (each 4 bytes, upto 64 bytes)
  dataptr must allocate 64bytes buffer.
  return value is 0:Success, non-zero:Error(MAX3421E HRSLT) and bytes_rcvd is received USB packet length.
  note: USB packet length is not necessarily the length of the MIDI message.

• uint8_t RecvRawData(uint8_t *outBuf)

  Receive MIDI Event Packet (4 bytes)
  return value is MIDI message length(0-3)

• uint8_t SendData(uint8_t *dataptr, uint8_t nCable=0)

  Send MIDI message. You can set CableNumber(default=0).
  return value is 0:Success, non-zero:Error(MAX3421E HRSLT)

• uint8_t SendRawData(uint16_t bytes_send, uint8_t *dataptr)

  Send raw data. You can send any data to MIDI. (no compliant USB-MIDI event packet)
  return value is 0:Success, non-zero:Error(MAX3421E HRSLT)

• uint8_t SendSysEx(uint8_t *dataptr, uint8_t datasize, uint8_t nCable=0)

  Send SysEx MIDI message. You can set CableNumber(default=0).
  return value is 0:Success, non-zero:Error(MAX3421E HRSLT)
  note:

  • You must set first byte:0xf0 and last byte:0xf7
  • Max message length is up to 256 bytes. If you want extend it change the MIDI_MAX_SYSEX_SIZE.

• void attachOnInit(void (*funcOnInit)(void))

  Register a user function to call when the controller is successfully initialized.
  See 'eVY1_sample' example.

• void attachOnRelease(void (*funcOnRelease)(void))

  Register a user function to call when the device is removed.

• uint16_t idVendor())

  Get the vendor ID.

• uint16_t idProduct())

  Get the product ID.

• uint8_t GetAddress()

  Get the USB device address.

ChangeLog

2022.4.22 (1.0.0)

• Add OnRelease() callback.
• The timing for enabling PollEnable has been changed to before the onInit() callback.
• Update vender specific code for Novation.

2022.1.6 (0.6.1)

• Fix for RecvData(uint8_t) does not work when CableNumber(CN) is non-zero.

2021.5.9 (0.6.0)

• Change configuration descriptor parser. Supports large descriptors.
• Fixed an issue when the endpoint size exceeded 64 bytes
• Add OnInit() callback
• Add a predefined macro "USBH_MIDI_VERSION".
• Changed the method of deriving the message length
• Refine the examples

2021.1.11 (0.5.1)

• Fix for bool operator.

2020.11.23 (0.5.0)

• Change to Windows style enumeration process.

2020.11.21 (0.4.1)

• Add new example USB_MIDI_desc
• Update vender specific code for Novation

2018.03.24 (0.4.0)

• Add boolean operator
• Add idVendor()/idProduct() function. vid/pid variables have been change to private.
• Update the examples using new feature.
• Vendor/Device specific setup (workaround for novation LaunchPad series)

2017.02.22 (0.3.2)

• Improve reconnect stability.
• Fix for MIDI out only device support.
• Update SysEx code
• Remove MidiSysEx class
• Add new example USB_MIDI_converter_wSysEx
• Fix typo: the example name was corrected from 'bidrectional_converter' to 'bidirectional_converter'.

2016.04.26 (0.3.1)

• Change the type of the variables from byte to uint8_t.

2016.04.24 (0.3.0)

• Limited support for System Exclusive message on bidirectional_converter example.
• Add MidiSysEx Class for System Exclusive packet data management.

2016.04.09 (0.2.2)

• Improve SysExSend() performance.
• Add SendRawData()
• Update debug messages

2016.03.21 (0.2.1)

• Join the USB Host Shield 2.0 Library.
• Adjust indentation

2015.09.06 (0.2.0)

• Compatible with USB Host Shield 2.0 Library 1.0.0 or lator.
• Compatible with Arduino IDE 1.6.0 or lator.
• Fix for less than 64 bytes USB packet devices
• SysEx message was broken since felis/USB_Host_Shield_2.0@45df706

2014.07.06 (0.1.0)

• Merge IOP_ArduinoMIDI branch into master
• Change class name to USBH_MIDI
• Rename the function RcvData to RecvData (Old name is still available)
• Fix examples for Arduino MIDI Library 4.2 compatibility
• Add SendSysEx()
• Add new example (eVY1_sample)

2014.03.23

• Fix examples for Arduino MIDI Library 4.0 compatibility and Leonardo

2013.12.20

• Fix multiple MIDI message problem.
• Add new example (USBH_MIDI_dump)

2013.11.05

• Removed all unnecessary includes. (latest UHS2 compatibility)
• Rename all example extensions to .ino

2013.08.28

• Fix MIDI Channel issue.

2013.08.18

• RcvData() Return type is changed to uint8_t.
• Fix examples.

2012.06.22

• Support MIDI out and loosen device check

2012.04.21

• First release

License

Copyright © 2012-2021 Yuuichi Akagawa

Licensed under the GNU General Public License v2.0