73 lines
1.3 KiB
Markdown
73 lines
1.3 KiB
Markdown
# Installation Guide for PyFT5xx6
|
|
|
|
This document provides instructions for installing the PyFT5xx6 package.
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.6 or higher
|
|
- pip (Python package installer)
|
|
- For Raspberry Pi usage: Enabled I2C interface
|
|
|
|
## Installation Methods
|
|
|
|
### From PyPI (once published)
|
|
|
|
```bash
|
|
pip install pyft5xx6
|
|
```
|
|
|
|
### From Source
|
|
|
|
1. Clone the repository or download the source code:
|
|
```bash
|
|
git clone https://gitea.tourolle.paris/dtourolle/PyFTtxx6
|
|
cd PyFTtxx6
|
|
```
|
|
|
|
2. Install using pip:
|
|
```bash
|
|
pip install ./pyft5xx6
|
|
```
|
|
|
|
Or for development installation:
|
|
```bash
|
|
pip install -e ./pyft5xx6
|
|
```
|
|
|
|
### Building from Source
|
|
|
|
1. Build the package:
|
|
```bash
|
|
cd pyft5xx6
|
|
python -m build
|
|
```
|
|
|
|
2. Install the built package:
|
|
```bash
|
|
pip install dist/pyft5xx6-0.1.0-py3-none-any.whl
|
|
```
|
|
|
|
## Verifying Installation
|
|
|
|
After installation, you can verify that the package is installed correctly:
|
|
|
|
```python
|
|
import pyft5xx6
|
|
print(pyft5xx6.__version__)
|
|
```
|
|
|
|
## Enabling I2C on Raspberry Pi
|
|
|
|
If you're using a Raspberry Pi, you need to enable the I2C interface:
|
|
|
|
1. Run `sudo raspi-config`
|
|
2. Navigate to "Interfacing Options" > "I2C"
|
|
3. Select "Yes" to enable I2C
|
|
4. Reboot your Raspberry Pi: `sudo reboot`
|
|
|
|
## Dependencies
|
|
|
|
The package automatically installs the following dependencies:
|
|
- smbus2
|
|
- RPi.GPIO (only on Linux platforms)
|