NAME

piscsi-oled — display PiSCSI status on an SSD1306 I2C OLED panel

SYNOPSIS

DESCRIPTION

piscsi-oled polls a PiSCSI daemon and presents its current status on a 128-by-32 or 128-by-64 SSD1306 OLED display connected through I2C. It shows startup and shutdown splash screens, rotates long status lines, and can activate an optional screensaver after status has been unchanged for a period of time.

The default display is a 128-by-32 panel at address 0x3c on /dev/i2c-1, rotated 180 degrees. The default daemon is “localhost” on port 6868.

OPTIONS

-diagnostic

Show the startup and shutdown splashes, clear the display, and exit without contacting the PiSCSI daemon.

-height 32|64

Display height in pixels. The default is 32.

-host HOST

PiSCSI daemon hostname. The default is “localhost”.

-horizontal_scroll_step PIXELS

Pixels by which long lines move after each refresh. Specify 0 to pause horizontal scrolling. The default is 6.

-i2c-address ADDRESS

SSD1306 I2C address, expressed as an integer accepted by Go, such as “0x3c”.

-i2c-device DEVICE

Linux I2C device. The default is /dev/i2c-1.

-password TOKEN

PiSCSI daemon authentication token.

-port PORT

PiSCSI daemon port. The default is 6868.

-refresh_interval MILLISECONDS

Screen refresh interval in milliseconds. 0 uses the minimum interval of one millisecond. The default is 1000.

-rotation 0|180

Screen rotation in degrees. The default is 180.

-screensaver off|ip|blank

Screensaver mode. “ip” keeps the network-status line visible and moves it periodically; “blank” clears the display; “off” disables the screensaver. The default is “off”.

-screensaver-idle-timeout DURATION

Time for which the status must remain unchanged before the screensaver starts. The default is 5m.

-screensaver-move-interval DURATION

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

-v

Print PiSCSI version and copyright information, then exit.

Duration options accept Go duration strings, for example 30s, 5m, and 1h.

EXAMPLES

Use a 128-by-64 display rotated 180 degrees:

piscsi-oled -height=64 -rotation=180

Enable the IP screensaver after five minutes of inactivity:

piscsi-oled -screensaver=ip -screensaver-idle-timeout=5m

HARDWARE

Enable I2C before using the program and ensure that the service account can access the selected I2C device. On Raspberry Pi OS, the display is usually available at /dev/i2c-1. Use i2cdetect(8) to identify its address.

SIGNALS

piscsi-oled handles SIGINT and SIGTERM. It displays the shutdown splash, clears the OLED panel, and exits.

SEE ALSO

piscsi(1), i2cdetect(8)

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