Metadata-Version: 1.1
Name: ds1054z
Version: 0.3.2
Summary: Python package and software for the Rigol DS1054Z oscilloscope.
Home-page: https://github.com/pklaus/ds1054z
Author: Philipp Klaus
Author-email: philipp.l.klaus@web.de
License: GPL
Description: ds1054z
        =======
        
        This package allows you to connect to your Rigol DS1054Z oscilloscope
        via Ethernet. It comes with a versatile command line tool.
        
        Off course, you can also to control the scope with your own script by
        using `the
        APIs <https://ds1054z.readthedocs.org/en/latest/api/index.html>`__ this
        package has to offer.
        
        While this software is named after the entry level oscilloscope DS1054Z,
        there is no reason to believe it wouldn't also work with just any scope
        of the MSO1000Z and DS1000Z series by Rigol:
        
        -  MSO1104Z-S
        -  MSO1074Z-S
        -  MSO1104Z
        -  MSO1074Z
        -  DS1104Z-S Plus
        -  DS1074Z-S Plus
        -  DS1104Z Plus
        -  DS1074Z Plus
        -  DS1054Z
        
        Installation
        ------------
        
        The installation is dead simple:
        
        ::
        
            pip install ds1054z[savescreen,discovery]
        
        ds1054z depends on
        `python-vxi11 <https://github.com/python-ivi/python-vxi11>`__ which
        should automatically get installed along with itself.
        
        For more information on the installation, please consult the
        `installation
        section <https://ds1054z.readthedocs.org/en/stable/installation.html>`__
        of the `package
        documentation <https://ds1054z.readthedocs.org/en/stable/index.html>`__.
        
        Features
        --------
        
        -  Discovering your scope via mDNS / DNS-SD
        -  Saving Screenshots (incl. adjustable dimming of on-screen controls)
        -  Running / stopping the scope
        -  Acquiring waveforms
        -  ... more to come!
        
        Usage
        -----
        
        Command Line Tool
        ~~~~~~~~~~~~~~~~~
        
        This package installs a versatile command line (CLI) tool called
        ``ds1054z``. You can use it to save the screen of your scope, for
        example:
        
        .. code:: bash
        
            ds1054z save-screen --overlay 0.6 192.168.0.23
        
        As a result, a file like this will be saved to your current working
        directory:
        
        .. figure:: docs/images/ds1054z-scope-display.png
           :alt: oscilloscope screenshot
        
           oscilloscope screenshot
        Find out more ways to use the CLI tool with ``ds1054z --help``
        
        Developers
        ~~~~~~~~~~
        
        If you're into Python programming, use `the DS1054Z
        class <https://ds1054z.readthedocs.org/en/stable/api/ds1054z.html>`__ in
        your own code:
        
        .. code:: python
        
            from ds1054z import DS1054Z
        
            scope = DS1054Z('192.168.0.23')
            print("Connected to: ", scope.idn)
        
            print("Currently displayed channels: ", str(scope.displayed_channels))
        
        Author
        ------
        
        -  Philipp Klaus
            philipp.l.klaus@web.de
        
        Resources
        ---------
        
        -  This Python package was inspired by
           `DS1054Z\_screen\_capture <https://github.com/RoGeorge/DS1054Z_screen_capture>`__.
        -  The device discovery built into this software is largely based on
           `this
           code <https://gist.github.com/MerseyViking/c67b7d6ebdda55929fbd>`__
           by `MerseyViking / GeoSpark <https://github.com/MerseyViking>`__.
        -  There is a Qt4 based GUI interface for the scope called
           `DSRemote <http://www.teuniz.net/DSRemote/>`__.
        
        
Keywords: Rigol Oscilloscope DS1054Z
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Classifier: Intended Audience :: Science/Research
