spektralwerk-scpi-client


Namespektralwerk-scpi-client JSON
Version 0.2.4 PyPI version JSON
download
home_pageNone
SummarySpektralwerk SCPI communication library
upload_time2025-08-05 12:52:46
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords scpi spektralwerk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # spektralwerk_scpi_client

[![style and lint](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/style.yml/badge.svg)](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/style.yml)
[![Upload to PyPI](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/pypi-publish.yml)

`spektralwerk_scpi_client` is a [Python](https://python.org/) library for communicating with [Spektralwerk](https://www.silicann.com/spektrometer/) devices via their [SCPI interface](https://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments).

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

## Supported Devices

- Spektralwerk Core
  - set/get exposure time
  - set/get average number
  - set/get offset voltage
  - get pixel count and wavelengths array of the spectrometer
  - get single raw spectrum and averaged raw spectrum

## Requirements

- Python3
- [hatch](https://hatch.pypa.io/) for development (e.g. `pipx install hatch`)

## Usage

`spektralwerk-scpi-client` is available via [PyPI](https://pypi.org/project/spektralwerk-scpi-client/). To install `spektralwerk-scpi-client` use `pip`:

```shell
pip install spektralwerk-scpi-client
```

## Example Usage

An example can be found in the [`examples`](./examples/) directory.

```shell
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](https://spdx.org/licenses/MIT.html) license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "spektralwerk-scpi-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "SCPI, Spektralwerk",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/72/78/b84efbff4f437cb160d46aeaa64b8dfdf005b3b9cc028a24c39aa24c56f2/spektralwerk_scpi_client-0.2.4.tar.gz",
    "platform": null,
    "description": "# spektralwerk_scpi_client\n\n[![style and lint](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/style.yml/badge.svg)](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/style.yml)\n[![Upload to PyPI](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/silicann/spektralwerk-scpi-client/actions/workflows/pypi-publish.yml)\n\n`spektralwerk_scpi_client` is a [Python](https://python.org/) library for communicating with [Spektralwerk](https://www.silicann.com/spektrometer/) devices via their [SCPI interface](https://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments).\n\nThe library supports all available configuration settings as well as the retrieval of spectral data.\n\n## Supported Devices\n\n- Spektralwerk Core\n  - set/get exposure time\n  - set/get average number\n  - set/get offset voltage\n  - get pixel count and wavelengths array of the spectrometer\n  - get single raw spectrum and averaged raw spectrum\n\n## Requirements\n\n- Python3\n- [hatch](https://hatch.pypa.io/) for development (e.g. `pipx install hatch`)\n\n## Usage\n\n`spektralwerk-scpi-client` is available via [PyPI](https://pypi.org/project/spektralwerk-scpi-client/). To install `spektralwerk-scpi-client` use `pip`:\n\n```shell\npip install spektralwerk-scpi-client\n```\n\n## Example Usage\n\nAn example can be found in the [`examples`](./examples/) directory.\n\n```shell\nexport SPW_HOST=\"<hostname or IP>\"\nexport SPW_PORT=\"<port number>\"\nhatch run examples:spw_core_demo\n```\n\n## License\n\n`spektralwerk_scpi_client` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Spektralwerk SCPI communication library",
    "version": "0.2.4",
    "project_urls": null,
    "split_keywords": [
        "scpi",
        " spektralwerk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e990dbe7c0526d59d429677a0a4e9b896984cf5e0a386fad0a47a62da1e2d85d",
                "md5": "67769dc74a15d4538b124f318fa884ce",
                "sha256": "ea4fcdca09c54dd87814b4b7b3715c4c651d21ea348db186819fbbd670203f03"
            },
            "downloads": -1,
            "filename": "spektralwerk_scpi_client-0.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "67769dc74a15d4538b124f318fa884ce",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8082,
            "upload_time": "2025-08-05T12:52:45",
            "upload_time_iso_8601": "2025-08-05T12:52:45.142178Z",
            "url": "https://files.pythonhosted.org/packages/e9/90/dbe7c0526d59d429677a0a4e9b896984cf5e0a386fad0a47a62da1e2d85d/spektralwerk_scpi_client-0.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7278b84efbff4f437cb160d46aeaa64b8dfdf005b3b9cc028a24c39aa24c56f2",
                "md5": "1312ceee87ccb7cf65ae28fae85aff1f",
                "sha256": "664c8e7b83e1e5092f25b4f3f63f949f791562fca7c8098bf4f72c9073720d5d"
            },
            "downloads": -1,
            "filename": "spektralwerk_scpi_client-0.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "1312ceee87ccb7cf65ae28fae85aff1f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6113,
            "upload_time": "2025-08-05T12:52:46",
            "upload_time_iso_8601": "2025-08-05T12:52:46.214751Z",
            "url": "https://files.pythonhosted.org/packages/72/78/b84efbff4f437cb160d46aeaa64b8dfdf005b3b9cc028a24c39aa24c56f2/spektralwerk_scpi_client-0.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-05 12:52:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "spektralwerk-scpi-client"
}
        
Elapsed time: 0.89244s