spektralwerk-scpi-client 0.5.1

Spektralwerk SCPI communication library

spektralwerk_scpi_client

spektralwerk_scpi_client is a Python library for communicating with Spektralwerk NIR spectrometers via their SCPI interface.

The library supports all available configuration settings as well as the retrieval of spectral data.

The API supports two ways of obtaining spectra:

• single spectrum mode: returns a single spectrum upon request. Intended for use cases like exploratory spectroscopy in the lab or requests triggered by the trigger in interface
• streaming streaming mode: returns a continuous stream of spectral information. Intended for process analytics, in-line spectrometry in production and other situations demanding very high sample rates.

Supported Devices

• Spektralwerk Core
  • set/get exposure time
  • set/get average number
  • set/get offset voltage
  • set/get light and dark reference spectrum
  • get pixel count and wavelengths array of the spectrometer
  • get single/averaged raw spectrum and continuous emisison of spectra
  • configuration of processing steps
    • set/get output format of the Spektralwerk Core
    • set/get the number of emitted spectra
    • set/get region-of-interest
    • set/get binning width

Requirements

• Python3
• hatch for development (e.g. pipx install hatch)
• bump-my-version for semantic verioning

Usage

spektralwerk-scpi-client is available via PyPI. To install spektralwerk-scpi-client use pip:

pip install spektralwerk-scpi-client

Example Usage

An example can be found in the examples directory.

export SCPI_HOST="<hostname or IP>"
export SCPI_PORT="<port number>"
hatch run examples:spw_core_demo

Development

bump-my-version for increasing version of spektralwerk-scpi-client. The configuration of bump-my-version is located in .bumpversion.toml and pyproject.toml. To increase the version these commands can be used:

# Create a new release.
hatch run version {major|minor|patch}

License

spektralwerk_scpi_client is distributed under the terms of the MIT license.