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.2.tar.gz (9.5 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.2-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.4.2.tar.gz
Algorithm Hash digest
SHA256 2cf736890ff161f801a54475dff112ca615efdbdc525458efc61e647f5373fc3
MD5 a6da9b9925f2f32c5afd43215d583994
BLAKE2b-256 97c31f142df3659dea911f4cdd0ed2c23a50acb40ef1abb6a19680bdaaeb5a8a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for spektralwerk_scpi_client-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 744c71b2c662af05a1da8add1e370f79b649bbc469c16e6bf6f0461ef56e1702
MD5 cb66863f471e3702d3ec87e718264f16
BLAKE2b-256 f900995bbb999ce9c79ba34a4d8ce7cd7d125de8e7af32c306793e4f0268c72c

See more details on using hashes here.

Provenance

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