Metadata-Version: 2.4
Name: kvaser-cl-api
Version: 0.2.1
Summary: Python bindings for Kvaser's CL API
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# Kvaser CL API

These are the Python bindings for Kvaser's CL API, used for configuring
and controlling the Arcus Media Converter. For more information about
Kvaser please go to [https://www.kvaser.com/](https://www.kvaser.com/).

## Supported platforms

kvaser-cl-api is available as a module for Python v3.8+ on Windows x86_64 and Linux x86_64.

The module has no external dependencies.

## Installation

### Pip

```bash
pip install kvaser-cl-api
```

### uv

```bash
uv add kvaser-cl-api
```

## Usage

Example of using kvaser-cl-api to list some device information for any
connected devices:

```python
import kvaser_cl_api as cl

c = cl.create_client()
devices = c.scan_for_devices()
for d in devices:
    sn = d.get_serial_number()
    name = d.get_name()
    print(f'- [{sn:06}]: {name}')

    for i in d.get_interfaces():
        status = i.get_status()
        link_state = status.eth_interface_status.link_state
        type_ = status.interface_type
        print(f'   {type_}: {link_state}')
```

Yielding something along the lines of:

```bash
- [000003]: Arcus 100/1000BASE-T1 H-MTD
   InterfaceType.T1: EthLinkState.Up
   InterfaceType.T: EthLinkState.Up
- [010007]: Arcus 100/1000BASE-T1 H-MTD
   InterfaceType.T1: EthLinkState.Up
   InterfaceType.T: EthLinkState.Up
```

You can read the API documentation by typing `help(kvaser_cl_api)` into a Python interpreter.

## Support

You are invited to visit the Kvaser web pages at [https://www.kvaser.com/support/](https://www.kvaser.com/support/). If you don't find what you are looking for, you can obtain support on a time-available basis by sending an e-mail to [support@kvaser.com](mailto:support@kvaser.com).

