circuitpython-tmidi 1.0.4__tar.gz → 2.0.0__tar.gz

circuitpython_tmidi-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/.readthedocs.yaml

@@ -8,6 +8,9 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-20.04
   tools:

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: circuitpython-tmidi
-Version: 1.0.4
+Version: 2.0.0
 Summary: MIDI library for CircuitPython
 Author-email: Tod Kurt <tod@todbot.com>
 License: MIT
@@ -109,8 +109,9 @@ Usage Example
 
     midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])
 
-    def send_midi_panic(channel=1):
-        msg = tmidi.Message(tmidi.NOTE_OFF, channel-1)  # channels are 0-indexed
+    def send_midi_panic(midi_channel=1):
+        ch = midi_channel-1
+        msg = tmidi.Message(tmidi.NOTE_OFF, channel=ch)  # channels are 0-indexed
         for notenum in range(128):
             msg.note = notenum
             msg.velocity = 0
@@ -128,6 +129,12 @@ API documentation for this library can be found on `Read the Docs <https://circu
 For information on building library documentation, please check out
 `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
 
+Testing
+=======
+
+Install ``pytest`` with ``pip3 install pytest --upgrade`` and run ``pytest -v``
+To build docs:
+
 Contributing
 ============
 

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/README.rst

@@ -89,8 +89,9 @@ Usage Example
 
     midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])
 
-    def send_midi_panic(channel=1):
-        msg = tmidi.Message(tmidi.NOTE_OFF, channel-1)  # channels are 0-indexed
+    def send_midi_panic(midi_channel=1):
+        ch = midi_channel-1
+        msg = tmidi.Message(tmidi.NOTE_OFF, channel=ch)  # channels are 0-indexed
         for notenum in range(128):
             msg.note = notenum
             msg.velocity = 0
@@ -108,6 +109,12 @@ API documentation for this library can be found on `Read the Docs <https://circu
 For information on building library documentation, please check out
 `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
 
+Testing
+=======
+
+Install ``pytest`` with ``pip3 install pytest --upgrade`` and run ``pytest -v``
+To build docs:
+
 Contributing
 ============
 

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/circuitpython_tmidi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: circuitpython-tmidi
-Version: 1.0.4
+Version: 2.0.0
 Summary: MIDI library for CircuitPython
 Author-email: Tod Kurt <tod@todbot.com>
 License: MIT
@@ -109,8 +109,9 @@ Usage Example
 
     midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])
 
-    def send_midi_panic(channel=1):
-        msg = tmidi.Message(tmidi.NOTE_OFF, channel-1)  # channels are 0-indexed
+    def send_midi_panic(midi_channel=1):
+        ch = midi_channel-1
+        msg = tmidi.Message(tmidi.NOTE_OFF, channel=ch)  # channels are 0-indexed
         for notenum in range(128):
             msg.note = notenum
             msg.velocity = 0
@@ -128,6 +129,12 @@ API documentation for this library can be found on `Read the Docs <https://circu
 For information on building library documentation, please check out
 `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
 
+Testing
+=======
+
+Install ``pytest`` with ``pip3 install pytest --upgrade`` and run ``pytest -v``
+To build docs:
+
 Contributing
 ============
 

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/circuitpython_tmidi.egg-info/SOURCES.txt

@@ -35,7 +35,10 @@ docs/_static/favicon.ico
 docs/_static/favicon.ico.license
 examples/tmidi_midiforwarder.py
 examples/tmidi_multiple_receiver.py
+examples/tmidi_simple_arpeggiator.py
 examples/tmidi_simple_receiver.py
 examples/tmidi_simpletest.py
+tests/__init__.py
 tests/test_one.py
+tests/test_tmidi_messages.py
 tests/test_tmidi_one.py

circuitpython_tmidi-2.0.0/docs/examples.rst

@@ -0,0 +1,37 @@
+Simple test
+------------
+
+Show how to send MIDI messages.
+
+.. literalinclude:: ../examples/tmidi_simpletest.py
+    :caption: examples/tmidi_simpletest.py
+    :linenos:
+
+
+Simple receiver
+---------------
+
+Show to to receive MIDI messages.
+
+.. literalinclude:: ../examples/tmidi_simple_receiver.py
+    :caption: examples/tmidi_simple_receiver.py
+    :linenos:
+
+
+Multiple receivers
+------------------
+
+Show to to receive MIDI messages from multiple receivers.
+
+.. literalinclude:: ../examples/tmidi_multiple_receiver.py
+    :caption: examples/tmidi_multiple_receiver.py
+    :linenos:
+
+Simple arpeggiator
+------------------
+
+Implement a simple arpeggiator that receives MIDI and sends it
+
+.. literalinclude:: ../examples/tmidi_simple_arpeggiator.py
+    :caption: examples/tmidi_simple_arpeggiator.py
+    :linenos:

