rsmxo 2.8.0__tar.gz

rsmxo-2.8.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: rsmxo
+Version: 2.8.0
+Summary: MXO Series Digital Oscilloscopes Driver Remote-control module
+Author: Rohde & Schwarz GmbH & Co. KG
+Maintainer: Rohde & Schwarz GmbH & Co. KG
+License-Expression: MIT
+Project-URL: Documentation, https://rsmxo.readthedocs.io/
+Project-URL: Examples, https://github.com/Rohde-Schwarz/Examples/
+Keywords: MXO,MXO3,MXO4,MXO5,MXO44,MXO58,ScopeStudio
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Scientific/Engineering :: Instrument Drivers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+Requires-Dist: pyvisa>=1.13.0
+Requires-Dist: typing-extensions>=4.0.0
+
+==================================
+ rsmxo
+==================================
+
+.. image:: https://img.shields.io/pypi/v/rsmxo.svg
+   :target: https://pypi.org/project/ rsmxo/
+
+.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
+   :target: https://rsmxo.readthedocs.io/
+
+.. image:: https://img.shields.io/pypi/l/rsmxo.svg
+   :target: https://pypi.python.org/pypi/rsmxo/
+
+.. image:: https://img.shields.io/pypi/pyversions/pybadges.svg
+   :target: https://img.shields.io/pypi/pyversions/pybadges.svg
+
+.. image:: https://img.shields.io/pypi/dm/rsmxo.svg
+   :target: https://pypi.python.org/pypi/rsmxo/
+
+Rohde & Schwarz MXO Series Digital Oscilloscopes Driver rsmxo instrument driver.
+
+Basic waveform fetching example:
+
+.. code-block:: python
+
+	from rsmxo import *
+	from rsmxo.enums import *
+
+	mxo = RsMxo('TCPIP::localhost::hislip0')
+	print('Hello, I am: ' + mxo.utilities.idn_string)
+	mxo.system.display.set_update(True)
+	mxo.trigger.set_mode(trigger_mode=TriggerMode.AUTO)
+	mxo.channel.range.set(range_py=10)
+	mxo.channel.state.set(True)
+	print('\nStarting the acquisition ...')
+	mxo.run.single_and_wait()
+	print('... acquisition complete')
+	header = mxo.channel.data.header.get()
+	print('Waveform:')
+	print(f'Time start: {header.Xstart} s, Time stop: {header.Xstop} s')
+	waveform = mxo.channel.data.values.get()
+	print(f'Record length: {len(waveform)} samples')
+
+	mxo.close()
+
+Supported instruments: MXO3, MXO44, MXO58, MXO58C, ScopeStudio
+
+The package is hosted here: https://pypi.org/project/rsmxo/
+
+Documentation: https://rsmxo.readthedocs.io/
+
+Examples: https://github.com/Rohde-Schwarz/Examples/tree/main/Oscilloscopes/Python/RsMxo_ScpiPackage
+
+
+Version history
+----------------
+
+	Latest release notes summary: Update for MXO FW 2.8.0
+
+	Version 2.8.0
+		- Update for MXO FW 2.8.0
+		- Changed the project name and module name from 'RsMxo' to 'rsmxo' to comply with IVI-Python drivers
+
+	Version 2.7.3
+		- Added pypi IVI classifier 'Topic :: Scientific/Engineering :: Instrument Drivers'
+
+	Version 2.7.2
+		- Update for FW 2.7
+
+	Version 2.6.4
+		- Fixed MEASurement commands.
+		- Added STATus commands.
+		- Small bug fixes.
+
+	Version 2.6.3
+		- Updated example links and readme file.
+
+	Version 2.6.2
+		- Small interface improvements and bug fixes.
+
+	Version 2.6.1
+		- Fixed bug, where arguments or return values were wrongly scalar instead of lists.
+
+	Version 2.6.0
+		- First released version

rsmxo-2.8.0/README.rst

