NAME

piscsi-ctrlboard — operate PiSCSI with the PiSCSI Control Board

SYNOPSIS

DESCRIPTION

piscsi-ctrlboard is the client for the PiSCSI Control Board. It receives rotary-encoder and button events through a PCA9554 I2C expander, renders a menu on a 128-by-64 SSD1306 display, and sends commands to a PiSCSI daemon. The menu supports SCSI-ID management, image attach and eject operations, profiles, and system actions.

By default, the Control Board uses /dev/i2c-1, PCA9554 address 0x3f, SSD1306 address 0x3c, and BCM GPIO line 9 for the PCA9554 interrupt. It connects to the local PiSCSI daemon on port 6868.

OPTIONS

-button-debounce DURATION

Button debounce interval. The default is 200ms.

-button-cycle-timeout DURATION

Inactivity timeout before an auxiliary-button choice runs. The default is 3s.

-config-dir DIRECTORY

PiSCSI profile directory. The default is /var/lib/piscsi/config.

-diagnostic

Log Control Board input snapshots, decoded events, dropped events, and latency statistics.

-display true|false

Render the Control Board menu on the SSD1306 display. When false, the PCA9554 and GPIO interrupt are still required. The default is true.

-display-address ADDRESS

SSD1306 I2C address. The default is 0x3c.

-event-queue-size SIZE

Maximum number of hardware events waiting to be processed. The default is 64.

-gpiochip DEVICE

Linux GPIO character device. The default is /dev/gpiochip0.

-host HOST

PiSCSI daemon hostname. The default is “localhost”.

-i2c-device DEVICE

Linux I2C device used by the Control Board. The default is /dev/i2c-1.

-image-dir DIRECTORY

Image directory used while loading profiles. The default is /var/lib/piscsi/images.

-interrupt-gpio LINE

BCM GPIO line connected to the PCA9554 interrupt. The default is 9.

-pca-address ADDRESS

PCA9554 I2C address. The default is 0x3f.

-password TOKEN

PiSCSI daemon authentication token.

-port PORT

PiSCSI daemon port. The default is 6868.

-refresh-interval DURATION

Interval used to refresh the PiSCSI root menu. The default is 10s.

-rotation 0|180

Menu display rotation in degrees. The default is 0.

-screensaver-move-interval DURATION

Interval between moves of the IP screensaver line. The default is 30s.

-screensaver-timeout DURATION

Idle timeout before the IP screensaver starts. Specify 0 to disable it. The default is 10m.

-shutdown-splash-duration DURATION

Duration for which the shutdown splash is displayed. Specify 0 to disable the delay. The default is 700ms.

-splash-duration DURATION

Duration for which the startup splash is displayed. Specify 0 to disable the delay. The default is 2s.

-transitions

Animate submenu navigation with horizontal push transitions.

-v

Print PiSCSI version and copyright information, then exit.

Duration options accept Go duration strings, for example 200ms, 3s, and 10m.

EXAMPLES

Run the client with an inverted display:

piscsi-ctrlboard -rotation=180

Use a remote PiSCSI daemon and enable input diagnostics:

piscsi-ctrlboard -host=piscsi.local -port=6868 -diagnostic

HARDWARE

Enable I2C and ensure the process can access both the selected I2C device and GPIO character device. Use i2cdetect(8) to verify the usual 0x3c display and 0x3f PCA9554 addresses.

SIGNALS

piscsi-ctrlboard handles SIGINT and SIGTERM and stops its input, display, and daemon work cleanly.

SEE ALSO

piscsi(1), piscsi-oled(1), i2cdetect(8)

Full documentation is available at: <https://www.piscsi.com>