Skip to main content

Python library for piezosystem NV200 device

Project description

nv200

Python library for piezosystem NV200 device control

TestPyPI Python Version Docs


📦 Installation

Install from TestPyPI:

pip install --index-url https://test.pypi.org/simple/ nv200

If your project depends on packages from the main PyPI index as well, add:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple nv200

🚀 Quick Start

from nv200.device_types import DetectedDevice
from nv200.device_discovery import discover_devices
from nv200.device_interface import DeviceClient, create_device_client

async def main_async():
    print("Discovering devices...")
    detected_devices = await discover_devices()
    
    if not detected_devices:
        print("No devices found.")
        return

    # Create a device client for the first detected device
    device = create_device_client(detected_devices[0])
    await client.connect()

if __name__ == "__main__":
        asyncio.run(main_async())

For more advanced usage and async control, see the full API documentation.


📚 Documentation

📖 Full documentation is available at
👉 https://nv200-python-lib-e9158a.gitlab.io/

It includes:

  • Setup & Installation
  • Device Communication Protocols
  • Full API Reference
  • Examples and Tutorials

🛠 Features

  • ✅ Asynchronous communication via aioserial and telnetlib3
  • ✅ Simple Pythonic interface for device control
  • ✅ Query & set device position
  • ✅ Supports NV200 data recorder functionality
  • ✅ Easy interface for NV200 waveform generator

📁 Examples

See the examples/ folder in the repository for:

  • Basic device connection
  • Position control scripts
  • Integration with GUI frameworks (via PySide6)

🧪 Development & Testing

Git Repository

The Git repository is available at: https://gitlab.com/gitlabuser0xFFFF/nv200_python_lib

Install dependencies

poetry install

Run tests

poetry run pytest

Build documentation locally

poetry run build-doc
open doc/_build/index.html

🤝 Contributing

Contributions are welcome! If you encounter bugs or have suggestions:

  • Open an issue
  • Submit a pull request
  • Or contact us directly

For major changes, please open a discussion first.


📜 License

This project is licensed under the MIT License.
See the LICENSE file for details.


👤 Authors

piezosystemjena GmbH
Visit us at https://www.piezosystem.com


🔗 Related

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

nv200-0.2.1.dev58.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

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

nv200-0.2.1.dev58-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

Details for the file nv200-0.2.1.dev58.tar.gz.

File metadata

  • Download URL: nv200-0.2.1.dev58.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.9 Windows/11

File hashes

Hashes for nv200-0.2.1.dev58.tar.gz
Algorithm Hash digest
SHA256 b8145b4f2495cb88b6da560c913b1f6a5179a490ba8ef024fd860e0e8c48bcf2
MD5 bbd92f081f38d84c7ece0de688b189f1
BLAKE2b-256 f7812e6a82960bc277b4e64d099435a6b6d9bf94ad8c3c3cb844d2834da59f12

See more details on using hashes here.

File details

Details for the file nv200-0.2.1.dev58-py3-none-any.whl.

File metadata

  • Download URL: nv200-0.2.1.dev58-py3-none-any.whl
  • Upload date:
  • Size: 29.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.9 Windows/11

File hashes

Hashes for nv200-0.2.1.dev58-py3-none-any.whl
Algorithm Hash digest
SHA256 6b80cb193a9d6e23ed24a57148d64f0aed93fd32dd0e7b1d84d38041db6d9486
MD5 59fcdd0874138eab2c8293b5f7be5bb6
BLAKE2b-256 20c2413ace6fb9ef48f168e0d4204907aaf5f92aa9d10af18c2863ce64736c64

See more details on using hashes here.

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