Adding documentation to each of the MIDI message classes.

Adding use of note_parser() in constuctor for PolyphonicKeyPressure. #3

Author: Kevin J Walters

adafruit_midi/channel_pressure.py

@@ -49,6 +49,11 @@
 
 
 class ChannelPressure(MIDIMessage):
+    """Channel Pressure MIDI message.
+
+    :param int pressure: The pressure, 0-127.
+    """
+
     _STATUS = 0xd0
     _STATUSMASK = 0xf0
     LENGTH = 2

adafruit_midi/control_change.py

@@ -49,6 +49,13 @@
 
 
 class ControlChange(MIDIMessage):
+    """Control Change MIDI message.
+
+    :param int control: The control number, 0-127.
+    :param int value: The 7bit value of the control, 0-127.
+
+    """
+
     _STATUS = 0xb0
     _STATUSMASK = 0xf0
     LENGTH = 3

adafruit_midi/note_off.py

@@ -49,6 +49,13 @@
 
 
 class NoteOff(MIDIMessage):
+    """Note Off Change MIDI message.
+
+    :param note: The note (key) number either as an int (0-127) or a str which is parsed, e.g. "C4" (middle C) is 60, "A4" is 69.
+    :param int velocity: The release velocity, 0-127.
+
+    """
+
     _STATUS = 0x80
     _STATUSMASK = 0xf0
     LENGTH = 3

adafruit_midi/note_on.py

@@ -49,6 +49,12 @@
 
 
 class NoteOn(MIDIMessage):
+    """Note On Change MIDI message.
+
+    :param note: The note (key) number either as an int (0-127) or a str which is parsed, e.g. "C4" (middle C) is 60, "A4" is 69.
+    :param int velocity: The strike velocity, 0-127, 0 is equivalent to a Note Off.
+    """
+
     _STATUS = 0x90
     _STATUSMASK = 0xf0
     LENGTH = 3

adafruit_midi/pitch_bend_change.py

@@ -49,6 +49,11 @@
 
 
 class PitchBendChange(MIDIMessage):
+    """Pitch Bend Change MIDI message.
+
+    :param int pitch_bend: A 14bit unsigned int representing the degree of bend from 0 through 8192 (midpoint, no bend) to 16383.
+    """
+
     _STATUS = 0xe0
     _STATUSMASK = 0xf0
     LENGTH = 3

adafruit_midi/polyphonic_key_pressure.py

@@ -42,20 +42,26 @@
 
 """
 
-from .midi_message import MIDIMessage
+from .midi_message import MIDIMessage, note_parser
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MIDI.git"
 
 
 class PolyphonicKeyPressure(MIDIMessage):
+    """Polyphonic Key Pressure MIDI message.
+
+    :param note: The note (key) number either as an int (0-127) or a str which is parsed, e.g. "C4" (middle C) is 60, "A4" is 69.
+    :param int pressure: The pressure, 0-127.
+    """
+
     _STATUS = 0xa0
     _STATUSMASK = 0xf0
     LENGTH = 3
     CHANNELMASK = 0x0f
 
     def __init__(self, note, pressure):
-        self.note = note
+        self.note = note_parser(note)
         self.pressure = pressure
         if not 0 <= self.note <= 127 or not 0 <= self.pressure <= 127:
             raise ValueError("Out of range")

adafruit_midi/program_change.py

@@ -49,6 +49,11 @@
 
 
 class ProgramChange(MIDIMessage):
+    """Program Change MIDI message.
+
+    :param int patch: The new program/patch number to use, 0-127.
+    """
+
     _STATUS = 0xc0
     _STATUSMASK = 0xf0
     LENGTH = 2

adafruit_midi/start.py

@@ -49,6 +49,9 @@
 
 
 class Start(MIDIMessage):
+    """Start MIDI message.
+    """
+
     _STATUS = 0xfa
     _STATUSMASK = 0xff
     LENGTH = 1

adafruit_midi/stop.py

@@ -49,6 +49,8 @@
 
 
 class Stop(MIDIMessage):
+    """Stop MIDI message.
+    """
     _STATUS = 0xfc
     _STATUSMASK = 0xff
     LENGTH = 1

adafruit_midi/system_exclusive.py

@@ -49,6 +49,12 @@
 
 
 class SystemExclusive(MIDIMessage):
+    """System Exclusive MIDI message.
+
+    :param list manufacturer_id: The single byte or three byte manufacturer's id as a list or bytearray of numbers between 0-127.
+    :param list data: The 7bit data as a list or bytearray of numbers between 0-127.
+    """
+
     _STATUS = 0xf0
     _STATUSMASK = 0xff
     LENGTH = -1