Metadata-Version: 2.4
Name: xibif_connection
Version: 0.1.5
Summary: API library to interface with a XiBIF FPGA board.
Author-email: Janik Witzig <janik.witzig@ost.ch>
Project-URL: Homepage, https://xibif.ch
Project-URL: Repository, https://gitlab.com/xibif/xibif-connection
Project-URL: Issues, https://gitlab.com/xibif/xibif-connection/-/issues
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pydantic
Requires-Dist: rich
Dynamic: license-file

# XiBIF Connection

The XiBIF Connection package is an API that allows to interface with a XiBIF board.

## Installation
The XiBIF Connection package is installed via pip:
```bash
pip install xibif-connection --index-url https://gitlab.ost.ch/api/v4/groups/12907/-/packages/pypi/simple
```
## Features

The XiBIF Connection package offers a set of API functions to ease interfacing with the FPGA, such as:
- read and write registers
- read and write from/to the AXI-Stream
- benchmarking functions
- interactive shell

## Usage
The main API object is `XibifConnection`.
```python
from xibif_connection.api import XibifConnection

board = XibifConnection("192.168.1.10", 0xDEAD_CAFE)
board.connect()
print(connection.read(0))
connection.write(0, 10)
```