circuitpython_tmidi-2.0.0/examples/tmidi_simple_arpeggiator.py

@@ -0,0 +1,58 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 Tod Kurt
+#
+# SPDX-License-Identifier: MIT
+
+# This example shows both receiving and sending MIDI messages
+# by implementing a simple arpeggiator.
+# MIDI notes send to MIDI In are arpeggiated to MIDI Output.
+
+import time
+import usb_midi
+import tmidi
+
+midi = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])
+# if serial midi
+# uart = busio.UART(rx=board.RX, tx=board.TX, timeout=0.000)
+# midi = tmidi.MIDI(midi_in=uart, midi_out=uart)
+
+tempo = 120  # bpm
+notes_per_beat = 2  # 1 = quarter-note, 2 = 8th, 4 = 16th
+note_time = 60 / tempo / notes_per_beat
+gate_percent = 0.5
+
+pressed_notes = []
+note_i = 0
+last_note_time = 0
+gate_time = 0
+while True:
+    # handle midi input
+    if msg := midi.receive():
+        if msg.type == tmidi.NOTE_ON and msg.velocity > 0:
+            print("note on", msg)
+            pressed_notes.append(msg.note)
+        elif msg.type == tmidi.NOTE_OFF or (
+            msg.type == tmidi.NOTE_ON and msg.velocity == 0
+        ):
+            if msg.note in pressed_notes:
+                midi.send(msg)  # send the note off
+                pressed_notes.remove(msg.note)
+                note_i = 0
+
+    # do midi output
+    if len(pressed_notes) == 0:
+        continue
+
+    now = time.monotonic()
+    if now - last_note_time >= note_time:
+        last_note_time = now
+        note_on = tmidi.Message(tmidi.NOTE_ON, pressed_notes[note_i], 127)
+        print("arp note_on: ", note_on)
+        midi.send(note_on)
+        gate_time = note_time * gate_percent
+
+    if gate_time > 0 and now - last_note_time >= gate_time:
+        gate_time = 0
+        note_off = tmidi.Message(tmidi.NOTE_OFF, pressed_notes[note_i], 127)
+        print("arp note_off:", note_off)
+        midi.send(note_off)
+        note_i = (note_i + 1) % len(pressed_notes)

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/examples/tmidi_simple_receiver.py

@@ -12,6 +12,20 @@ midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])
 while True:
     if msg := midi_usb.receive():
         if msg.type == tmidi.NOTE_ON and msg.velocity > 0:
-            print("note on: ", msg.note, msg.velocity)
+            print(
+                "note on: note:",
+                msg.note,
+                "vel:",
+                msg.velocity,
+                "channel:",
+                msg.channel,
+            )
         elif msg.type == tmidi.NOTE_OFF or msg.velocity == 0:
-            print("note off:", msg.note, msg.velocity)
+            print(
+                "note off: note:",
+                msg.note,
+                "vel:",
+                msg.velocity,
+                "channel:",
+                msg.channel,
+            )

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/examples/tmidi_simpletest.py

@@ -18,12 +18,12 @@ while True:
     notenum = random.randint(36, 72)
     velocity = 127
 
-    msg_on = tmidi.Message(tmidi.NOTE_ON, midi_channel - 1, notenum, velocity)
+    msg_on = tmidi.Message(tmidi.NOTE_ON, notenum, velocity, channel=midi_channel - 1)
     print("sending note on  msg:", msg_on)
     midi_usb.send(msg_on)
     time.sleep(0.1)
 
-    msg_off = tmidi.Message(tmidi.NOTE_OFF, midi_channel - 1, notenum, 0)
+    msg_off = tmidi.Message(tmidi.NOTE_OFF, notenum, 0, channel=midi_channel - 1)
     print("sending note off msg:", msg_off)
     midi_usb.send(msg_off)
     time.sleep(0.2)

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/pyproject.toml

