Skip to main content

Spektralwerk SCPI communication library

Project description

spektralwerk_scpi_client

style and lint Upload to PyPI

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 raw spectrum and averaged raw spectrum

Requirements

  • Python3
  • hatch for development (e.g. pipx install hatch)

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 SPW_HOST="<hostname or IP>"
export SPW_PORT="<port number>"
hatch run examples:spw_core_demo

License

spektralwerk_scpi_client is distributed under the terms of the MIT license.

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

spektralwerk_scpi_client-0.4.1.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spektralwerk_scpi_client-0.4.1-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file spektralwerk_scpi_client-0.4.1.tar.gz.

File metadata

  • Download URL: spektralwerk_scpi_client-0.4.1.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for spektralwerk_scpi_client-0.4.1.tar.gz
Algorithm Hash digest
SHA256 a162b252031d892e77678ed3020872f87cd24c0c77ba6bf2aee5e95afc4afcad
MD5 afa8f5629c47faffbd843167cf5a2ce8
BLAKE2b-256 04cbcd9e87422feebcb78fa6d99dbfa40a424205ffa2457db9a0628aa779cb45

See more details on using hashes here.

Provenance

The following attestation bundles were made for spektralwerk_scpi_client-0.4.1.tar.gz:

Publisher: pypi-publish.yml on silicann/spektralwerk-scpi-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file spektralwerk_scpi_client-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15a656d11dc479d0cb0262e8505f4001524764498688f8dcb249c4c15cd76c5b
MD5 4ed88a57080f3f4bd526e3e3142b1821
BLAKE2b-256 69f01cf6d19dbd1f5add00e7ad506c96227cb94656f4d8d8ce78521385a6d67b

See more details on using hashes here.

Provenance

The following attestation bundles were made for spektralwerk_scpi_client-0.4.1-py3-none-any.whl:

Publisher: pypi-publish.yml on silicann/spektralwerk-scpi-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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