Skip to content

Settings

foonerd edited this page Oct 16, 2026 · 8 revisions

Settings

The plugin's page is under Settings, Plugins, Installed Plugins, Just OLED. Four sections, in the order of how often they are touched: the face, standby, the connection, the messages. A save in any section reaches the display within a couple of seconds; only a bus change asks for a restart.

Face

What the display shows while music plays. Every face lays itself out for the panel it is on; the Screens page shows each on each panel class.

Setting Values What it does
While playing, show Spectrum and track (default); Stereo spectrum and track; Spectrum, left and right levels, and track; Left and right levels and track; Track only, larger; Spectrum only, full panel Spectrum folds both channels into one row of bars, the louder side winning. Stereo spectrum draws the left channel rising from the middle line and the right hanging from it, band under band. Spectrum with levels puts the left and right level bars beside the spectrum (under it on a narrow panel). Levels shows the two level bars alone, the RMS filled and the peak a mark. Track only gives the words the meter's room, the title in larger type. Spectrum only gives the spectrum the whole panel, with the progress line under it. The track is the rows the next setting chooses, the time row, the format and the icons as the panel allows, and a progress line at the foot.
Track text Title, then artist and album on one row (default); Title larger, artist and album on their own rows; Title only How many rows the track takes under the meter. The meter takes whatever the rows leave: fewer rows, and the time and format turned off below, make it taller. On a 128x128 panel the default meter is half as tall again as the full text leaves it; with the title alone and the time and format off it has four fifths of the panel. On a 64-row panel the meter sits beside the time and format in a column only as wide as they need, so a 256x64 shows 40 bars by default and 64 with the title alone.
Track time Played and total (1:23 / 3:20), default; Played (1:23); Remaining (-1:57); Off The time row. A radio stream has no length, so it shows the time played whatever the choice. Off gives the row to the meter.
Show the sample rate and bit depth on 44.1k 16b beside the volume wedge and the connection icon; a stream shows its bitrate instead. Off leaves the volume and the connection, which share the time's row, or the end of the title row when the time is off too; the meter takes what is freed.
Peak marks on the meters on A mark that holds above each bar for most of a second, then falls.
Meter gain (dB) -12 to +12, default 0 Lifts or lowers every meter. The tap reads the music before the volume control, so the meters show the recording's level, not the knob: a quiet classical master sits low at any volume, a loud master pins the bars. Give a quiet collection +6, hold a loud one at -6; 0 shows the recording as it is, over a 60 dB range.
Meter across the panel off On, the meter takes the panel's full width and at least its upper half, and the rows make do with the rest: the album, the artist, the artist · album row and the format text give way in that order, then the larger title and the gaps. On a 128x64 panel that is 32 bars over the time and the title, mpd_oled's own arrangement; on a 256x64, 64 bars. Off, the layout keeps every row the choices above ask for and gives the meter what is left, beside the time and format on a 64-row panel.
Colours Classic (default); Amber; Ice; Fire; White; Custom For a colour panel (SSD1331, SSD1351): the title, the detail rows, the bars, the bars' top, the peak marks and the progress line. Classic is white text, green bars with an amber top and a red peak; Amber the vintage display; Ice white and blue; Fire red bars with an orange top; White everything in white. Custom shows a colour picker for each of the six. The boot, ready, pause and farewell texts follow the theme. A monochrome or greyscale panel keeps its own levels whatever is chosen. The Screens page shows the five on a 128x128.

Standby

What the display shows while nothing plays, and when it goes dark.

Setting Values What it does
While stopped, show Time and date (default); Nothing: the display goes dark With the time and date, a strip (128x32) shows the time alone; taller panels show the address and the connection along the top, the time as large as the panel allows, the date beneath.
Display off after (minutes) 0 to 1440, default 30 Minutes of standby before the display switches off; 0 keeps the clock on. The display comes back the moment something plays.
Clock format 20:45 (default), 20:45:07, 08:45 pm, 8:45 pm, 08:45:07 pm The same choices as lcd1602-vumeter. The player's time zone (Settings, System).
Date format Tue 13 Oct (default), Tuesday 13 October, Tue 13 Oct 2026, 13.10.2026, 13/10/2026, 10/13/2026, 2026-10-13, Tue 13.10., Tuesday The names are English on the panel.
Show the player's address on The IP address in the corner of the standby screen, handy for reaching the player.

