https://github.com/waveform80/pemmican

Notify users of Raspberry Pi 5 power issues
https://github.com/waveform80/pemmican

dbus notify pmic power raspberry-pi

Last synced: about 1 month ago
JSON representation

Notify users of Raspberry Pi 5 power issues

• Host: GitHub
• URL: https://github.com/waveform80/pemmican
• Owner: waveform80
• License: other
• Created: 2024-02-19T01:20:25.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-08T13:30:52.000Z (9 months ago)
• Last Synced: 2024-10-09T12:36:27.596Z (about 1 month ago)
• Topics: dbus, notify, pmic, power, raspberry-pi
• Language: Python
• Homepage: https://pemmican.readthedocs.io/
• Size: 129 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
========

Pemmican

========

Pemmican is a small utility which warns users of power supply issues on the

Raspberry Pi 5 platform. It provides a command line utility, intended for use

from the `update-motd`_ facility for non-graphical platforms, and two

GLib-based applications for use on graphical platforms, which expect to talk to

a DBus service implementing the freedesktop `notifications specification`_:

* ``pemmican-cli`` -- the command line utility

* ``pemmican-reset`` -- the one-shot notification service which warns of

  brownout reset issues, and failure to negotiate a 5A feed

* ``pemmican-mon`` -- the persistent notification service which warns of active

  undervolt or USB overcurrent events

Usage

=====

End users should never need to run these directly; distro packaging should

integrate these applications into the platform as appropriate (an MOTD plugin

for the command line application, and systemd user services activated by

``graphical-session.target`` for the graphical applications).

What's in a Name?

=================

This project started life as PMICmon (for `Power Management IC`_ monitor), but

I kept mis-pronouncing it as as `pemmican`_!

Useful Links

============

* `Source code`_ on GitHub

* `Issues`_ on GitHub

* `Documentation`_ on ReadTheDocs

.. _update-motd: https://manpages.ubuntu.com/manpages/noble/en/man5/update-motd.5.html

.. _notifications specification: https://specifications.freedesktop.org/notification-spec/latest/

.. _Power Management IC: https://en.wikipedia.org/wiki/Power_management_integrated_circuit

.. _pemmican: https://en.wikipedia.org/wiki/Pemmican

.. _Source code: https://github.com/waveform80/pemmican

.. _Issues: https://github.com/waveform80/pemmican/issues

.. _Documentation: https://pemmican.readthedocs.io/