yostlabs 2025.1.9__py3-none-any.whl → 2025.1.10__py3-none-any.whl

yostlabs/communication/base.py

@@ -6,7 +6,7 @@ class ThreespaceInputStream:
     Reads specified number of bytes. 
     If that many bytes are not available after timeout, less data will be returned
     """
-    def read(self, num_bytes) -> bytes:
+    def read(self, num_bytes: int) -> bytes:
         raise NotImplementedError()
     
     def read_all(self):
@@ -16,16 +16,16 @@ class ThreespaceInputStream:
         raise NotImplementedError()
 
     """Allows reading without removing the data from the buffer"""
-    def peek(self, num_bytes) -> bytes:
+    def peek(self, num_bytes: int) -> bytes:
         raise NotImplementedError()
     
-    def peek_until(self, expected: bytes, max_length=None) -> bytes:
+    def peek_until(self, expected: bytes, max_length: int = None) -> bytes:
         raise NotImplementedError()
     
     def readline(self) -> bytes:
         return self.read_until(b"\n")
     
-    def peekline(self, max_length=None) -> bytes:
+    def peekline(self, max_length: int = None) -> bytes:
         return self.peek_until(b"\n", max_length=max_length)    
     
     @property

yostlabs/communication/serial.py

@@ -6,7 +6,7 @@ import serial.tools.list_ports
 class ThreespaceSerialComClass(ThreespaceComClass):
 
     PID_V3_MASK = 0x3000
-    PID_BOOTLOADER = 0x1000 #We should really change this to 0x3000
+    PID_BOOTLOADER = 0x1000
 
     VID = 0x2476
 
@@ -26,10 +26,10 @@ class ThreespaceSerialComClass(ThreespaceComClass):
         self.peek_buffer = bytearray()
         self.peek_length = 0
 
-    def write(self, bytes):
+    def write(self, bytes: bytes):
         self.ser.write(bytes)
     
-    def read(self, num_bytes):
+    def read(self, num_bytes: int):
         if self.peek_length >= num_bytes:
             result = self.peek_buffer[:num_bytes]
             self.peek_length -= num_bytes
@@ -40,7 +40,7 @@ class ThreespaceSerialComClass(ThreespaceComClass):
             self.peek_length = 0
         return result
     
-    def peek(self, num_bytes):
+    def peek(self, num_bytes: int):
         if self.peek_length >= num_bytes:
             return self.peek_buffer[:num_bytes]
         else:
@@ -61,7 +61,7 @@ class ThreespaceSerialComClass(ThreespaceComClass):
         self.peek_length = 0
         return result
 
-    def peek_until(self, expected: bytes, max_length=None) -> bytes:
+    def peek_until(self, expected: bytes, max_length: int = None) -> bytes:
         if expected in self.peek_buffer:
             length = self.peek_buffer.index(expected) + len(expected)
             if max_length is not None and length > max_length: 
@@ -127,7 +127,7 @@ class ThreespaceSerialComClass(ThreespaceComClass):
                 yield port
 
     @staticmethod
-    def auto_detect(default_timeout=2, default_baudrate=115200) -> Generator["ThreespaceSerialComClass", None, None]:
+    def auto_detect(default_timeout: float = 2, default_baudrate: int = 115200) -> Generator["ThreespaceSerialComClass", None, None]:
         """
         Returns a list of com classes of the same type called on nearby.
         These ports will start unopened. This allows the caller to get a list of ports without having to connect.

