Devices

Core

pychron.hardware.core.abstract_device.AbstractDevice

pychron.hardware.core.base_core_device.BaseCoreDevice

pychron.hardware.core.core_device.CoreDevice

alias of builtins.str

class pychron.hardware.core.scanable_device.ScanableDevice(*args, **kwargs)

start_scan(period=None)

Parameters

period – delapy between triggers in milliseconds

Returns

class pychron.hardware.core.viewable_device.ViewableDevice(*args, **kwargs)

class pychron.hardware.core.scpi_device.SCPIDevice

configure_instrument()

subclass should define this method

get_measurement()

return a value read from the device

initialize(*args, **kw)

initialize instrument

trigger()

trigger a measurement. should be followed by a FETCH? (AgilentDMM.get_value)

Communicators

class pychron.hardware.core.communicators.communicator.Communicator(*args, **kw)

Base class for all communicators, e.g. SerialCommunicator, EthernetCommunicator

delay(ms)

sleep ms milliseconds

load(config, path)

log_response(cmd, re, info=None)

Log command and response as an INFO message

log_tell(cmd, info=None)

Log command as and INFO message

class pychron.hardware.core.communicators.serial_communicator.SerialCommunicator(*args, **kw)

Base Class for devices that communicate using a rs232 serial port. Using Keyspan serial converter is the best option for a Mac class is built on top of pyserial. Pyserial is used to create a handle and this class uses the handle to read and write. handles are created when a serial device is opened setup args are loaded using load(). this method should be overwritten to load specific items.

ask(cmd, is_hex=False, verbose=True, delay=None, replace=None, remove_eol=True, info=None, nbytes=None, handshake_only=False, handshake=None, read_terminator=None, terminator_position=None, nchars=None)

load(config, path)

open(**kw)

Use pyserial to create a handle connected to port wth baudrate default handle parameters baudrate=9600 bytesize=EIGHTBITS parity= PARITY_NONE stopbits= STOPBITS_ONE timeout=None

read(nchars=None, *args, **kw)

tell(cmd, is_hex=False, info=None, verbose=True, **kw)

class pychron.hardware.core.communicators.gpib_communicator.GpibCommunicator(*args, **kw)

uses PyVisa as main interface to GPIB. currently (8/27/14) need to use a 32bit python version. The NI488.2 framework does not work with a 64bit distribution

load(config, path, **kw)

open(*args, **kw)

class pychron.hardware.core.communicators.ethernet_communicator.EthernetCommunicator(*args, **kw)

Communicator of UDP or TCP.

ask(cmd, retries=3, verbose=True, quiet=False, info=None, timeout=None, message_frame=None, delay=None, use_error_mode=True, *args, **kw)

@param cmd: ASCII text to send @param retries: number of retries if command fails @param verbose: add to log @param quiet: if true do not log the response @param info: str to add to response @param timeout: timeout in seconds @param message_frame: MessageFrame object @param delay: delay in seconds to wait before a cmd is sent

load(config, path)

open(*args, **kw)

class pychron.hardware.core.communicators.mcode_communicator.MDriveCommunicator(*args, **kw)

open()

class pychron.hardware.core.communicators.modbus_communicator.ModbusCommunicator(*args, **kw)

modbus message syntax [Device address][function code][data][error check]

load(config, path)

read(register, response_type='float', nregisters=1, **kw)

read_holding_register(holdid, nregisters, response_type, **kw)

set_multiple_registers(startid, nregisters, value, response_type, **kw)

set_single_register(rid, value, response_type, func_code='06', **kw)

tell(*args, **kw)

write(register, value, nregisters=1, response_type='register_write', **kw)

class pychron.hardware.core.communicators.scheduler.CommunicationScheduler(*args, **kw)

this class should be used when working with multiple rs485 devices on the same port.

it uses a simple lock and sleep cycle to avoid collision on the data lines

when setting up the devices use device.set_scheduler to set the shared scheduler

Actuators

class pychron.hardware.actuators.actuator.Actuator(*args, **kwargs)

close_channel(*args, **kw)

get_channel_state(*args, **kw)

load_additional_args(config)

open_channel(*args, **kw)

ADC

Aerotech

Agilent

Arduino

Eurotherm

Fusions

Gauges

Kerr

Labjack

MDrive

NCD

Newport