|
| 1 | +--- |
| 2 | +layout: plugin |
| 3 | + |
| 4 | +id: WaveshareUPS |
| 5 | +title: OctoPrint-WaveshareUPS |
| 6 | +description: An OctoPrint plugin to support the Waveshare UPS HAT |
| 7 | +authors: |
| 8 | +- Michael Szubartowicz |
| 9 | +license: MIT |
| 10 | + |
| 11 | +date: 2025-04-01 |
| 12 | + |
| 13 | +homepage: https://github.com/michaelszubartowicz/OctoPrint-WaveshareUPS |
| 14 | +source: https://github.com/michaelszubartowicz/OctoPrint-WaveshareUPS |
| 15 | +archive: https://github.com/michaelszubartowicz/OctoPrint-WaveshareUPS/archive/main.zip |
| 16 | + |
| 17 | +follow_dependency_links: false |
| 18 | + |
| 19 | +tags: |
| 20 | +- UPS |
| 21 | +- octopi |
| 22 | +- Raspberry |
| 23 | +- Pi |
| 24 | +- battery |
| 25 | + |
| 26 | +# TODO |
| 27 | +# When registering a plugin on plugins.octoprint.org, all screenshots should be uploaded not linked from external sites. |
| 28 | +screenshots: |
| 29 | +- url: /assets/img/plugins/WavershareUPS/Screenshot_1.png |
| 30 | + alt: Screenshot of the plugin interface |
| 31 | + caption: Navbar icon including tooltip showing battery status |
| 32 | +- url: /assets/img/plugins/WavershareUPS/Screenshot_2.png |
| 33 | + alt: Screenshot of the plugin interface |
| 34 | + caption: Navbar icon showing UPS is powered |
| 35 | + |
| 36 | + |
| 37 | +featuredimage: /assets/img/plugins/WavershareUPS/featured.jpeg |
| 38 | + |
| 39 | + |
| 40 | +compatibility: |
| 41 | + octoprint: |
| 42 | + - 1.4.0 |
| 43 | + |
| 44 | + os: |
| 45 | + - linux |
| 46 | + - windows |
| 47 | + - macos |
| 48 | + - freebsd |
| 49 | + |
| 50 | + python: ">=3,<4" |
| 51 | + |
| 52 | +# If any of the below attributes apply to your project, uncomment the corresponding lines. This is MANDATORY! |
| 53 | + |
| 54 | +attributes: |
| 55 | +# - cloud # if your plugin requires access to a cloud to function |
| 56 | +# - commercial # if your plugin has a commercial aspect to it |
| 57 | +# - free-tier # if your plugin has a free tier |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +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. |
| 62 | + |
| 63 | +### Configuration |
| 64 | +1. Install the plugin via the OctoPrint plugin manager. |
| 65 | +2. Connect the Waveshare UPS HAT to your Raspberry Pi. |
| 66 | +3. Ensure the I2C Interface is enabled (see also https://www.waveshare.com/wiki/UPS_HAT) |
| 67 | + |
| 68 | +### Features |
| 69 | +- Real-time battery status monitoring |
| 70 | +- Power supply status indication |
| 71 | +- Estimated remaining runtime calculation |
| 72 | +- Low battery notifications |
0 commit comments