@@ -0,0 +1,85 @@
+==================================
+ rsmxo
+==================================
+
+.. image:: https://img.shields.io/pypi/v/rsmxo.svg
+   :target: https://pypi.org/project/ rsmxo/
+
+.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
+   :target: https://rsmxo.readthedocs.io/
+
+.. image:: https://img.shields.io/pypi/l/rsmxo.svg
+   :target: https://pypi.python.org/pypi/rsmxo/
+
+.. image:: https://img.shields.io/pypi/pyversions/pybadges.svg
+   :target: https://img.shields.io/pypi/pyversions/pybadges.svg
+
+.. image:: https://img.shields.io/pypi/dm/rsmxo.svg
+   :target: https://pypi.python.org/pypi/rsmxo/
+
+Rohde & Schwarz MXO Series Digital Oscilloscopes Driver rsmxo instrument driver.
+
+Basic waveform fetching example:
+
+.. code-block:: python
+
+	from rsmxo import *
+	from rsmxo.enums import *
+
+	mxo = RsMxo('TCPIP::localhost::hislip0')
+	print('Hello, I am: ' + mxo.utilities.idn_string)
+	mxo.system.display.set_update(True)
+	mxo.trigger.set_mode(trigger_mode=TriggerMode.AUTO)
+	mxo.channel.range.set(range_py=10)
+	mxo.channel.state.set(True)
+	print('\nStarting the acquisition ...')
+	mxo.run.single_and_wait()
+	print('... acquisition complete')
+	header = mxo.channel.data.header.get()
+	print('Waveform:')
+	print(f'Time start: {header.Xstart} s, Time stop: {header.Xstop} s')
+	waveform = mxo.channel.data.values.get()
+	print(f'Record length: {len(waveform)} samples')
+
+	mxo.close()
+
+Supported instruments: MXO3, MXO44, MXO58, MXO58C, ScopeStudio
+
+The package is hosted here: https://pypi.org/project/rsmxo/
+
+Documentation: https://rsmxo.readthedocs.io/
+
+Examples: https://github.com/Rohde-Schwarz/Examples/tree/main/Oscilloscopes/Python/RsMxo_ScpiPackage
+
+
+Version history
+----------------
+
+	Latest release notes summary: Update for MXO FW 2.8.0
+
+	Version 2.8.0
+		- Update for MXO FW 2.8.0
+		- Changed the project name and module name from 'RsMxo' to 'rsmxo' to comply with IVI-Python drivers
+
+	Version 2.7.3
+		- Added pypi IVI classifier 'Topic :: Scientific/Engineering :: Instrument Drivers'
+
+	Version 2.7.2
+		- Update for FW 2.7
+
+	Version 2.6.4
+		- Fixed MEASurement commands.
+		- Added STATus commands.
+		- Small bug fixes.
+
+	Version 2.6.3
+		- Updated example links and readme file.
+
+	Version 2.6.2
+		- Small interface improvements and bug fixes.
+
+	Version 2.6.1
+		- Fixed bug, where arguments or return values were wrongly scalar instead of lists.
+
+	Version 2.6.0
+		- First released version

rsmxo-2.8.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rsmxo"
+version = "2.8.0"
+license="MIT"
+description="MXO Series Digital Oscilloscopes Driver Remote-control module"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+keywords = ["MXO","MXO3","MXO4","MXO5","MXO44","MXO58","ScopeStudio"]
+authors = [
+		{name = "Rohde & Schwarz GmbH & Co. KG"}
+	]
+maintainers = [
+		{name = "Rohde & Schwarz GmbH & Co. KG"}
+	]
+	
+requires-python = ">= 3.9"
+dependencies = [
+		"pyvisa>=1.13.0",
+		"typing-extensions>=4.0.0"
+	]
+
+classifiers = [
+	  # How mature is this project? Common values are
+	  #   4 - Beta
+	  #   5 - Production/Stable
+	  "Development Status :: 5 - Production/Stable",
+
+	  # IVI Trove Classifier(s)
+	  "Topic :: Scientific/Engineering :: Instrument Drivers",
+
+	  # Specify the Python versions you support here.
+	  "Programming Language :: Python :: 3",
+	  "Programming Language :: Python :: 3.9",
+	  "Programming Language :: Python :: 3.10",
+	  "Programming Language :: Python :: 3.11",
+	  "Programming Language :: Python :: 3.12",
+	  "Programming Language :: Python :: 3.13",
+	  "Programming Language :: Python :: 3.14"
+	]
+
+[project.urls]
+Documentation = "https://rsmxo.readthedocs.io/"
+Examples = "https://github.com/Rohde-Schwarz/Examples/"

rsmxo-2.8.0/rsmxo/CustomFiles/__init__.py

@@ -0,0 +1 @@
+"""Fixed files that are common for the Instrument drivers and the RsInstrument module."""

rsmxo-2.8.0/rsmxo/CustomFiles/events.py

@@ -0,0 +1,90 @@
+"""Event-related methods and properties. Here you can set all the event handlers."""
+
+from typing import Callable
+
+from ..Internal.Core import Core
+
+
+class Events:
+	"""Common Events class.
+	Event-related methods and properties. Here you can set all the event handlers.
+	Access snippet: ``events = RsMxo.events``"""
+	def __init__(self, core: Core):
+		self._core = core
+
+	@property
+	def io_events_include_data(self) -> bool:
+		"""Returns the current state of the io_events_include_data See the setter for more details."""
+		return self._core.io.io_events_include_data
+
+	@io_events_include_data.setter
+	def io_events_include_data(self, value: bool) -> None:
+		"""If True, the on_write and on_read events include also the transferred data.
+		Default value is False, to avoid handling potentially big data."""
+		self._core.io.io_events_include_data = value
+
+	@property
+	def before_write_handler(self) -> Callable:
+		"""Returns the handler of before_write events. \n
+		:return: current ``before_write_handler``"""
+		return self._core.io.before_write_handler
+
+	@before_write_handler.setter
+	def before_write_handler(self, handler: Callable) -> None:
+		"""Sets handler for before_write events.
+		The before_write event is invoked before each write operation (only once, not for every chunk)
+		Event prototype: handler(io: Instrument, cmd: str)
+		:param handler: new handler"""
+		self._core.io.before_write_handler = handler
+
+	@property
+	def on_write_handler(self) -> Callable:
+		"""Returns the handler of on_write events. \n
+		:return: current ``on_write_handler``"""
+		return self._core.io.on_write_handler
+
+	@on_write_handler.setter
+	def on_write_handler(self, handler: Callable) -> None:
+		"""Sets handler for on_write events.
+		The on_write event is invoked every time the driver performs a write operation to the instrument (for each write chunk)
+		Event arguments type: IoTransferEventArgs
+		By default, the event_args do not contain the actual data sent. If you wish to receive them, set the driver.Events.io_events_include_data to True \n
+		:param handler: new handler for all write operations"""
+		self._core.io.on_write_handler = handler
+
+	@property
+	def on_read_handler(self) -> Callable:
+		"""Returns the handler of on_read events. \n
+		:return: current ``on_read_handler``"""
+		return self._core.io.on_read_handler
+
+	@on_read_handler.setter
+	def on_read_handler(self, handler: Callable) -> None:
+		"""Sets handler for on_read events.
+		The on_read event is invoked every time the driver performs a read operation to the instrument.
+		Event arguments type: IoTransferEventArgs
+		By default, the event_args do not contain the actual data sent. If you wish to receive them, set the driver.Events.io_events_include_data to True \n
+		:param handler: new handler for all read operations"""
+		self._core.io.on_read_handler = handler
+
+	@property
+	def before_query_handler(self) -> Callable:
+		"""Returns the handler of before_query events. \n
+		:return: current ``before_query_handler``"""
+		return self._core.io.before_query_handler
+
+	@before_query_handler.setter
+	def before_query_handler(self, handler: Callable) -> None:
+		"""Sets handler for before_query events.
+		The before_query event is invoked before each query operation (only once, not for every chunk)
+		Event prototype: handler(io: Instrument, query: str)
+		:param handler: new handler"""
+		self._core.io.before_query_handler = handler
+
+	def sync_from(self, source: 'Events') -> None:
+		"""Synchronizes these Events with the source."""
+		self.before_query_handler = source.before_query_handler
+		self.before_write_handler = source.before_write_handler
+		self.io_events_include_data = source.io_events_include_data
+		self.on_read_handler = source.on_read_handler
+		self.on_write_handler = source.on_write_handler

rsmxo-2.8.0/rsmxo/CustomFiles/ivi_direct_io.py

@@ -0,0 +1,52 @@
+"""Module required by IVI Python driver standard."""
+
+from typing import Any
+from ..Internal.Core import Core
+
+
+class IviDirectIo:
+    """Direct IO class required by the IVI-Python standard."""
+
+    def __init__(self, core: Core):
+        self._core = core
+
+    @property
+    def session(self) -> Any:
+        """Returns the underlying instrument session, usually a VISA session."""
+        return self._core.io.get_session_handle()
+
+    @property
+    def io_timeout_ms(self) -> int:
+        """Return the timeout of the underlying instrument session in milliseconds."""
+        return self._core.io.visa_timeout
+
+    @io_timeout_ms.setter
+    def io_timeout_ms(self, timeout_ms: int) -> None:
+        """Sets the timeout of the underlying instrument session in milliseconds."""
+        self._core.io.visa_timeout = timeout_ms
+
+    def read_bytes(self) -> bytes:
+        """Read a complete response from the instrument as bytes.
+        The response message terminator is not included in the bytes object."""
+        return self._core.io.read_all_bytes()
+ 
+    def read_string(self) -> str:
+        """Read a complete response from the instrument as a string.
+        The response message terminator is not included in the string."""
+        return self._core.io.read_str(block_check_status=True)
+ 
+    def write_bytes(self, data: bytes) -> None:
+        """Write bytes to the instrument followed by the normal message termination sequence.
+        For IEEE 488.2 instruments the termination sequence is typically a line feed character with END asserted.
+        The bytes must include a complete instrument message. The driver adds the termination sequence."""
+        self._core.io.write_raw_bytes(data)
+ 
+    def write_string(self, data: str) -> None:
+        """Write a string to the instrument followed by the normal message termination sequence.
+        For IEEE 488.2 instruments the termination sequence is typically a line feed character with END asserted.
+        The string must include a complete instrument message. The driver adds the termination sequence."""
+        self._core.io.write(data, block_check_status=True)
+
+    def sync_from(self, source: 'IviDirectIo') -> None:
+        """Synchronizes this object with the source."""
+        pass

rsmxo-2.8.0/rsmxo/CustomFiles/ivi_utility.py

@@ -0,0 +1,105 @@
+"""Module required by IVI Python driver standard."""
+
+from typing import Tuple, Collection
+from ..Internal.Core import Core
+
+
+class ErrorQueryResult:
+    """Structure class for holding one error query result."""
+
+    def __init__(self, code: int, message: str) -> None:
+        self._code = code
+        self._message = message
+
+    @property
+    def code(self) -> int:
+        return self._code
+
+    @property
+    def message(self) -> str:
+        return self._message
+
+
+class IviUtility:
+    """Utilities class required by the IVI-Python standard."""
+
+    def __init__(self, core: Core):
+        self._core = core
+
+    @property
+    def driver_version(self) -> str:
+        """Returns the instrument driver version."""
+        return self._core.driver_version
+
+    @property
+    def driver_vendor(self) -> str:
+        """Returns the driver manufacturer: 'ROHDE&SCHWARZ'."""
+        return "ROHDE&SCHWARZ"
+
+    @property
+    def instrument_manufacturer(self) -> str:
+        """Returns the manufacturer of the instrument."""
+        return self._core.io.manufacturer
+
+    @property
+    def instrument_model(self) -> str:
+        """Returns the current instrument's full name e.g. 'FSW26'."""
+        return self._core.io.full_model_name
+
+    @property
+    def query_instrument_status_enabled(self) -> bool:
+        """Sets / returns Instrument Status Checking.
+        When True (default is True), all the driver methods and properties are sending "SYSTem:ERRor?"
+        at the end to immediately react on error that might have occurred.
+        We recommend to keep the state checking ON all the time. Switch it OFF only in rare cases when you require maximum speed.
+        The default state after initializing the session is ON."""
+        return self._core.io.query_instr_status
+
+    @query_instrument_status_enabled.setter
+    def query_instrument_status_enabled(self, value) -> None:
+        """Sets / returns Instrument Status Checking.
+        When True (default is True), all the driver methods and properties are sending "SYSTem:ERRor?"
+        at the end to immediately react on error that might have occurred.
+        We recommend to keep the state checking ON all the time. Switch it OFF only in rare cases when you require maximum speed.
+        The default state after initializing the session is ON."""
+        self._core.io.query_instr_status = value
+
+    @property
+    def simulation_enabled(self) -> bool:
+        """Read-only property indicating if simulation mode is enabled. This property is only settable in the driver's constructor options parameter 'Simulate'."""
+        return self._core.simulating
+
+    @property
+    def supported_instrument_models(self) -> Tuple[str, ...]:
+        """Returns models supported by the driver, one per element."""
+        return self._core.supported_instr_models
+
+    def reset(self) -> None:
+        """Resets the instrument and clears its status.
+        This is typically done by sending the *RST and *CLS SCPI Commands."""
+        self._core.io.reset()
+
+    def error_query(self) -> ErrorQueryResult | None:
+        """Returns the last error in the instrument's error queue.
+        Returns None if no error is present."""
+        err = self._core.io.query_syst_error(include_code=True, enable_log=True)
+        if err is None:
+            return None
+        return ErrorQueryResult(err[0], err[1])
+
+    def error_query_all(self) -> Collection[ErrorQueryResult]:
+        """Returns all the errors currently reported in the instrument's error queue.
+          If no error is present, the method returns an empty collection."""
+        errs = self._core.io.query_all_syst_errors(include_codes=True, enable_log=True)
+        if errs is None:
+            return []
+        ret_val = [ErrorQueryResult(errs[x][0], errs[x][1]) for x in range(len(errs))]
+        return ret_val
+
+    def raise_on_device_error(self) -> None:
+        """Calls error_query_all() and raises an exception if any instrument errors were detected."""
+        self._core.io.check_status_always(log_ok_result=True)
+
+    def sync_from(self, source: 'IviUtility') -> None:
+        """Synchronizes this object with the source."""
+        pass