Skip to main content

Pioreactor OLED Status Display Plugin

Show Pioreactor status on a 128x64 monochrome OLED display.

This is a long-running Pioreactor plugin job named oled_status_display. It subscribes to local Pioreactor MQTT topics and renders a compact terminal-style dashboard with:

  • unit name and horizontally scrolling IP address
  • OD filtered
  • growth rate
  • temperature
  • measured RPM
  • transient warning and error banners

The display supports SSD1306 128x64 I2C OLEDs by default. The code can also use adafruit_sh1106 if that driver module is installed separately; by default, the plugin tries SSD1306 first, then SH1106.

Install From Source

pio plugins install oled_status_display --source .

The plugin includes a post_install.sh hook that starts and enables the startup service:

sudo systemctl enable pioreactor_startup_run@oled_status_display.service

It also includes a pre_uninstall.sh hook that stops and disables the same service.

Configuration

The following defaults are installed into Pioreactor configuration:

[oled_status_display.config]
refresh_interval_seconds=2
banner_seconds=5
driver=auto
i2c_address=0x3C
rotation=2
metrics=od_filtered,growth_rate,temperature,measured_rpm

Set driver to ssd1306, sh1106, or auto. Set i2c_address to the detected display address, commonly 0x3C or 0x3D. Set rotation to 0, 1, 2, or 3.

Set metrics to a comma-separated list of exactly four metric ids. These names match the corresponding Pioreactor core MQTT attributes:

  • od_filtered
  • ods
  • od_fused
  • growth_rate
  • temperature
  • target_temperature
  • measured_rpm
  • target_rpm
  • volume_change
  • current_volume_ml

Run Manually

pio run oled_status_display

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file pioreactor_oled_status_display_plugin-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pioreactor_oled_status_display_plugin-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 541c8099932736864934711e8a4dca44bae58b64d11db4d1d7192bafe29bb9f8
MD5 315f397804f99b0ee8ef7fe02de4c93e
BLAKE2b-256 193990316dbf316584c0f9ddd961b8f4e1dbc994479ccdb3312e07b9e7fc4b5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page