digital-trigger 0.1.2__tar.gz → 0.1.3__tar.gz

digital_trigger-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Max Lovell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{digital_trigger-0.1.2 → digital_trigger-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digital-trigger
-Version: 0.1.2
+Version: 0.1.3
 Summary: Simple class for simplified pySerial interface for use in TTL event marking using e.g. PsychoPy.
 Author-email: Max Lovell <max_lovell@hotmail.co.uk>
 License-Expression: MIT
@@ -19,7 +19,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: pyserial>=3.0
+Dynamic: license-file
 
 # digital-trigger
 
@@ -36,14 +38,6 @@ Requires Python 3.8+ and [`pyserial`](https://pypi.org/project/pyserial/) (insta
 In PsychoPy you can install packages in the Builder GUI by going to: 
 Tools > Plugins and packages manager > Packages > Open PIP terminal, and run  `pip install digital-trigger`
 
-To find COM port number: 
-- run the command `python -m serial.tools.list_ports -v`
-- On Windows, open Device Manager, expand "Ports (COM & LPT)", unplug and replug to see which is your device
-- On Mac run `ls /dev/cu.*` in Terminal and look for something like /dev/cu.usbserial-XXXX or /dev/cu.usbmodemXXXX — use the cu.* name, not tty.*. 
-- On Linux, run ls `/dev/ttyUSB* /dev/ttyACM*` — USB-serial adapters are usually `ttyUSB0`
-- Arduino-style boards `ttyACM0; dmesg | tail` right after plugging in shows the assigned name, and you may need to add yourself to the dialout group for permission.
-
-Make sure your COM port is set up with a latency of 1ms (or lower) and Baudrate of 115200. This can be done under Device Manager > COM port > Advanced on Windows.
 
 ## Usage
 
@@ -60,34 +54,21 @@ from digital_trigger import Trigger
 port = Trigger('COM4', names=['cond_1', 'cond_2', 'stim_1', 'stim_2'])
 ```
 
-Note you can only do this once per experiment. 
-Don't do this in multiple code blocks in different routines or you will get a 'access/permission denied' error. 
-Probably best to have a single code block jsut for this in your first routine even.
-
-#### Begin Routine
-```
-trigger_opened = False
-trigger_closed = False
-```
+Note you can only do this once per experiment or you will get an 'access/permission denied' error.
+Watch out if you insert the same routine twice as a copy.
 
 #### Each Frame 
 ```
-# Open the line the instant the stimulus is drawn to the screen...
-# Change 'image' to the name of your stimulus component
-if image.status == STARTED and not trigger_opened:
-    win.callOnFlip(port.open, 'stim_1')
-    trigger_opened = True
+if image.status == STARTED and port.is_closed(condition):
+    win.callOnFlip(port.open, condition)
 
-# ...and close it the instant the stimulus is removed.
-if image.status == FINISHED and not trigger_closed:
-    win.callOnFlip(port.close, 'stim_1')
-    trigger_closed = True
+if image.status == FINISHED and port.is_open(condition):
+    win.callOnFlip(port.close, condition)
 ```
 
-#### End Routine
+OR, more simply:
 ```
-if not trigger_closed:
-    port.close('stim_1')
+port.sync_to_component(condition, image, win)
 ```
 
 #### End Experiment
@@ -119,7 +100,44 @@ with Trigger('COM4', names=['stim_1']) as port:
     port.open('stim_1')
 ```
 
-Resources:
+## Issues
+
+### Finding COM port number
+To find COM port number: 
+- run the command `python -m serial.tools.list_ports -v`
+- On Windows, open Device Manager, expand "Ports (COM & LPT)", unplug and replug to see which is your device
+- On Mac run `ls /dev/cu.*` in Terminal and look for something like /dev/cu.usbserial-XXXX or /dev/cu.usbmodemXXXX — use the cu.* name, not tty.*. 
+- On Linux, run ls `/dev/ttyUSB* /dev/ttyACM*` — USB-serial adapters are usually `ttyUSB0`
+- Arduino-style boards `ttyACM0; dmesg | tail` right after plugging in shows the assigned name, and you may need to add yourself to the dialout group for permission.
+
+Make sure your COM port is set up with a latency of 1ms (or lower) and Baudrate of 115200. This can be done under Device Manager > COM port > Advanced on Windows.
+
+### Module not found on Mac
+`ModuleNotFoundError: No module named 'digital_trigger'` error on Mac: PsychoPy 2025 issue with install path typo.
+Confirm by running this inside a code component in psychopy: 
+```
+import sys
+print(sys.executable)
+for p in sys.path:
+    print("  ", p)
+```
+see if package is installed to python3.1 instead of python3.10.
+- also `show digital-trigger` in PsychoPy's pip terminal (after running `install digital-trigger`) should also state that the package is installed.
+- try `find ~/.psychopy3 /Applications/PsychoPy.app -name "digital_trigger*" 2>/dev/null` in terminal
+
+Either install directly using `/Applications/PsychoPy.app/Contents/MacOS/python -m pip install \
+    --target ~/.psychopy3/packages/lib/python/site-packages \
+    digital-trigger`
+or move the directory by running this in a terminal:
+```
+mv /Applications/PsychoPy.app/Contents/Resources/lib/python3.10/site-packages/digital_trigger \
+   ~/.psychopy3/packages/lib/python/site-packages/
+
+mv /Applications/PsychoPy.app/Contents/Resources/lib/python3.10/site-packages/digital_trigger-0.1.2.dist-info \
+   ~/.psychopy3/packages/lib/python/site-packages/
+```
+
+## Resources:
 - https://www.blackboxtoolkit.com/support_usb_ttl_module.html
 - https://www.blackboxtoolkit.com/docs/pdf/USBTTLv1r19.pdf
 - https://psychopy.org/developers/pluginDevGuide.html#plugindevguide
@@ -139,9 +157,11 @@ re-run build:
 rm -rf dist                # clear old builds so nothing stale is uploaded
 python3 -m build
 ls dist                    # confirm the new version number is shown
-twine upload --repository testpypi dist/*
 ```
 
+Push to PyPi test with `twine upload --repository testpypi dist/*`
+Push to PyPi with `twine upload dist/*`
+
 #### test
 
 ```
@@ -172,5 +192,12 @@ print('ok', t.bitmask)
 #### release
 ```
 cd /path/to/project         # back to the project folder
+rm -rf dist
+python -m build
 twine upload dist/*         # no --repository = real PyPI
 ```
+OR github:
+Releases > Draft a new release.
+Choose a tag: type v0.1.3, click "Create new tag: v0.1.3 on publish".
+Title: v0.1.3. Description: brief notes on what changed.
+Click Publish release.

{digital_trigger-0.1.2 → digital_trigger-0.1.3}/README.md

@@ -13,14 +13,6 @@ Requires Python 3.8+ and [`pyserial`](https://pypi.org/project/pyserial/) (insta
 In PsychoPy you can install packages in the Builder GUI by going to: 
 Tools > Plugins and packages manager > Packages > Open PIP terminal, and run  `pip install digital-trigger`
 
-To find COM port number: 
-- run the command `python -m serial.tools.list_ports -v`
-- On Windows, open Device Manager, expand "Ports (COM & LPT)", unplug and replug to see which is your device
-- On Mac run `ls /dev/cu.*` in Terminal and look for something like /dev/cu.usbserial-XXXX or /dev/cu.usbmodemXXXX — use the cu.* name, not tty.*. 
-- On Linux, run ls `/dev/ttyUSB* /dev/ttyACM*` — USB-serial adapters are usually `ttyUSB0`
-- Arduino-style boards `ttyACM0; dmesg | tail` right after plugging in shows the assigned name, and you may need to add yourself to the dialout group for permission.
-
-Make sure your COM port is set up with a latency of 1ms (or lower) and Baudrate of 115200. This can be done under Device Manager > COM port > Advanced on Windows.
 
 ## Usage
 
@@ -37,34 +29,21 @@ from digital_trigger import Trigger
 port = Trigger('COM4', names=['cond_1', 'cond_2', 'stim_1', 'stim_2'])
 ```
 
-Note you can only do this once per experiment. 
-Don't do this in multiple code blocks in different routines or you will get a 'access/permission denied' error. 
-Probably best to have a single code block jsut for this in your first routine even.
-
-#### Begin Routine
-```
-trigger_opened = False
-trigger_closed = False
-```
+Note you can only do this once per experiment or you will get an 'access/permission denied' error.
+Watch out if you insert the same routine twice as a copy.
 
 #### Each Frame 
 ```
-# Open the line the instant the stimulus is drawn to the screen...
-# Change 'image' to the name of your stimulus component
-if image.status == STARTED and not trigger_opened:
-    win.callOnFlip(port.open, 'stim_1')
-    trigger_opened = True
+if image.status == STARTED and port.is_closed(condition):
+    win.callOnFlip(port.open, condition)
 
-# ...and close it the instant the stimulus is removed.
-if image.status == FINISHED and not trigger_closed:
-    win.callOnFlip(port.close, 'stim_1')
-    trigger_closed = True
+if image.status == FINISHED and port.is_open(condition):
+    win.callOnFlip(port.close, condition)
 ```
 
-#### End Routine
+OR, more simply:
 ```
-if not trigger_closed:
-    port.close('stim_1')
+port.sync_to_component(condition, image, win)
 ```
 
 #### End Experiment
@@ -96,7 +75,44 @@ with Trigger('COM4', names=['stim_1']) as port:
     port.open('stim_1')
 ```
 
-Resources:
+## Issues
+
+### Finding COM port number
+To find COM port number: 
+- run the command `python -m serial.tools.list_ports -v`
+- On Windows, open Device Manager, expand "Ports (COM & LPT)", unplug and replug to see which is your device
+- On Mac run `ls /dev/cu.*` in Terminal and look for something like /dev/cu.usbserial-XXXX or /dev/cu.usbmodemXXXX — use the cu.* name, not tty.*. 
+- On Linux, run ls `/dev/ttyUSB* /dev/ttyACM*` — USB-serial adapters are usually `ttyUSB0`
+- Arduino-style boards `ttyACM0; dmesg | tail` right after plugging in shows the assigned name, and you may need to add yourself to the dialout group for permission.
+
+Make sure your COM port is set up with a latency of 1ms (or lower) and Baudrate of 115200. This can be done under Device Manager > COM port > Advanced on Windows.
+
+### Module not found on Mac
+`ModuleNotFoundError: No module named 'digital_trigger'` error on Mac: PsychoPy 2025 issue with install path typo.
+Confirm by running this inside a code component in psychopy: 
+```
+import sys
+print(sys.executable)
+for p in sys.path:
+    print("  ", p)
+```
+see if package is installed to python3.1 instead of python3.10.
+- also `show digital-trigger` in PsychoPy's pip terminal (after running `install digital-trigger`) should also state that the package is installed.
+- try `find ~/.psychopy3 /Applications/PsychoPy.app -name "digital_trigger*" 2>/dev/null` in terminal
+
+Either install directly using `/Applications/PsychoPy.app/Contents/MacOS/python -m pip install \
+    --target ~/.psychopy3/packages/lib/python/site-packages \
+    digital-trigger`
+or move the directory by running this in a terminal:
+```
+mv /Applications/PsychoPy.app/Contents/Resources/lib/python3.10/site-packages/digital_trigger \
+   ~/.psychopy3/packages/lib/python/site-packages/
+
+mv /Applications/PsychoPy.app/Contents/Resources/lib/python3.10/site-packages/digital_trigger-0.1.2.dist-info \
+   ~/.psychopy3/packages/lib/python/site-packages/
+```
+
+## Resources:
 - https://www.blackboxtoolkit.com/support_usb_ttl_module.html
 - https://www.blackboxtoolkit.com/docs/pdf/USBTTLv1r19.pdf
 - https://psychopy.org/developers/pluginDevGuide.html#plugindevguide
@@ -116,9 +132,11 @@ re-run build:
 rm -rf dist                # clear old builds so nothing stale is uploaded
 python3 -m build
 ls dist                    # confirm the new version number is shown
-twine upload --repository testpypi dist/*
 ```
 
+Push to PyPi test with `twine upload --repository testpypi dist/*`
+Push to PyPi with `twine upload dist/*`
+
 #### test
 
 ```
@@ -149,5 +167,12 @@ print('ok', t.bitmask)
 #### release
 ```
 cd /path/to/project         # back to the project folder
+rm -rf dist
+python -m build
 twine upload dist/*         # no --repository = real PyPI
-```
+```
+OR github:
+Releases > Draft a new release.
+Choose a tag: type v0.1.3, click "Create new tag: v0.1.3 on publish".
+Title: v0.1.3. Description: brief notes on what changed.
+Click Publish release.

{digital_trigger-0.1.2 → digital_trigger-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "digital-trigger"
-version = "0.1.2"
+version = "0.1.3"
 description = "Simple class for simplified pySerial interface for use in TTL event marking using e.g. PsychoPy."
 readme = "README.md"
 requires-python = ">=3.8"

{digital_trigger-0.1.2 → digital_trigger-0.1.3}/src/digital_trigger/trigger.py

@@ -1,4 +1,5 @@
 import serial
+import atexit
 
 class Trigger:
     def __init__(self, port='COM3', baudrate=115200, timeout=0, names=None, simulate=False):
@@ -9,6 +10,7 @@ class Trigger:
             self.port = serial.Serial(port, baudrate, timeout=timeout)
             self.reset()
             self.write()
+            atexit.register(self.stop)
 
     # -- line number handling ------------------------------------------
 
@@ -70,13 +72,23 @@ class Trigger:
             # self.open_lines()
 
     def stop(self):
+        if self.simulate or not hasattr(self, 'port') or not self.port.is_open:
+            return  # already stopped, or never opened
         print('Shutting down port')
-        if not self.simulate:
-            self.reset()
-            self.port.close()
-            print('Port is closed: ', not self.port.is_open)
+        self.reset()
+        self.port.close()
+        print('Port is closed: ', not self.port.is_open)
 
     # -- OPTIONAL EXTRAS -------------------------------------------------
+    def sync_to_component(self, line, component, win):
+        # TODO: this only really works with a single line due to is_closed() etc, so consider a rewrite there
+        # see https://github.com/psychopy/psychopy/blob/dev/psychopy/constants.py
+        # consider lazy import of `from psychopy.constants import STARTED, FINISHED` instead of ints
+        if component.status == 1 and self.is_closed(line):
+            win.callOnFlip(self.open, line)
+        elif component.status == -1 and self.is_open(line):
+            win.callOnFlip(self.close, line)
+
     # -- display -------------------------------------------------
 
     def is_open(self, lines):
@@ -119,8 +131,17 @@ class Trigger:
                 line_names.append('unnamed')
         return line_names
 
+    def hex(self):
+        return f"{self.bitmask:02X}"
+
+    def binary(self):
+        return f"{self.bitmask:08b}"
+
     # -- context manager support ----------------------------------------
 
+    def __repr__(self):
+        return f"Trigger(bitmask={self.binary()}, open_lines={self.open_lines()})"
+
     def __enter__(self):
         return self
 

{digital_trigger-0.1.2 → digital_trigger-0.1.3}/src/digital_trigger.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digital-trigger
-Version: 0.1.2
+Version: 0.1.3
 Summary: Simple class for simplified pySerial interface for use in TTL event marking using e.g. PsychoPy.
 Author-email: Max Lovell <max_lovell@hotmail.co.uk>
 License-Expression: MIT
@@ -19,7 +19,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: pyserial>=3.0
+Dynamic: license-file
 
 # digital-trigger
 
@@ -36,14 +38,6 @@ Requires Python 3.8+ and [`pyserial`](https://pypi.org/project/pyserial/) (insta
 In PsychoPy you can install packages in the Builder GUI by going to: 
 Tools > Plugins and packages manager > Packages > Open PIP terminal, and run  `pip install digital-trigger`
 
-To find COM port number: 
-- run the command `python -m serial.tools.list_ports -v`
-- On Windows, open Device Manager, expand "Ports (COM & LPT)", unplug and replug to see which is your device
-- On Mac run `ls /dev/cu.*` in Terminal and look for something like /dev/cu.usbserial-XXXX or /dev/cu.usbmodemXXXX — use the cu.* name, not tty.*. 
-- On Linux, run ls `/dev/ttyUSB* /dev/ttyACM*` — USB-serial adapters are usually `ttyUSB0`
-- Arduino-style boards `ttyACM0; dmesg | tail` right after plugging in shows the assigned name, and you may need to add yourself to the dialout group for permission.
-
-Make sure your COM port is set up with a latency of 1ms (or lower) and Baudrate of 115200. This can be done under Device Manager > COM port > Advanced on Windows.
 
 ## Usage
 
@@ -60,34 +54,21 @@ from digital_trigger import Trigger
 port = Trigger('COM4', names=['cond_1', 'cond_2', 'stim_1', 'stim_2'])
 ```
 
-Note you can only do this once per experiment. 
-Don't do this in multiple code blocks in different routines or you will get a 'access/permission denied' error. 
-Probably best to have a single code block jsut for this in your first routine even.
-
-#### Begin Routine
-```
-trigger_opened = False
-trigger_closed = False
-```
+Note you can only do this once per experiment or you will get an 'access/permission denied' error.
+Watch out if you insert the same routine twice as a copy.
 
 #### Each Frame 
 ```
-# Open the line the instant the stimulus is drawn to the screen...
-# Change 'image' to the name of your stimulus component
-if image.status == STARTED and not trigger_opened:
-    win.callOnFlip(port.open, 'stim_1')
-    trigger_opened = True
+if image.status == STARTED and port.is_closed(condition):
+    win.callOnFlip(port.open, condition)
 
-# ...and close it the instant the stimulus is removed.
-if image.status == FINISHED and not trigger_closed:
-    win.callOnFlip(port.close, 'stim_1')
-    trigger_closed = True
+if image.status == FINISHED and port.is_open(condition):
+    win.callOnFlip(port.close, condition)
 ```
 
-#### End Routine
+OR, more simply:
 ```
-if not trigger_closed:
-    port.close('stim_1')
+port.sync_to_component(condition, image, win)
 ```
 
 #### End Experiment
@@ -119,7 +100,44 @@ with Trigger('COM4', names=['stim_1']) as port:
     port.open('stim_1')
 ```
 
-Resources:
+## Issues
+
+### Finding COM port number
+To find COM port number: 
+- run the command `python -m serial.tools.list_ports -v`
+- On Windows, open Device Manager, expand "Ports (COM & LPT)", unplug and replug to see which is your device
+- On Mac run `ls /dev/cu.*` in Terminal and look for something like /dev/cu.usbserial-XXXX or /dev/cu.usbmodemXXXX — use the cu.* name, not tty.*. 
+- On Linux, run ls `/dev/ttyUSB* /dev/ttyACM*` — USB-serial adapters are usually `ttyUSB0`
+- Arduino-style boards `ttyACM0; dmesg | tail` right after plugging in shows the assigned name, and you may need to add yourself to the dialout group for permission.
+
+Make sure your COM port is set up with a latency of 1ms (or lower) and Baudrate of 115200. This can be done under Device Manager > COM port > Advanced on Windows.
+
+### Module not found on Mac
+`ModuleNotFoundError: No module named 'digital_trigger'` error on Mac: PsychoPy 2025 issue with install path typo.
+Confirm by running this inside a code component in psychopy: 
+```
+import sys
+print(sys.executable)
+for p in sys.path:
+    print("  ", p)
+```
+see if package is installed to python3.1 instead of python3.10.
+- also `show digital-trigger` in PsychoPy's pip terminal (after running `install digital-trigger`) should also state that the package is installed.
+- try `find ~/.psychopy3 /Applications/PsychoPy.app -name "digital_trigger*" 2>/dev/null` in terminal
+
+Either install directly using `/Applications/PsychoPy.app/Contents/MacOS/python -m pip install \
+    --target ~/.psychopy3/packages/lib/python/site-packages \
+    digital-trigger`
+or move the directory by running this in a terminal:
+```
+mv /Applications/PsychoPy.app/Contents/Resources/lib/python3.10/site-packages/digital_trigger \
+   ~/.psychopy3/packages/lib/python/site-packages/
+
+mv /Applications/PsychoPy.app/Contents/Resources/lib/python3.10/site-packages/digital_trigger-0.1.2.dist-info \
+   ~/.psychopy3/packages/lib/python/site-packages/
+```
+
+## Resources:
 - https://www.blackboxtoolkit.com/support_usb_ttl_module.html
 - https://www.blackboxtoolkit.com/docs/pdf/USBTTLv1r19.pdf
 - https://psychopy.org/developers/pluginDevGuide.html#plugindevguide
@@ -139,9 +157,11 @@ re-run build:
 rm -rf dist                # clear old builds so nothing stale is uploaded
 python3 -m build
 ls dist                    # confirm the new version number is shown
-twine upload --repository testpypi dist/*
 ```
 
+Push to PyPi test with `twine upload --repository testpypi dist/*`
+Push to PyPi with `twine upload dist/*`
+
 #### test
 
 ```
@@ -172,5 +192,12 @@ print('ok', t.bitmask)
 #### release
 ```
 cd /path/to/project         # back to the project folder
+rm -rf dist
+python -m build
 twine upload dist/*         # no --repository = real PyPI
 ```
+OR github:
+Releases > Draft a new release.
+Choose a tag: type v0.1.3, click "Create new tag: v0.1.3 on publish".
+Title: v0.1.3. Description: brief notes on what changed.
+Click Publish release.

{digital_trigger-0.1.2 → digital_trigger-0.1.3}/src/digital_trigger.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 src/digital_trigger/__init__.py