@@ -13,7 +13,7 @@ requires = [
 [project]
 name = "circuitpython-tmidi"
 description = "MIDI library for CircuitPython"
-version = "1.0.4"
+version = "2.0.0"
 readme = "README.rst"
 authors = [
     {name = "Tod Kurt", email = "tod@todbot.com"}

circuitpython_tmidi-2.0.0/tests/__init__.py

@@ -0,0 +1,2 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 Tod Kurt
+# SPDX-License-Identifier: MIT

circuitpython_tmidi-2.0.0/tests/test_tmidi_messages.py

@@ -0,0 +1,46 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 Tod Kurt
+# SPDX-License-Identifier: MIT
+
+
+import tmidi
+
+
+class PortStub:
+    def __init__(self, data):
+        self.data = data
+        self.expected = None
+
+    def write(self, buf, nbytes):
+        assert self.expected == list(buf)
+
+
+def test_message_note_on():
+    msg = tmidi.Message(tmidi.NOTE_ON, 64, 123)
+    assert str(msg) == "Message(NoteOn ch:0 64 123)"
+
+
+def test_message_program_change():
+    msg = tmidi.Message(tmidi.PROGRAM_CHANGE, 120, channel=11)
+    assert str(msg) == "Message(ProgramChange ch:11 120)"
+
+
+def test_message_note_on_send():
+    port = PortStub(iter([]))
+    midi_out = tmidi.MIDI(midi_out=port)
+
+    msg = tmidi.Message(tmidi.NOTE_ON, 64, 123)
+    port.expected = [0x90, 64, 123]
+    midi_out.send(msg)
+
+    msg = tmidi.Message(tmidi.NOTE_ON, 32, 111, channel=3)
+    port.expected = [0x93, 32, 111]
+    midi_out.send(msg)
+
+
+def test_message_program_change_send():
+    port = PortStub(iter([]))
+    midi_out = tmidi.MIDI(midi_out=port)
+
+    msg = tmidi.Message(tmidi.PROGRAM_CHANGE, 33)
+    port.expected = [0xC0, 33]
+    midi_out.send(msg)

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/tests/test_tmidi_one.py

@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024 Tod Kurt
 # SPDX-License-Identifier: MIT
 
-import pytest  # pylint: disable=unused-import
 
 import tmidi
 
@@ -33,7 +32,7 @@ class PortStub:
 
         return bytes_read
 
-    def write(self, buf):
+    def write(self, buf, n):
         pass
 
 

{circuitpython_tmidi-1.0.4 → circuitpython_tmidi-2.0.0}/tmidi.py

@@ -32,7 +32,7 @@ Implementation Notes
 
 # imports
 
-__version__ = "1.0.4"
+__version__ = "2.0.0"
 __repo__ = "https://github.com/todbot/CircuitPython_TMIDI.git"
 
 # Portions of this library come from Winterbloom_SmolMIDI:
@@ -144,7 +144,6 @@ _MSG_TYPE_NAMES = {
 }
 
 
-# pylint: disable=chained-comparison
 def _is_channel_message(status_byte):
     return status_byte >= NOTE_OFF and status_byte < SYSEX
 
@@ -174,25 +173,37 @@ class Message:
     MIDI Message.
 
     :param mtype: The type of message, e.g. tmidi.NOTE_ON.
-    :param channel: The MIDI channel for this message, if applicable (0-15)
     :param data0: The first data byte for this message,
         e.g. the note number as an ``int`` (0-127) for NOTE_ON messages.
     :param data1: The second data byte for this message,
         e.g. the velocity (0-127) for NOTE_ON messages.
+    :param channel: The MIDI channel for this message, if applicable (0-15)
+
+    Example of creating Messages:
+
+    .. code-block:: python
+
+        # create Note On middle-C message on ch 1 (0-indexed)
+        m = Message(tmidi.NOTE_ON, 60, 127, channel=0)
+        # create CC 74 with val 63 on ch 4
+        m = Message(tmidi.CC, 74, 63, channel=4-1)
+        # create a pitch bend full up on ch 1
+        m = Message(tmidi.PITCH_BEND, 8191)
+
+    Example of creating accessing Message attributes:
+
+    .. code-block:: python
+
+        if msg := midi.receive():
+            if msg.type == tmidi.NOTE_ON:
+              print("note on:", msg.note, msg.velocity)
+            elif msg.type == tmidi.NOTE_OFF:
+              print("note off:", msg.note, msg.velocity)
+            elif msg.type == tmidi.PROGRAM_CHANGE:
+              print("program change:", msg.value)
     """
 
-    def __init__(self, mtype=SYSTEM_RESET, channel=None, data0=0, data1=0):
-        """
-        Create a MIDI Message.
-
-        Example::
-            # create Note On middle-C message on ch1 (0-indexed)
-            m = Message(tmidi.NOTE_ON, 0, 60, 127)
-            # create CC 74 with val 63 on ch 4
-            m = Message(tmidi.CC, 3, 74, 63)
-            # create a pitch bend full up on ch 1
-            m = Message(tmidi.PITCH_BEND, 0, 8191)
-        """
+    def __init__(self, mtype=SYSTEM_RESET, data0=0, data1=0, channel=0):
         self.type = mtype
         self.channel = channel
         self.data0 = data0
@@ -204,16 +215,15 @@ class Message:
         status_byte = self.type
         if _is_channel_message(status_byte):
             status_byte |= self.channel
-        if status_byte in _LEN_2_MESSAGES:
+        if self.type in _LEN_2_MESSAGES:
             return bytes([status_byte, self.data0, self.data1])
-        if status_byte in _LEN_1_MESSAGES:
+        elif self.type in _LEN_1_MESSAGES:
             return bytes([status_byte, self.data0])
         return bytes([status_byte])
 
     def __repr__(self):
         return self.__str__()
 
-    # pylint: disable=consider-using-f-string
     def __str__(self):
         mtype = self.type
         type_str = "Message(" + _MSG_TYPE_NAMES.get(mtype, "Unknown")
@@ -246,7 +256,7 @@ class Message:
 
     @property
     def pitch_bend(self):
-        """Pitch bend value of message (only for PITCH_BEND msgs)"""
+        """Pitch bend value of message (only valid for PITCH_BEND msgs)"""
         return (self.data1 << 7 | self.data0) - 8192
 
     @pitch_bend.setter
@@ -255,10 +265,19 @@ class Message:
         self.data0 = pbval & 0x7F
         self.data1 = pbval >> 7
 
+    @property
+    def value(self):
+        """Message value, only valid for len1 messages (Program Change, etc)"""
+        return self.data0
+
+    @value.setter
+    def value(self, val):
+        self.data0 = val
+
 
 class MIDI:
     """
-    MIDI Parser and sender
+    MIDI Parser, receiver and sender
     ``midi_in`` or ``midi_out`` *must* be set or both together.
 
     :param midi_in: an object which implements ``read(length)``,
@@ -266,6 +285,46 @@ class MIDI:
     :param midi_out: an object which implements ``write(buffer, length)``,
         set to ``usb_midi.ports[1]`` for USB MIDI, default None.
     :param bool enable_running_status: Allow running status messages to work, default False.
+
+    Example of sending MIDI over USB:
+
+    .. code-block:: python
+
+        import usb_midi
+        import tmidi
+        midi_usb = tmidi.MIDI(midi_out=usb_midi.ports[1])
+        msg_on = tmidi.Message(tmidi.NOTE_ON, notenum, velocity)
+        midi_usb.send(msg_on)
+
+    Example of sending MIDI over UART (TRS or 5-pin):
+
+    .. code-block:: python
+
+        import board
+        import busio
+        import tmidi
+        uart = busio.UART(tx=board.TX, rx=board.RX, timeout=0.001)
+        midi_uart = tmidi.MIDI(midi_out=uart)
+        msg_on = tmidi.Message(tmidi.NOTE_ON, notenum, velocity)
+        midi_uart.send(msg_on)
+
+    Example of receiving MIDI:
+
+    .. code-block:: python
+
+        import board
+        import busio
+        import usb_midi
+        import tmidi
+        uart = busio.UART(tx=board.TX, rx=board.RX, timeout=0.001)
+        midi_uart = tmidi.MIDI(midi_in=uart, midi_out=uart)
+        midi_usb = tmidi.MIDI(midi_in=usb_midi.ports[0], midi_out=usb_midi.ports[1])
+
+        while True:
+            if msg := midi_usb.receive():
+                print("usb midi:", msg)
+            if msg := midi_uart.receive():
+                print("uart midi:", msg)
     """
 
     def __init__(self, midi_in=None, midi_out=None, enable_running_status=False):
@@ -341,7 +400,6 @@ class MIDI:
 
         return message
 
-    # pylint: disable=unnecessary-dunder-call
     def send(self, msg, channel=None):
         """Send a MIDI message.
 

circuitpython_tmidi-1.0.4/.pre-commit-config.yaml

@@ -1,46 +0,0 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
-#
-# SPDX-License-Identifier: Unlicense
-
-default_language_version:
-    # force all unspecified python hooks to run python3.11
-    python: python3.11
-
-repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.4
-    hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code

circuitpython_tmidi-1.0.4/docs/examples.rst

@@ -1,18 +0,0 @@
-Simple test
-------------
-
-Show how to send MIDI messages.
-
-.. literalinclude:: ../examples/tmidi_simpletest.py
-    :caption: examples/tmidi_simpletest.py
-    :linenos:
-
-
-Simple receiver
----------------
-
-Show to to receive MIDI messages.
-
-.. literalinclude:: ../examples/tmidi_simple_receiver.py
-    :caption: examples/tmidi_simple_receiver.py
-    :linenos: