-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from SirUli/main
Move README to Markdown
- Loading branch information
Showing
2 changed files
with
32 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |