RsMxo 2.6.0__tar.gz

rsmxo-2.6.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.4
+Name: RsMxo
+Version: 2.6.0
+Summary: MXO Seriers 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,MXO4,MXO5,MXO44,MXO58
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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
+Requires-Python: >=3.8
+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 Seriers Digital Oscilloscopes Driver RsMxo instrument driver.
+
+Basic Hello-World code:
+
+.. code-block:: python
+
+    from RsMxo import *
+
+    instr = RsMxo('TCPIP::192.168.56.101::hislip0', reset=True)
+    idn = instr.query_str('*IDN?')
+    print('Hello, I am: ' + idn)
+
+Supported instruments: MXO44,MXO58,MXO58C
+
+The package is hosted here: https://pypi.org/project/RsMxo/
+
+Documentation: https://RsMxo.readthedocs.io/
+
+Examples: https://github.com/Rohde-Schwarz/Examples/
+
+
+Version history
+----------------
+
+	Latest release notes summary: First released version
+
+	Version 2.6.0
+		- First released version

rsmxo-2.6.0/README.rst

@@ -0,0 +1,47 @@
+==================================
+ 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 Seriers Digital Oscilloscopes Driver RsMxo instrument driver.
+
+Basic Hello-World code:
+
+.. code-block:: python
+
+    from RsMxo import *
+
+    instr = RsMxo('TCPIP::192.168.56.101::hislip0', reset=True)
+    idn = instr.query_str('*IDN?')
+    print('Hello, I am: ' + idn)
+
+Supported instruments: MXO44,MXO58,MXO58C
+
+The package is hosted here: https://pypi.org/project/RsMxo/
+
+Documentation: https://RsMxo.readthedocs.io/
+
+Examples: https://github.com/Rohde-Schwarz/Examples/
+
+
+Version history
+----------------
+
+	Latest release notes summary: First released version
+
+	Version 2.6.0
+		- First released version

rsmxo-2.6.0/RsMxo/CustomFiles/__init__.py

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

rsmxo-2.6.0/RsMxo/CustomFiles/events.py

@@ -0,0 +1,89 @@
+"""Event-related methods and properties. Here you can set all the event handlers."""
+
+from typing import Callable
+
+from ..Internal import Core
+
+
+class Events:
+	"""Common Events class.
+	Event-related methods and properties. Here you can set all the event handlers."""
+	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:
+		"""Synchronises 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