YorkUphysLabAssistant 1.0.0__tar.gz

yorkuphyslabassistant-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bruce Howard
+
+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.

yorkuphyslabassistant-1.0.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: YorkUphysLabAssistant
+Version: 1.0.0
+Summary: A Python package to provide control and readback related to YU physics labs equipment.
+Author-email: Bruce Howard <blhoward@yorku.ca>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/brucehoward-physics/YorkUphysLabAssistant
+Project-URL: Issues, https://github.com/brucehoward-physics/YorkUphysLabAssistant/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nidaqmx
+Requires-Dist: pyserial
+Requires-Dist: pyvisa-py
+Requires-Dist: numpy
+Requires-Dist: pyttsx3
+Requires-Dist: YorkUphysLab
+Dynamic: license-file
+
+This package is meant to be used alongside YorkUphysLab
+
+See: https://github.com/m-kareem/YorkUphysLab
+
+My fork: https://github.com/brucehoward-physics/YorkUphysLab
+
+and provides additional functionality for interfacing with the hardware, including text-to-speech outputs.

yorkuphyslabassistant-1.0.0/README.md

@@ -0,0 +1,7 @@
+This package is meant to be used alongside YorkUphysLab
+
+See: https://github.com/m-kareem/YorkUphysLab
+
+My fork: https://github.com/brucehoward-physics/YorkUphysLab
+
+and provides additional functionality for interfacing with the hardware, including text-to-speech outputs.

yorkuphyslabassistant-1.0.0/YorkUphysLabAssistant/LabPartner.py

