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.2.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.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.3.2.tar.gz
Algorithm Hash digest
SHA256 52cf8f0188e55fdfacfc24b2ad50db9fbb6bcf4dd9ac6525399cd0adeea72074
MD5 1d47ac34e444f6fb23ad915c37335a00
BLAKE2b-256 1aa27c8aa757ac740fef32160bb459c9696fbca12d62097900234a5424052c9a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aefc2d6c1ea68e13c207530347d490455b7fc6ce3ac2e55bc4f4fef23a8d0858
MD5 52bfa66906529a5145cb47e3a829901e
BLAKE2b-256 9de16b79fb17b3534277dc2a838ee262036ccee12927b3d2f4529f0efdce4306

See more details on using hashes here.

Provenance

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