scpi


Namescpi JSON
Version 2.5.1 PyPI version JSON
download
home_pagehttps://github.com/rambo/python-scpi/
SummaryBasic idea here is to make transport-independent command sender/parser and a device baseclass that implements the common SCPI commands
upload_time2025-01-07 14:07:12
maintainerNone
docs_urlNone
authorEero af Heurlin
requires_python<4.0,>=3.9
licenseLGPL
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ====
scpi
====

New asyncio_ version. Only for Python 3.6 and above

Since all the other wrappers either require VISA binary or are not generic (and do not implement the device I need)

Basic idea here is to make transport-independent command sender/parser and a device baseclass that implements the common SCPI commands

A device specific implementation can then add the device-specific commands.

Pro tip for thos wishing to work on the code https://python-poetry.org/

.. _asyncio: https://docs.python.org/3/library/asyncio.html


## Usage

Install the package to your virtualenv with poetry or from pip

  - Instatiate a transport (for GPIB you will need `GPIBDeviceTransport` to be able to use the device helper class)
  - Instatiate `SCPIProtocol` with the transport (optional, see below)
  - Instantiate `SCPIDevice` with the protocol (or as a shorthand: with the transport directly)
  - Use the asyncio eventloop to run the device methods (all of which are coroutines)

Or if you're just playing around in the REPL use `AIOWrapper` to hide the eventloop handling
for traditional non-concurrent approach.

See the examples directory for more.

TODO
----

Check Carrier-Detect for RS232 transport
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

in the RS232 transport check getCD to make sure the device is present before doing anything.
CTS can also be checked even if hw flow control is not in use.

Basically wait for it for X seconds and abort if not found


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rambo/python-scpi/",
    "name": "scpi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Eero af Heurlin",
    "author_email": "eero.afheurlin@iki.fi",
    "download_url": "https://files.pythonhosted.org/packages/e3/74/f257c33c3f1e130deb6ee3731cd0cbba23dd71159ba2234d24109491179f/scpi-2.5.1.tar.gz",
    "platform": null,
    "description": "====\nscpi\n====\n\nNew asyncio_ version. Only for Python 3.6 and above\n\nSince all the other wrappers either require VISA binary or are not generic (and do not implement the device I need)\n\nBasic idea here is to make transport-independent command sender/parser and a device baseclass that implements the common SCPI commands\n\nA device specific implementation can then add the device-specific commands.\n\nPro tip for thos wishing to work on the code https://python-poetry.org/\n\n.. _asyncio: https://docs.python.org/3/library/asyncio.html\n\n\n## Usage\n\nInstall the package to your virtualenv with poetry or from pip\n\n  - Instatiate a transport (for GPIB you will need `GPIBDeviceTransport` to be able to use the device helper class)\n  - Instatiate `SCPIProtocol` with the transport (optional, see below)\n  - Instantiate `SCPIDevice` with the protocol (or as a shorthand: with the transport directly)\n  - Use the asyncio eventloop to run the device methods (all of which are coroutines)\n\nOr if you're just playing around in the REPL use `AIOWrapper` to hide the eventloop handling\nfor traditional non-concurrent approach.\n\nSee the examples directory for more.\n\nTODO\n----\n\nCheck Carrier-Detect for RS232 transport\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nin the RS232 transport check getCD to make sure the device is present before doing anything.\nCTS can also be checked even if hw flow control is not in use.\n\nBasically wait for it for X seconds and abort if not found\n\n",
    "bugtrack_url": null,
    "license": "LGPL",
    "summary": "Basic idea here is to make transport-independent command sender/parser and a device baseclass that implements the common SCPI commands",
    "version": "2.5.1",
    "project_urls": {
        "Homepage": "https://github.com/rambo/python-scpi/",
        "Repository": "https://github.com/rambo/python-scpi/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8abe996b784364963c011d1891f47697964be667b14a10340cf068e1d5968023",
                "md5": "d767a4cd0852777653bcbf5c42013b66",
                "sha256": "4d6f5a1ff1a906ccf9015605fd1c0711387b2dd5083c2e176ba5c85c88c7b23d"
            },
            "downloads": -1,
            "filename": "scpi-2.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d767a4cd0852777653bcbf5c42013b66",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 22166,
            "upload_time": "2025-01-07T14:07:10",
            "upload_time_iso_8601": "2025-01-07T14:07:10.256009Z",
            "url": "https://files.pythonhosted.org/packages/8a/be/996b784364963c011d1891f47697964be667b14a10340cf068e1d5968023/scpi-2.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e374f257c33c3f1e130deb6ee3731cd0cbba23dd71159ba2234d24109491179f",
                "md5": "b8b596746c88fe55470bcdc050a64295",
                "sha256": "d8df239f7adb475cc01e7da508a1b85a94310a9c0a887972d48a4851d7f45dbc"
            },
            "downloads": -1,
            "filename": "scpi-2.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b8b596746c88fe55470bcdc050a64295",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 16889,
            "upload_time": "2025-01-07T14:07:12",
            "upload_time_iso_8601": "2025-01-07T14:07:12.677730Z",
            "url": "https://files.pythonhosted.org/packages/e3/74/f257c33c3f1e130deb6ee3731cd0cbba23dd71159ba2234d24109491179f/scpi-2.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-07 14:07:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rambo",
    "github_project": "python-scpi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "scpi"
}
        
Elapsed time: 1.55640s