Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions _plugins/WaveshareUPS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
layout: plugin

id: WaveshareUPS
title: OctoPrint-WaveshareUPS
description: An OctoPrint plugin to support the Waveshare UPS HAT
authors:
- Michael Szubartowicz
license: MIT

date: 2025-04-01

homepage: https://github.com/michaelszubartowicz/OctoPrint-WaveshareUPS
source: https://github.com/michaelszubartowicz/OctoPrint-WaveshareUPS
archive: https://github.com/michaelszubartowicz/OctoPrint-WaveshareUPS/archive/main.zip

follow_dependency_links: false

tags:
- UPS
- octopi
- Raspberry
- Pi
- battery

# TODO
# When registering a plugin on plugins.octoprint.org, all screenshots should be uploaded not linked from external sites.
screenshots:
- url: /assets/img/plugins/WavershareUPS/Screenshot_1.png
alt: Screenshot of the plugin interface
caption: Navbar icon including tooltip showing battery status
- url: /assets/img/plugins/WavershareUPS/Screenshot_2.png
alt: Screenshot of the plugin interface
caption: Navbar icon showing UPS is powered


featuredimage: /assets/img/plugins/WavershareUPS/featured.jpeg


compatibility:
octoprint:
- 1.4.0

os:
- linux
- windows
- macos
- freebsd

python: ">=3,<4"

# If any of the below attributes apply to your project, uncomment the corresponding lines. This is MANDATORY!

attributes:
# - cloud # if your plugin requires access to a cloud to function
# - commercial # if your plugin has a commercial aspect to it
# - free-tier # if your plugin has a free tier

---

An OctoPrint plugin to support the Waveshare UPS HAT, providing real-time monitoring of battery status and power supply. The plugin displays the battery percentage, power supply status, and estimated remaining runtime. It also sends notifications when the battery is critically low.

### Configuration
1. Install the plugin via the OctoPrint plugin manager.
2. Connect the Waveshare UPS HAT to your Raspberry Pi.
3. Ensure the I2C Interface is enabled (see also https://www.waveshare.com/wiki/UPS_HAT)

### Features
- Real-time battery status monitoring
- Power supply status indication
- Estimated remaining runtime calculation
- Low battery notifications
Binary file added assets/img/plugins/WaveshareUPS/Screenshot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/plugins/WaveshareUPS/Screenshot_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/plugins/WaveshareUPS/featured.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.