Skip to content

Latest commit

 

History

History
90 lines (69 loc) · 4.11 KB

README.md

File metadata and controls

90 lines (69 loc) · 4.11 KB


Shed Shield
Shed Shield

A handy little utility to shutdown your PC before loadingshedding hits. Built with Electron.



🛡️Shed Shield

Shed Shield uses the EskomSePush API along with Nominatum to look up your zone and adds a cron job to shutdown your PC before loadshedding cuts the power.

🔧 Key Features

  • Shed Shield uses geolocation to find your closest zone
  • Shed Shield can monitor multiple zones
  • Shed Shield uses the most immediate loadshedding timeslot to schedule a shutdown
  • Shed Shield can be configured to shutdown at specified intervals before loadshedding

⌨️ First time setup

1. EskomSePush API

a. Before running Shed Shield, navigate to EskomSePush API Subscription and subscribe to the free tier
Shed Shield
b. Complete your details
Shed Shield
c. Use the provided API key when setting up Shed Shield

2. Shed Shield

When running Shed Shield for the first time, you first have to setup your API Key and then your zones.
a. Run Shed Shield
Shed Shield
b. Follow the instructions and go to the Settings tab
Shed Shield
c. Enter the API Key from Step 1 into the input field
d. Click the Save Settings button
e. Search for your street address or nearest location using the Address lookup
Shed Shield
f. Click SEARCH FOR YOUR ZONE to search for your closest Zone
NB! Don't search for too many zones, this request uses 5 units of your API quota with EskomSePush!
g. Select the zones you want to monitor, the interval and be sure to check Launch at startup to have worry free shutdowns
Shed Shield
h. And that's all there is too it
Shed Shield

You can also see at what time the app will shutdown in the system tray
Shed Shield

Be sure to keep the app running in order to schedule the shutdowns. It will minimize to the system tray


💾 Download

You can download the Shed Shield installer for Windows. (macOS & Linux are WIP)

🦾 Contributing

Shed Shield is an open-source project. We appreciate the community's involvement and feedback. Please refer to our contribution guide for more information.

🙏Support

ko-fi

📜 License

Shed Shield is free and open-source software licensed under the GNU General Public License v3.0.