libximc 2.14.30__tar.gz → 3.0.2__tar.gz

{libximc-2.14.30 → libximc-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libximc
-Version: 2.14.30
+Version: 3.0.2
 Summary: Package for operating STANDA 8SMC5 controllers
 Author-email: STANDA LTD <8smc4@standa.lt>
 License: Copyright (c) 2023 STANDA LTD
@@ -22,7 +22,6 @@ License: Copyright (c) 2023 STANDA LTD
         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.
-License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
@@ -35,7 +34,7 @@ This is a python binding for libximc - cross-platform library for [Standa  8SMC5
 
 ![8SMC5-based devices](https://raw.githubusercontent.com/Standa-Optomechanics/libximc/dev-2.14/libximc/docs/8SMC5_based_devices.png)
 
-Libximc manages hardware using interfaces: USB 2.0, RS232 and Ethernet, also uses a common and proven virtual serial port interface, so you can work with motor control modules through this library under Windows and Linux. MacOS X isn't supported yet.
+Libximc manages hardware using interfaces: USB 2.0, RS232 and Ethernet, also uses a common and proven virtual serial port interface, so you can work with motor control modules through this library under Windows and Linux. macOS isn't supported yet.
 
 This library also supports virtual devices. So you can make some tests without real hardware.
 

{libximc-2.14.30 → libximc-3.0.2}/README.md

@@ -4,7 +4,7 @@ This is a python binding for libximc - cross-platform library for [Standa  8SMC5
 
 ![8SMC5-based devices](https://raw.githubusercontent.com/Standa-Optomechanics/libximc/dev-2.14/libximc/docs/8SMC5_based_devices.png)
 
-Libximc manages hardware using interfaces: USB 2.0, RS232 and Ethernet, also uses a common and proven virtual serial port interface, so you can work with motor control modules through this library under Windows and Linux. MacOS X isn't supported yet.
+Libximc manages hardware using interfaces: USB 2.0, RS232 and Ethernet, also uses a common and proven virtual serial port interface, so you can work with motor control modules through this library under Windows and Linux. macOS isn't supported yet.
 
 This library also supports virtual devices. So you can make some tests without real hardware.
 

{libximc-2.14.30 → libximc-3.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "libximc"
-version = "2.14.30"
+version = "3.0.2"
 authors = [
   { name="STANDA LTD", email="8smc4@standa.lt" },
 ]

{libximc-2.14.30 → libximc-3.0.2}/src/libximc/highlevel/__init__.py

@@ -65,7 +65,7 @@ from libximc.highlevel._structure_types import (feedback_settings_t,
                                                 controller_name_t,
                                                 nonvolatile_memory_t,
                                                 emf_settings_t,
-                                                engine_advansed_setup_t,
+                                                engine_advanced_setup_t,
                                                 engine_advanced_setup_t,
                                                 get_position_t,
                                                 get_position_calb_t,
@@ -147,7 +147,7 @@ __all__ = [
     controller_name_t,
     nonvolatile_memory_t,
     emf_settings_t,
-    engine_advansed_setup_t,
+    engine_advanced_setup_t,
     engine_advanced_setup_t,
     get_position_t,
     get_position_calb_t,

{libximc-2.14.30 → libximc-3.0.2}/src/libximc/highlevel/_flag_enumerations.py

@@ -204,7 +204,7 @@ class SecureFlags(StrictIntFlag):
     H_BRIDGE_ALERT = 0x04
     ALARM_ON_BORDERS_SWAP_MISSET = 0x08
     ALARM_FLAGS_STICKING = 0x10
-    USB_BREAK_RECONNECT = 0x20
+    BRAKING_OVERVOLTAGE_PROTECTION = 0x20
     ALARM_WINDING_MISMATCH = 0x40
     ALARM_ENGINE_RESPONSE = 0x80
 
@@ -223,10 +223,16 @@ class FeedbackType(StrictIntFlag):
 
 class FeedbackFlags(StrictIntFlag):
     FEEDBACK_ENC_REVERSE = 0x01
-    FEEDBACK_ENC_TYPE_BITS = 0xC0
+    FEEDBACK_ENC_ADAPTIVE_HOLDING = 0x02
+    FEEDBACK_ENC_FILTER_NONE = 0x00
+    FEEDBACK_ENC_FILTER_WEAK = 0x10
+    FEEDBACK_ENC_FILTER_MEDIUM = 0x20
+    FEEDBACK_ENC_FILTER_STRONG = 0x30
+    FEEDBACK_ENC_FILTER_BITS = 0x30
     FEEDBACK_ENC_TYPE_AUTO = 0x00
     FEEDBACK_ENC_TYPE_SINGLE_ENDED = 0x40
     FEEDBACK_ENC_TYPE_DIFFERENTIAL = 0x80
+    FEEDBACK_ENC_TYPE_BITS = 0xC0
 
 
 class SyncInFlags(StrictIntFlag):

{libximc-2.14.30 → libximc-3.0.2}/src/libximc/highlevel/_highlevel.py

@@ -48,7 +48,7 @@ from libximc.highlevel._structure_types import (feedback_settings_t,
                                                 controller_name_t,
                                                 nonvolatile_memory_t,
                                                 emf_settings_t,
-                                                engine_advansed_setup_t,
+                                                engine_advanced_setup_t,
                                                 engine_advanced_setup_t,
                                                 get_position_t,
                                                 get_position_calb_t,
@@ -121,10 +121,9 @@ class Axis:
         "xi-com:/dev/tty.s123" in Linux/Mac. In case of network device the "host" is an IPv4 address or fully
         qualified domain uri (FQDN), "serial" is the device serial number in hexadecimal system. For example
         "xi-net://192.168.0.1/00001234" or "xi-net://hostname.com/89ABCDEF". In case of UDP protocol, use
-        "xi-udp://<ip/host>:<port>. For example, "xi-udp://192.168.0.1:1818". Note: to open network device you
-        must call set_bindy_key first. In case of virtual device the "file" is the full filename with device
-        memory state, if it doesn't exist then it is initialized with default values. For example
-        "xi-emu:///C:/dir/file.bin" in Windows or "xi-emu:///home/user/file.bin" in Linux/Mac.
+        "xi-udp://<ip/host>:<port>. For example, "xi-udp://192.168.0.1:1818". In case of virtual device the "file"
+		is the full filename with device memory state, if it doesn't exist then it is initialized with default values.
+		For example "xi-emu:///C:/dir/file.bin" in Windows or "xi-emu:///home/user/file.bin" in Linux/Mac.
     :type uri: str
     """
     def __init__(self, uri: str) -> None:
@@ -295,7 +294,7 @@ class Axis:
         """
         self._check_device_opened()
         if not isinstance(settings, move_settings_t):
-            raise TypeError("settings must be of type MoveSettings. {} was MoveSettings.".format(type(settings)))
+            raise TypeError("settings must be of type MoveSettings. {} was got.".format(type(settings)))
         _check_fullness(settings)
         move_settings = ll.move_settings_t(settings.Speed,
                                            settings.uSpeed,
@@ -1178,21 +1177,21 @@ class Axis:
         return nonvolatile_memory_t(list(nonvolatile_memory.UserData))
 
     # Legacy
-    def set_engine_advansed_setup(self, setup: engine_advansed_setup_t) -> None:
+    def set_engine_advanced_setup(self, setup: engine_advanced_setup_t) -> None:
         """Set engine advanced settings.
 
         :param setup: EAS settings
-        :type setup: engine_advansed_setup_t
+        :type setup: engine_advanced_setup_t
         """
         self._check_device_opened()
-        if not isinstance(setup, engine_advansed_setup_t):
-            raise TypeError("setup must be of type engine_advansed_setup_t. {} was got.".format(type(setup)))
+        if not isinstance(setup, engine_advanced_setup_t):
+            raise TypeError("setup must be of type engine_advanced_setup_t. {} was got.".format(type(setup)))
         _check_fullness(setup)
-        engine_advanced_setup = ll.engine_advansed_setup_t(
+        engine_advanced_setup = ll.engine_advanced_setup_t(
                                         setup.stepcloseloop_Kw,
                                         setup.stepcloseloop_Kp_low,
                                         setup.stepcloseloop_Kp_high)
-        _check_result(lib.set_engine_advansed_setup(self._device_id, byref(engine_advanced_setup)))
+        _check_result(lib.set_engine_advanced_setup(self._device_id, byref(engine_advanced_setup)))
 
     def set_engine_advanced_setup(self, setup: engine_advanced_setup_t) -> None:
         """Set engine advanced settings.
@@ -1204,23 +1203,23 @@ class Axis:
         if not isinstance(setup, engine_advanced_setup_t):
             raise TypeError("setup must be of type engine_advanced_setup_t. {} was got.".format(type(setup)))
         _check_fullness(setup)
-        engine_advanced_setup = ll.engine_advansed_setup_t(
+        engine_advanced_setup = ll.engine_advanced_setup_t(
                                         setup.stepcloseloop_Kw,
                                         setup.stepcloseloop_Kp_low,
                                         setup.stepcloseloop_Kp_high)
-        _check_result(lib.set_engine_advansed_setup(self._device_id, byref(engine_advanced_setup)))
+        _check_result(lib.set_engine_advanced_setup(self._device_id, byref(engine_advanced_setup)))
 
     # Legacy
-    def get_engine_advansed_setup(self) -> engine_advansed_setup_t:
+    def get_engine_advanced_setup(self) -> engine_advanced_setup_t:
         """Read engine advanced settings.
 
         :return: EAS settings
-        :rtype: engine_advansed_setup_t
+        :rtype: engine_advanced_setup_t
         """
         self._check_device_opened()
-        engine_advanced_setup = ll.engine_advansed_setup_t()
-        _check_result(lib.get_engine_advansed_setup(self._device_id, byref(engine_advanced_setup)))
-        return engine_advansed_setup_t(engine_advanced_setup.stepcloseloop_Kw,
+        engine_advanced_setup = ll.engine_advanced_setup_t()
+        _check_result(lib.get_engine_advanced_setup(self._device_id, byref(engine_advanced_setup)))
+        return engine_advanced_setup_t(engine_advanced_setup.stepcloseloop_Kw,
                                        engine_advanced_setup.stepcloseloop_Kp_low,
                                        engine_advanced_setup.stepcloseloop_Kp_high)
 
@@ -1231,8 +1230,8 @@ class Axis:
         :rtype: engine_advanced_setup_t
         """
         self._check_device_opened()
-        engine_advanced_setup = ll.engine_advansed_setup_t()
-        _check_result(lib.get_engine_advansed_setup(self._device_id, byref(engine_advanced_setup)))
+        engine_advanced_setup = ll.engine_advanced_setup_t()
+        _check_result(lib.get_engine_advanced_setup(self._device_id, byref(engine_advanced_setup)))
         return engine_advanced_setup_t(engine_advanced_setup.stepcloseloop_Kw,
                                        engine_advanced_setup.stepcloseloop_Kp_low,
                                        engine_advanced_setup.stepcloseloop_Kp_high)
@@ -1447,7 +1446,7 @@ class Axis:
                             chart_data.WindingCurrentC,
                             chart_data.Pot,
                             chart_data.Joy,
-                            chart_data.DutyCycle)
+                            chart_data.AveragedPowerRatio)
 
     def get_serial_number(self) -> int:
         """Read device serial number.
@@ -1632,18 +1631,6 @@ class Axis:
         self._check_device_opened()
         _check_result(lib.command_homezero(self._device_id))
 
-    def set_bindy_key(self, keyfilepath: str) -> None:
-        """Set network encryption layer (bindy) key.
-
-        :param keyfilepath: full path to the bindy keyfile When using network-attached devices this function must be
-            called before enumerate_devices and open_device functions.
-        :type keyfilepath: str
-        """
-        self._check_device_opened()
-        if not isinstance(keyfilepath, str):
-            raise TypeError("keyfilepath must be of type str. {} was got.".format(type(keyfilepath)))
-        _check_result(lib.set_bindy_key(keyfilepath.encode()))
-
     def open_device(self) -> None:
         """Open a device"""
         device_id = lib.open_device(self.uri.encode())

{libximc-2.14.30 → libximc-3.0.2}/src/libximc/highlevel/_structure_types.py

@@ -2651,7 +2651,7 @@ class emf_settings_t:
 
 
 # Legacy
-class engine_advansed_setup_t:
+class engine_advanced_setup_t:
     def __init__(
             self,
             stepcloseloop_Kw: int = NOT_INITIALIZED,
@@ -2709,7 +2709,7 @@ class engine_advansed_setup_t:
         return result
 
 
-class engine_advanced_setup_t(engine_advansed_setup_t):
+class engine_advanced_setup_t(engine_advanced_setup_t):
     pass
 
 
@@ -3595,7 +3595,7 @@ class chart_data_t:
             WindingCurrentC: int = NOT_INITIALIZED,
             Pot: int = NOT_INITIALIZED,
             Joy: int = NOT_INITIALIZED,
-            DutyCycle: int = NOT_INITIALIZED):
+            AveragedPowerRatio: int = NOT_INITIALIZED):
         """Additional device state.
 
         This structure contains additional values such as winding's voltages, currents and temperature.
@@ -3625,8 +3625,8 @@ class chart_data_t:
         :type Pot: int
         :param Joy: The joystick position, dimensionless. Range: 0..10000
         :type Joy: int
-        :param DutyCycle: PWM duty cycle.
-        :type DutyCycle: int
+        :param AveragedPowerRatio: averaged power ratio.
+        :type AveragedPowerRatio: int
         """
         self.WindingVoltageA = WindingVoltageA
         self.WindingVoltageB = WindingVoltageB
@@ -3636,7 +3636,7 @@ class chart_data_t:
         self.WindingCurrentC = WindingCurrentC
         self.Pot = Pot
         self.Joy = Joy
-        self.DutyCycle = DutyCycle
+        self.AveragedPowerRatio = AveragedPowerRatio
 
     # getters
     @property
@@ -3672,8 +3672,8 @@ class chart_data_t:
         return self._Joy
 
     @property
-    def DutyCycle(self) -> int:
-        return self._DutyCycle
+    def AveragedPowerRatio(self) -> int:
+        return self._AveragedPowerRatio
 
     # setters
     @WindingVoltageA.setter
@@ -3716,10 +3716,10 @@ class chart_data_t:
         _check_noncontainer_castability(val, c_uint16, varname="Joy")
         self._Joy = val
 
-    @DutyCycle.setter
-    def DutyCycle(self, val):
-        _check_noncontainer_castability(val, c_int16, varname="DutyCycle")
-        self._DutyCycle = val
+    @AveragedPowerRatio.setter
+    def AveragedPowerRatio(self, val):
+        _check_noncontainer_castability(val, c_int16, varname="AveragedPowerRatio")
+        self._AveragedPowerRatio = val
 
     def __repr__(self) -> str:
         result = ""