Metadata-Version: 2.4
Name: pmk-probes
Version: 1.0.18
Summary: A Python package to control PMK's active oscilloscope probes.
Project-URL: Homepage, http://www.pmk.de/
Project-URL: Documentation, https://pmk-probes.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/PMK-Probing-Solutions/pmk-probes
Author-email: Felix Wenk <felix.wenk@pmk.de>
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: crccheck>=1.3
Requires-Dist: pyserial>=3.5
Description-Content-Type: text/markdown

# PMK Probes [![Documentation Status](https://readthedocs.org/projects/pmk-probes/badge/?version=latest)](https://pmk-probes.readthedocs.io/en/latest/?badge=latest) ![PyPI - Version](https://img.shields.io/pypi/v/pmk-probes)


pmk-probes is the official Python package to control active oscilloscope probes by [PMK](http://www.pmk.de/).

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pmk-probes.

```bash
pip install pmk-probes
```

## Requirements

- Python 3.10 or higher
- pyserial

## Usage

```python
from pmk_probes.probes import BumbleBee2kV
from pmk_probes.power_supplies import PS03, Channel

ps = PS03('<YOUR_COM_PORT>')  # replace with the COM port of your power supply or specify ip_address parameter 
bumblebee1 = BumbleBee2kV(ps, Channel.CH1)  # use the BumbleBee probe on channel 1
print(bumblebee1.metadata.serial_number)  # print the serial number of the probe
bumblebee1.attenuation = 500  # set the attenuation to 500x
```

## Documentation

The documentation is available at [https://pmk-probes.readthedocs.io](https://pmk-probes.readthedocs.io).

## License

[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)