Skip to main content

Controller class for communicating with an Oriel Cornerstone 260 monochromator.

Project description

Oriel Cornerstone 260

A library allowing easy control over Oriel Cornerstone 260 monochromators.

Install with python -m pip install oriel-cornerstone-260

Monochromator

Represents a monochromator.

  • Monochromator( port, timeout = 5 ): Creates a new monochromator for the device at the specificed port, with the provided communication timeout.

Methods

Low Level

Low level methods allows reading and writing to the device.

  • connect(): Connects to the device.

  • disconnect(): Disconnects from the device.

  • write( msg ): Writes a message to the device. Termination characters are added.

  • read(): Reads a single response from the device.

  • command( cmd, *args ): Sends a command to the device with the given arguments. Returns the command.

  • query( msg ): Queries the device. Returns a Response object.

High Level

High level methods are convenience methods used for commonly needed functions.

  • goto( wavelength ): Goes to the given wavelength.

  • abort(): Starts the given channel.

  • set_grating( grating ): Sets the grating to the given number.

  • shutter( close = True ): Open or close the shutter.

  • set_outport( port ): Sets the output port.

  • slit_width( slit, width = None ): Gets or sets the slit width.

Properties

  • _com: Serial connection from pyserial.
  • connected: Whether the device is connected or not.
  • port: Device port.
  • term_chars: Termination characters used for reading and writing. [Default: '\r\n']
  • info: Device info.
  • position: Wavelength position.
  • grating: Current grating and its properties. Returns a dictionary with number, lines, and label.
  • shuttered: Whether the shutter is closed or open.
  • outport: The output port.

Response

A namedtuple with properties statement which represents the command, and response.

Example

A basic example for using a Monochromator.

from oriel_cornerstone_260.monochromator import Monochromator

# create device
mono = Monochromator( 'COM9' )

# print monochromator info
print( mono.info )

# go to 600 nm
mono.goto( 600 )

Note

A Monochromator is a ultimately a Serial object from pyserial, so you can call any functions on a Monochromator that you would on a Serial object.

Project details


Download files

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

Files for oriel-cornerstone-260, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size oriel_cornerstone_260-0.0.3-py3-none-any.whl (16.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size oriel-cornerstone-260-0.0.3.tar.gz (3.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page