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=0x3D
rotation=0
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

Metadata

Release files for pioreactor-oled-status-display-plugin 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for pioreactor-oled-status-display-plugin 0.2.2
File Interpreter ABI Platform Actions
pioreactor_oled_status_display_plugin-0.2.2-py3-none-any.whl Python 3 none any Details for pioreactor_oled_status_display_plugin-0.2.2-py3-none-any.whl

Release files / pioreactor_oled_status_display_plugin-0.2.2-py3-none-any.whl

Download URL pioreactor_oled_status_display_plugin-0.2.2-py3-none-any.whl
Size 60.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7cce1c13ad8d0dfdfac37c0dc762d24d5d8661b5439d29ec04b35372c5215d91
BLAKE2b-256 checksum
How to use checksums
d998826e39c6e4115b170d50083c7fbdc80137473218a716b33bcb8affdb00a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.11

Security for pioreactor-oled-status-display-plugin 0.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page