Skip to main content

An easy library for controlling SCPI instruments

Project description

Easy SCPI

A simple and robust library making communication with SCPI (Standard Control of Programmbale Instruments) instruments easy. After creating an instrument object that connects to an actual instrument, commands are sent to the instrument using a property-like format. This class is useful for inheritance when creating a controller for a specific instrument. Communication with instruments is done with PyVISA.

API

SCPI Commands

Generic SCPI commands can be executed by transforming the SCPI code in to attributes via the hierarchy relationship, then calling it. Instrument properties can be queried by passing no arguments to the call. Commands with no arguments are run by passing an empty string to the call.

Examples

# import package
import easy_scpi as scpi 

# Connect to an instrument
inst = scpi.SCPI_Instrument( <port> )

# Read the voltage [MEASure:VOLTage:DC?]
inst.measure.voltage.dc()
# or
inst.meas.volt.dc()

# Set the voltage to 1 V [MEASure:VOLTage:DC 1]
inst.measure.voltage.dc( 1 )
# or
inst.source.voltage( '1' )

# Execute a command to take a reading [SYSTem:ZCORrect:ACQuire]
inst.syst.zcor.aqc( '' )

Methods

SCPI_Instrument( <port>, backend = '', **resource_params ): Creates an instance of a SCPI instrument. The backend is used to create the VISA Resource Manager. Upon connection, the resource_params are passed to the VISA resource.

connect(): Connects the object instance to the actual instrument on the specified port

disconnect(): Disconnects the instrument from the program, closing the port

write( <msg> ): Sends msg to the instrument

read(): Gets the most recent response from the instrument

query( <msg> ): Sends msg to the instrument and returns its response

reset(): Sets the instrument to its default state

init(): Initializes the instrument for a measurement

Properties

backend: Returns teh name of teh VISA backend used. [Read Only]

inst: Returns the resource used by the instance. [Read Only]

port: The communication port.

rid: The resource id associated with the instrument. [Read Only]

resource_params: Returns the resource parameters passed on creation. [Read Only]

timeout: The communication timeout of the instrument. [Read Only]

id: The manufacturer id of the instrument. [Read Only]

value: The current value of the instrument. [Read Only]

connected: Whether the instrument is connected or not. [Read Only]

is_connected: Alias for connected.

Full Example

For use with Tektronix PWS4305

#standard imports
import os
import sys

#SCPI imports
import usb
import visa

# scpi controller
import easy_scpi as scpi


class PowerSupply( ic.Instrument ):

    def __init__( self, timeout = 10, rid = None ):
        scpi.SCPI_Instrument.__init__( 
            self, 
            port = None, 
            timeout = timeout, 
            read_termination = '\n', 
            write_termination = '\n' 
        )

        # other initialization code...


    #--- public methods ---


    @property        
    def voltage( self ):
        """
        Returns the voltage setting
        """
        return self.source.volt.level()


    @voltage.setter
    def voltage( self, volts ):
        """
        Sets the voltage of the instrument
        """
        self.source.volt.level( volts )


    @property
    def current( self ):
        """
        Returns the current setting in Amps
        """
        return self.source.current.level()


    @current.setter
    def current( self, amps ):
        """
        Set the current of the instrument
        """
        self.source.current.level( amps )


    def on( self ):
        """
        Turns the output on
        """
        self.output.state( 'on' )


    def off( self):
        """
        Turns the output off
        """
        self.output.state( 'off' )

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easy-scpi-0.0.4.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

easy_scpi-0.0.4-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file easy-scpi-0.0.4.tar.gz.

File metadata

  • Download URL: easy-scpi-0.0.4.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for easy-scpi-0.0.4.tar.gz
Algorithm Hash digest
SHA256 5f85ff5a4ff738c3efff9980245cc4f6004bea161dca1e39b192a5c39f9ee90e
MD5 4893b70cdc3bd3aeda6b3892b3bd8316
BLAKE2b-256 2df9fc35de049dfa74600b4529f4c3cca274749ec141589005b94d8a583227db

See more details on using hashes here.

File details

Details for the file easy_scpi-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: easy_scpi-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for easy_scpi-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b23d44eb8dea55716f2d825d7fc4db3636f700e23ccfc63ec300d232242fee21
MD5 f1ac996bb36dc945e1397646e81356c4
BLAKE2b-256 ba9ef45f54330ab9003fc0bab34564f20640b7e1c016bc6b6ff793bb36cd9fa3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page