mirror of
https://github.com/akuker/RASCSI.git
synced 2024-06-20 07:29:30 +00:00
52c2aa474f
* Rebrand project to PiSCSI - rascsi ->piscsi - rasctl -> scsictl - rasdump -> scsidump - ras* -> piscsi* (rasutil -> piscsi_util, etc.) * Refined the formatting and wording of the app startup banner * Kept some references to rascsi and rasctl where backwards compatibility is concerned * Point to the new github repo URL Co-authored-by: nucleogenic <nr@nucleogenic.com> Co-authored-by: Uwe Seimet <Uwe.Seimet@seimet.de>
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
# PiSCSI Control Board UI
|
|
|
|
## Run as standalone script for development / troubleshooting
|
|
|
|
```bash
|
|
# Make a virtual env named venv
|
|
$ python3 -m venv venv
|
|
# Use that virtual env in this shell
|
|
$ source venv/bin/activate
|
|
# Install requirements
|
|
$ pip3 install -r requirements.txt
|
|
$ python3 src/main.py
|
|
```
|
|
|
|
### Parameters
|
|
|
|
The script parameters can be shown with
|
|
```
|
|
python src/main.py --help
|
|
```
|
|
or
|
|
```
|
|
start.sh --help
|
|
```
|
|
|
|
Example:
|
|
```
|
|
$ python3 src/main.py --rotation=0 --transitions=0
|
|
```
|
|
|
|
## Run the start.sh script standalone
|
|
|
|
The start.sh script can also be run standalone, and will handle the venv creation/updating for you. It takes the same command line parameters in the following format:
|
|
|
|
```
|
|
$ ./start.sh --rotation=0 --transitions=0
|
|
```
|
|
### I2C baudrate and transitions
|
|
The available bandwidth for the display through I2C is limited. The I2C baudrate is automatically adjusted in
|
|
easy_install.sh and start.sh to maximize the possible baudrate, however, depending on the Raspberry Pi model in use, we found that for some
|
|
models enabling the transitions does not work very well. As a result, we have implemented a model detection for
|
|
the raspberry pi model and enable transitions only for the following pi models:
|
|
- Raspberry Pi 4 models
|
|
- Raspberry Pi 3 models
|
|
- Raspberry Pi Zero 2 models
|
|
|
|
The model detection can be overriden by adding a --transitions parameter to start.sh.
|
|
|
|
## Credits
|
|
|
|
### DejaVuSansMono-Bold.ttf
|
|
* Source: https://dejavu-fonts.github.io
|
|
* Distributed under DejaVu Fonts Lience (see DejaVu Fonts License.txt for full text)
|
|
|
|
### splash_start_\*.bmp, splash_stop_\*.bmp
|
|
* Drawn by Daniel Markstedt
|
|
* Distributed under BSD 3-Clause by permission from author (see LICENSE for full text)
|