Metadata-Version: 2.1
Name: nipiezojenapy
Version: 1.0.1
Summary: A package for controlling Jena PiezoSystem NV40 3CLE amplifier vi NIDAQMX.
Author-email: "G. Adam Cox" <gadamc@gmail.com>
Maintainer-email: "G. Adam Cox" <gadamc@gmail.com>, Maxwell Parsons <mfpars@uw.edu>
Project-URL: Homepage, https://github.com/qt3uw/nipiezojenapy
Project-URL: Source, https://github.com/qt3uw/nipiezojenapy
Project-URL: Bug Tracker, https://github.com/qt3uw/nipiezojenapy/issues
Project-URL: Changelog, https://github.com/qt3uw/nipiezojenapy/releases
Keywords: qt3,National Instruments,Jena,piezo,stage,control
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Control of PiezoSystemJena NV40/3CLE via NI DAQmx

Control of the Jena's piezo accuators via their multi-channel amplifier.
https://www.piezosystem.com/products/amplifiers/multi-channel/40ma-multi-channel-amplifiers/

Uses NIDAQ device to read and write analog voltages between 0 and 10 to
three input and output voltage channels connected to a Jena NV40/3CLE
amplifier. Each input/output channel controls one of three axis (x, y, or z).

When using this software, one must at least provide three analog channels on
the NIDAQ that are connected to the NV40/3CLE amplifier that control (write)
the location of the piezo stage.

This program does not *need* to read voltages from the amplifier. If no read
channels are provided, this program will report the last written values when
reporting the current location.  

This controller does *NOT* lock out usage of analog input and output channels
on the NI-DAQ card. It writes or reads to the analog channels and then releases
the resource. This would allow external programs to access those channels, so
long as the access is not simultaneous.

## Installation

#### Requirements

This python package depends upon National Instruments driver and NI DAQ card
that contains three analog input and output channels.

You must first install the NI DAQmx driver.
[http://www.ni.com/downloads/](http://www.ni.com/downloads/).

PIP should install the rest of the dependencies.

### Local Installation

```
pip install nipiezojenapy
```

## Usage

### GUI Application

From the shell prompt, launch

```
> qt3piezo
```

For help on hardware configuration use the help option (`qt3piezo -h`)

### Programmatically

```
import nipiezojenapy
pcon = nipiezojenapy.PiezoControl(device_name = 'Dev1',
                                  write_channels = ['ao0','ao1','ao2'],
                                  read_channels = ['ai0','ai1','ai2'])
```

### Read Position

```
print(pcon.get_current_position())
[39.953595487425225, 40.047631567251806, 39.9510191567554]
```

### Go To Position

```
pcon.go_to_position(x = 20, y = 20, z = 20)
pcon.get_current_position()
[19.935887437291537, 19.94876864898489, 19.872769502734947]
```

Note that each axis can be set independently. That is, one may move along
a single axis without specifying the other axis values.

```
pcon.go_to_position(z = 40)
pcon.get_current_position()
[19.913989377848296, 19.988700406441584, 39.91623869419529]
```

# LICENSE

[LICENCE](LICENSE)