Connection

How the OLED is wired and which panel it is.

Setting Values What it does
Wiring I2C; I2C, custom; SPI, generic; SPI, Waveshare; SPI, custom How the module is wired, as the Wiring page shows. I2C is the header bus (GPIO 2 and 3) with the address found automatically. SPI, generic is the wiring of mpd_oled and the luma library: CE0, DC on GPIO 24, RST on GPIO 25. SPI, Waveshare is the wiring on Waveshare's module pages: CE0, DC on GPIO 25, RST on GPIO 27. The two custom choices show the fields below.
Panel one of the Displays entries The controller and pixel size. The list is the daemon's own catalogue, so it names exactly what the shipped binary drives; entries not yet verified on a module say (described).
I2C bus number 0 to 99, default 1 Custom I2C only. The N of /dev/i2c-N: 1 is the header bus, 0 the HAT EEPROM bus (enabled when you save), 3 or more a software bus on the two GPIOs below (written when you save); both take a restart.
SDA GPIO, SCL GPIO 0 to 27, default 2 and 3 Custom I2C only, for a software bus (bus number 3 or more).
I2C address Automatic, 0x3C, 0x3D Custom I2C only. Automatic tries 0x3C then 0x3D.
I2C bus speed 100 kHz (default); 400 kHz; 1 MHz I2C modules only. At the Pi's 100 kHz a 128x64 frame takes about 90 ms on the wire, so the meter moves at 10 frames a second; at 400 kHz, which the SSD1306, SSD1309 and SH1106 are specified for, it moves at the daemon's 25. 1 MHz is beyond their specification and works on many modules with short leads. Saving writes the clock into /boot/userconfig.txt for the hardware buses and asks for a restart; a software bus keeps its own pace. just-oled --probe prints each bus's clock.
SPI bus 0 to 9, default 0 Custom SPI only. The B of /dev/spidevB.C.
Chip select 0 to 2, default 0 Custom SPI only. The C of /dev/spidevB.C: 0 for CE0 (pin 24), 1 for CE1 (pin 26).
Data/command GPIO 0 to 27 Custom SPI only. BCM number wired to the module's DC pin.
Reset GPIO 0 to 27 Custom SPI only. BCM number wired to the module's RST pin.
Orientation Normal, Upside down Turns the picture for a module mounted the other way up.
Detect button Reads the I2C bus and says what answers. SPI panels cannot be read.
Test display button Draws the test picture for a few seconds: a frame, a square in the top-left corner, a diagonal, red-green-blue bars and a black-to-white ramp, so a wrong entry, orientation or colour order is seen at once (Troubleshooting reads it).

Messages

What the display says as the player boots, stands ready, pauses, restarts and shuts down. Each text is two lines separated by |.

Setting Default When it shows
Show boot and shutdown messages on Off, the display shows nothing until the player's state arrives, and clears at shutdown.
While booting Volumio|booting... From the service's start, before Volumio is up, until the plugin says ready.
When ready Volumio|ready For a few seconds once the plugin has started.
While paused Paused|waiting on music While the player is paused; off, the playing page stays with the bars at rest.
Shutting down Volumio|shutting down From the moment Volumio begins to shut down until power goes; the panel is then switched off.
Restarting Volumio|restarting From the moment Volumio begins to restart.

Where the settings live

/data/configuration/system_hardware/just_oled/config.json, in Volumio's store format. The daemon reads it at start and again when the page is saved. A setting the store does not have (a plugin updated from an earlier build) takes its default until that section is saved once.

Clone this wiki locally