Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move README to Markdown #3

Merged
merged 1 commit into from
Jan 4, 2023
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
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ShutdownMonitor

This software installs a possibility to perform a clean shutdown of the Venus OS via the
menu system.

## Usage

### dbus

The ShutdownMonitor runs as a service and creates a dbus service with a single
parameter: ``/Shutdown``. Setting ``/Shutdown`` to ``1`` will trigger a clean OS shutdown.

### Menu

A shutdown submenu is added to the *Settings* / *General* menu. A submenu is used to alert
the user that a power cycle is needed to restart the GX device.

**Note**: A Cerbo GX restarts itself after a shutdown so this addition may not be useful
in all situations.

### Raspberry GPIO

For Raspberry PI platforms, pulling GPIO #16 (pin 36 on the pin header) low for 2 seconds
will also trigger a shutdown if enabled in the Shutdown menu. This requires
[RpiGpioSetup](https://github.com/kwindrem/RpiGpioSetup) with Version v3.4 or later to
activate the GPIO pin.

## Setup

The easiest way to install this or other of my packages is to first install
[SetupHelper](https://github.com/kwindrem/SetupHelper), then use its package install tool.
Refer to the SetupHelper ReadMe for instructions.
20 changes: 0 additions & 20 deletions ReadMe

This file was deleted.