Metadata-Version: 2.4
Name: jumpstarter-driver-can
Version: 0.6.0
Project-URL: Homepage, https://jumpstarter.dev
Project-URL: source_archive, https://github.com/jumpstarter-dev/repo/archive/c2927a2abac82d224c7bd28f9ed83c57b5222e65.zip
Author-email: Miguel Angel Ajo Pelayo <majopela@redhat.com>, Nick Cao <ncao@redhat.com>, Kirk Brauer <kbrauer@hatci.com>
License-Expression: Apache-2.0
Requires-Python: >=3.11
Requires-Dist: can-isotp>=2.0.6
Requires-Dist: jumpstarter
Requires-Dist: python-can>=4.5.0
Description-Content-Type: text/markdown

# CAN driver

`jumpstarter-driver-can` provides functionality for interacting with CAN bus
connections.

## Installation

```shell
pip3 install --extra-index-url https://pkg.jumpstarter.dev/simple/ jumpstarter-driver-can
```

## Configuration

Example configuration:

```yaml
export:
  can:
    type: jumpstarter_driver_can.Can
    config:
      # Add required config parameters here
```

## API Reference

```{eval-rst}
.. autoclass:: jumpstarter_driver_can.client.CanClient()
    :members:
```

```{eval-rst}
.. autoclass:: jumpstarter_driver_can.client.IsoTpClient()
    :members:
```
