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.3.1.tar.gz (7.1 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.3.1-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3fabd0f1c6b9e34b60e72d4cabbe1628e0ccf28fc7f0c110a441d7f05039ba97
MD5 837e817e8420d2bd1097a24bc0e9454a
BLAKE2b-256 70a1794fb314255260256c879a748ce5de2c31eafb71e823a08ee146a35fc1c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for spektralwerk_scpi_client-0.3.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.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 717e1744262dbfdc274c0be0ddceb08eaff2f09706d80293617914de7f533f25
MD5 dee5fe6dabc2d2b4e129dedcc41bbaab
BLAKE2b-256 095d84f7e8abd7e03f6282dcac877b997cdba21d4703fe5a2d2997b4273f8b54

See more details on using hashes here.

Provenance

The following attestation bundles were made for spektralwerk_scpi_client-0.3.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