@@ -0,0 +1,252 @@
+import pyttsx3 as speak
+
+import io
+from contextlib import redirect_stdout
+
+from YorkUphysLab.ScoutScale import ScoutSTX
+from YorkUphysLab.GwINSTEK import GPD3303D
+from YorkUphysLab.Actuator import Actuator
+from YorkUphysLab.HVcontrol import HV_control
+from YorkUphysLab.Utility import Utility
+
+# See https://pypi.org/project/pyttsx3/ for details on ttsx3
+
+# See https://stackoverflow.com/questions/1218933/can-i-redirect-the-stdout-into-some-sort-of-string-buffer
+#   for info about redirecting print outputs (i.e. stdout) to a buffer. Used to get TTS for the setup/close/etc.
+
+
+# TODO: Add capability for OSCILLOSCOPE (TBS1000 e.g.)
+
+def LookUpType(_key):
+    if _key==' grams':
+        return ' grams'
+    elif _key==' kilovolts':
+        return ' kilovolts'
+    elif _key==' millimetres':
+        return ' millimetres'
+    elif _key=='ES':
+        return ' grams'
+    elif _key=='PSU':
+        return ' kilovolts'
+    elif _key=='ACT':
+        return ' millimetres'
+    return ''
+
+class DummyClass:
+    def __init__(self):
+        self.keyword='None'
+
+dummyClass = DummyClass()
+
+class MyLabMate:
+    def __init__(self, _voice=1, _rate='N',_class=dummyClass,_print=True,_comment=None):
+        self.engine = speak.init()
+        self.voice = _voice
+        self.rate = _rate
+        self.in_class = _class
+        # GET THE KEYWORD
+        _key='None'
+        if hasattr(self.in_class,'keyword'):
+            _key = self.in_class.keyword
+        elif hasattr(self.in_class,'HV_on'):
+            _key = 'PSU' #HV_Control
+        elif hasattr(self.in_class,'actuator_on'):
+            _key = 'ACT' #Actuator
+        self.config = {'keyword': _key} #For when configurations are used (function generator, oscilloscope, ...)
+        self.unit = LookUpType(_key)
+        ##################
+        self.print = _print
+        self.engine.setProperty('voice', self.engine.getProperty('voices')[_voice].id )
+        if _rate=='N':
+            self.engine.setProperty('rate', 175)
+        elif _rate=='S':
+            self.engine.setProperty('rate', 125)
+        elif _rate=='F':
+            self.engine.setProperty('rate', 225)
+        else:
+            self.engine.setProperty('rate', 175)
+        if _comment != None:
+            self.comment = _comment
+        else:
+            self.comment = ""
+        if self.config['keyword']=='None':
+            self.speak('Beware: you are making a Lab Mate associated with Dummy Class or a class unrecognized by the LabPartner software. Do not expect any further commands to do anything.')
+
+    def loadComment(self,_string,_isReadout=False,_override=None):
+        self.comment = str(_string)
+        if _isReadout and _override==None:
+            self.comment = self.comment+self.unit
+        elif _override!=None:
+            self.comment = self.comment+_override
+
+    def reset(self):
+        _voice = self.voice
+        _rate = self.rate
+        _unit = self.unit
+        del self.engine
+        # Set back up the engine
+        self.engine = speak.init()
+        self.engine.setProperty('voice', self.engine.getProperty('voices')[_voice].id )
+        if _rate=='N':
+            self.engine.setProperty('rate', 175)
+        elif _rate=='S':
+            self.engine.setProperty('rate', 125)
+        elif _rate=='F':
+            self.engine.setProperty('rate', 225)
+        else:
+            self.engine.setProperty('rate', 175)
+
+    def justspeak(self):
+        if self.print:
+            print(self.comment)
+        self.engine.say(self.comment)
+        self.engine.runAndWait()
+        self.engine.stop()
+        self.reset()
+
+    def speak(self, _string, _isReadout=False):
+        self.loadComment(_string, _isReadout)
+        self.justspeak()
+
+    def SETUP(self):
+        if self.config['keyword'] == 'ES':
+            # See StackOverflow link above on the stdout buffer
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.connect()
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'PSU':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.switch_on()
+                #self.speak(buf.getvalue())
+                print(buf.getvalue())
+                self.speak('Power supply text-to-speech misbehaving. I have printed the output to the screen instead.')
+            return
+        elif self.config['keyword'] == 'ACT':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.switch_on()
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'AFG':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.connect()
+                self.speak(buf.getvalue())
+            return
+        else:
+            self.speak('I cannot run setup for the hardware class associated to this Lab Mate.')
+            return
+
+    def SET(self, _value):
+        if self.config['keyword'] == 'ES':
+            self.speak('I cannot run SET for the hardware class associated to this Lab Mate.')
+            return
+        elif self.config['keyword'] == 'PSU':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.set_hv(_value)
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'ACT':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.set_position(_value)
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'AFG':
+            try:
+                if _value[0]=='V' or _value[0]=='v':
+                    with io.StringIO() as buf, redirect_stdout(buf):
+                        self.in_class.set_amplitude(_value[1])
+                        self.config['amplitude'] = str(_value[1])+' Volts'
+                        self.speak(buf.getvalue())
+                    return
+                if _value[0]=='F' or _value[0]=='f':
+                    with io.StringIO() as buf, redirect_stdout(buf):
+                        self.in_class.set_frequency(_value[1])
+                        self.config['frequency'] = str(_value[1])+' Hertz'
+                        self.speak(buf.getvalue())
+                    return
+                if _value[0]=='W' or _value[0]=='w':
+                    with io.StringIO() as buf, redirect_stdout(buf):
+                        self.in_class.set_waveform(_value[1])
+                        self.config['waveform'] = str(_value[1])
+                        self.speak(buf.getvalue())
+                    return
+                if _value[0]=='O' or _value[0]=='o':
+                    with io.StringIO() as buf, redirect_stdout(buf):
+                        self.in_class.set_DCoffset(_value[1])
+                        self.config['offset'] = str(_value[1])+' Volts'
+                        self.speak(buf.getvalue())
+                    return
+                if _value[0]=='ON' or _value[0]=='on' or _value[0]=='On':
+                    with io.StringIO() as buf, redirect_stdout(buf):
+                        self.in_class.set_output("ON")
+                        self.config['state'] = 'ON'
+                        self.speak(buf.getvalue())
+                    return
+                if _value[0]=='OFF' or _value[0]=='off' or _value[0]=='Off':
+                    with io.StringIO() as buf, redirect_stdout(buf):
+                        self.in_class.set_output("OFF")
+                        self.config['state'] = 'OFF'
+                        self.speak(buf.getvalue())
+                    return
+            except:
+                self.speak('For the function generator, the input value to set should be a two item list. A character "V" to see amplitude, "F" to set frequency, "W" for waveform, and "O" for offset. Second value is the valuue to set. A list with "ON" as first element turns on the output, while "OFF" turns it off.')
+                return
+        else:
+            self.speak('I cannot run SET for the hardware class associated to this Lab Mate.')
+            return
+
+    def GET(self):
+        if self.config['keyword'] == 'ES':
+            # See StackOverflow link above on the stdout buffer
+            with io.StringIO() as buf, redirect_stdout(buf):
+                weight = self.in_class.read_weight()
+                self.speak(buf.getvalue())
+            self.speak( weight, True )
+            return
+        elif self.config['keyword'] == 'PSU':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                voltage = self.in_class.get_hv()
+                self.speak(buf.getvalue())
+            self.speak( voltage, True )
+            return
+        elif self.config['keyword'] == 'ACT':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                position = self.in_class.get_position()
+                self.speak(buf.getvalue())
+            self.speak( position, True )
+            return
+        elif self.config['keyword'] == 'AFG':
+            self.speak('The function generator, takes as input via SET the amplitude, frequency, waveform, and offset, as well as whether the output is on or off. The following statements will tell you the configuration.')
+            for key in self.config.keys():
+                statement = key + ' is ' + str(self.config[key])
+                self.speak(statement)
+            return
+        else:
+            self.speak('I cannot run GET for the hardware class associated to this Lab Mate.')
+            return
+
+    def CLOSE(self):
+        if self.config['keyword'] == 'ES':
+            # See StackOverflow link above on the stdout buffer
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.close_connection()
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'PSU':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.switch_off()
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'ACT':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.switch_off()
+                self.speak(buf.getvalue())
+            return
+        elif self.config['keyword'] == 'AFG':
+            with io.StringIO() as buf, redirect_stdout(buf):
+                self.in_class.close()
+                self.speak(buf.getvalue())
+            return
+        else:
+            self.speak('I cannot run GET for the hardware class associated to this Lab Mate.')
+            return

yorkuphyslabassistant-1.0.0/YorkUphysLabAssistant.egg-info/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: YorkUphysLabAssistant
+Version: 1.0.0
+Summary: A Python package to provide control and readback related to YU physics labs equipment.
+Author-email: Bruce Howard <blhoward@yorku.ca>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/brucehoward-physics/YorkUphysLabAssistant
+Project-URL: Issues, https://github.com/brucehoward-physics/YorkUphysLabAssistant/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nidaqmx
+Requires-Dist: pyserial
+Requires-Dist: pyvisa-py
+Requires-Dist: numpy
+Requires-Dist: pyttsx3
+Requires-Dist: YorkUphysLab
+Dynamic: license-file
+
+This package is meant to be used alongside YorkUphysLab
+
+See: https://github.com/m-kareem/YorkUphysLab
+
+My fork: https://github.com/brucehoward-physics/YorkUphysLab
+
+and provides additional functionality for interfacing with the hardware, including text-to-speech outputs.

yorkuphyslabassistant-1.0.0/YorkUphysLabAssistant.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+YorkUphysLabAssistant/LabPartner.py
+YorkUphysLabAssistant/__init__.py
+YorkUphysLabAssistant.egg-info/PKG-INFO
+YorkUphysLabAssistant.egg-info/SOURCES.txt
+YorkUphysLabAssistant.egg-info/dependency_links.txt
+YorkUphysLabAssistant.egg-info/requires.txt
+YorkUphysLabAssistant.egg-info/top_level.txt

yorkuphyslabassistant-1.0.0/YorkUphysLabAssistant.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

yorkuphyslabassistant-1.0.0/YorkUphysLabAssistant.egg-info/requires.txt

@@ -0,0 +1,6 @@
+nidaqmx
+pyserial
+pyvisa-py
+numpy
+pyttsx3
+YorkUphysLab

yorkuphyslabassistant-1.0.0/YorkUphysLabAssistant.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+YorkUphysLabAssistant
+dist

yorkuphyslabassistant-1.0.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ['setuptools>=42']
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = "YorkUphysLabAssistant"
+version = "1.0.0"
+authors = [
+  { name="Bruce Howard", email="blhoward@yorku.ca" },
+]
+description = "A Python package to provide control and readback related to YU physics labs equipment."
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+	"Programming Language :: Python :: 3",
+	"Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+dependencies = [
+  "nidaqmx",
+  "pyserial",
+  "pyvisa-py",
+  "numpy",
+  "pyttsx3",
+  "YorkUphysLab",
+]
+
+[project.urls]
+Homepage = "https://github.com/brucehoward-physics/YorkUphysLabAssistant"
+Issues = "https://github.com/brucehoward-physics/YorkUphysLabAssistant/issues"
+
+[tool.setuptools.packages]
+find = {} # Copied from the YorkUphysLab setup.cfg

yorkuphyslabassistant-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+