yostlabs-2025.1.10.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: yostlabs
+Version: 2025.1.10
+Summary: Python resources and API for 3Space sensors from Yost Labs Inc.
+Project-URL: Homepage, https://yostlabs.com/
+Author-email: "Yost Labs Inc." <techsupport@yostlabs.com>, Andy Riedlinger <techsupport@yostlabs.com>
+License-File: LICENSE
+Keywords: 3space,threespace,yost
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: numpy
+Requires-Dist: pyserial
+Description-Content-Type: text/markdown
+
+<center><h4>API and Resources for Yost Labs 3.0 Threespace sensors.</h4></center>
+
+## Installation
+
+`python -m pip install yostlabs`
+
+## Basic Usage
+
+```Python
+from yostlabs.tss3.api import ThreespaceSensor
+
+#Will auto detect a 3-Space sensor connected to the machine via a USB connection
+sensor = ThreespaceSensor()
+
+result = sensor.getPrimaryCorrectedAccelVec()
+print(result)
+
+sensor.cleanup()
+```
+
+Click [here](https://github.com/YostLabs/3SpacePythonPackage/tree/main/Examples) for more examples.
+
+## Communication
+
+The ThreespaceSensor class utilizes a ThreespaceComClass to define the hardware communication interface between the device utlizing this API and the Threespace Sensor. Currently only the ThreespaceSerialComClass is available for use with the API. New ComClasses for different interfaces will be added to the [communication package](https://github.com/YostLabs/3SpacePythonPackage/tree/main/src/yostlabs/communication) in the future.
+
+To create your own ThreespaceComClass, take a look at the necessary interface definitions [here](https://github.com/YostLabs/3SpacePythonPackage/blob/main/src/yostlabs/communication/base.py) and the Serial implementation [here](https://github.com/YostLabs/3SpacePythonPackage/blob/main/src/yostlabs/communication/serial.py).
+
+## Documentation
+
+WIP. Please review the example scripts. For further assistance contact techsupport@yostlabs.com.

{yostlabs-2025.1.9.dist-info → yostlabs-2025.1.10.dist-info}/RECORD

@@ -1,7 +1,7 @@
 yostlabs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 yostlabs/communication/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-yostlabs/communication/base.py,sha256=oKTcXJtJv4-NLS52Rs29ZXt-nwvo9W_hhamzH_PNF40,2783
-yostlabs/communication/serial.py,sha256=oLXGUf3Os7Hxv2o1ORo8_8KIKLMfksSL4Lge_JDZZbE,5514
+yostlabs/communication/base.py,sha256=i82t4Kq3B8CpPqGNpGc737rXFul4dTkutXt5N5OYuQg,2807
+yostlabs/communication/serial.py,sha256=cOv3CxloQo7sCjdAEUzkfZuZieqy-JbsW2Zwavc9LT8,5514
 yostlabs/math/__init__.py,sha256=JFzsPQ4AbsX1AH1brBpn1c_Pa_ItF43__D3mlPvA2a4,34
 yostlabs/math/quaternion.py,sha256=YyvbSrTPXGS8BsQJCn2tjdzIZ9WeDzfUe7dIDKeWsAM,4989
 yostlabs/math/vector.py,sha256=CPtIxJXelCidGxTBrz6vZwLv-qXlccpAlYODaKJnWNw,991
@@ -14,7 +14,7 @@ yostlabs/tss3/utils/calibration.py,sha256=42jCEzfTXoHuPZ4e-30N1ijOhkz9ld4PQnhX6A
 yostlabs/tss3/utils/parser.py,sha256=thM5s70CZvehM5qP3AGVgHs6woeQM-wmA7hIcRO3MlY,11332
 yostlabs/tss3/utils/streaming.py,sha256=218U29LmsLel42kd6g63Hi9XnovRqFVMofO0GEOAAA0,18990
 yostlabs/tss3/utils/version.py,sha256=NT2H9l-oIRCYhV_yjf5UjkadoJQ0IN4eLl8y__pyTPc,3001
-yostlabs-2025.1.9.dist-info/METADATA,sha256=6j6eTivS7ZDZJ6tJUMZUM6lidm0_1j4sgk7F4e-9Ung,645
-yostlabs-2025.1.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-yostlabs-2025.1.9.dist-info/licenses/LICENSE,sha256=PtF8EXRlVhm1_ve52_3GHixSPwMn0tGajFxF3xKS-j0,1090
-yostlabs-2025.1.9.dist-info/RECORD,,
+yostlabs-2025.1.10.dist-info/METADATA,sha256=blS23q-7CZUlk_sCM-zMibCyYpv-qfBAb--3er14geY,2025
+yostlabs-2025.1.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+yostlabs-2025.1.10.dist-info/licenses/LICENSE,sha256=PtF8EXRlVhm1_ve52_3GHixSPwMn0tGajFxF3xKS-j0,1090
+yostlabs-2025.1.10.dist-info/RECORD,,

yostlabs-2025.1.9.dist-info/METADATA

@@ -1,18 +0,0 @@
-Metadata-Version: 2.4
-Name: yostlabs
-Version: 2025.1.9
-Summary: Python resources and API for 3Space sensors from Yost Labs Inc.
-Project-URL: Homepage, https://yostlabs.com/
-Author-email: "Yost Labs Inc." <techsupport@yostlabs.com>, Andy Riedlinger <techsupport@yostlabs.com>
-License-File: LICENSE
-Keywords: 3space,threespace,yost
-Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
-Requires-Dist: numpy
-Requires-Dist: pyserial
-Description-Content-Type: text/markdown
-
-Work In Progress