Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arxari/openshockclock

TUI to set an alarm clock which uses electricity (OpenShock) to wake you up
https://github.com/arxari/openshockclock

alarm alarm-clock electrostim estim openshock python-script

Last synced: about 1 month ago
JSON representation

TUI to set an alarm clock which uses electricity (OpenShock) to wake you up

Awesome Lists containing this project

README 

        
### How to use

#### Linux

- Make sure you have python installed, you can do this on Ubuntu/Debian/Mint by doing ```sudo apt-get install python3 python3-pip``` or on Fedora by doing ```sudo dnf install python3 python3-pip``` or Arch ```sudo pacman -Sy python python-pip```

- After you've made sure you have python installed

- ‎ 

- Go to the releases page

- Download the source code .zip from the latest release [here](https://github.com/Arxari/OpenShockClock/releases/latest)

- After it's downloaded unzip it

- Copy the location of run.sh (you can do this in GNOME files by pressing ctrl + c and in KDE Dolphin by pressing ctrl +  alt + c)

- Open your terminal and type ```chmod +x``` and after it paste the location of your run.sh (if you downloaded the zip to your Downloads folder it should be ```/home/yourusername/Downloads/OpenShockClock-versionnunber/run.sh```)

- After that paste your run.sh location again and hit enter

- Go trough the text promps

- And you're good to go :D

- To use the script again simply paste the run.sh location into your terminal and hit enter

#### Windows (use version  [v0.8.4 - Ronalds](https://github.com/Arxari/OpenShockClock/releases/tag/v0.8.4))

- Make sure you have python installed, you can do this by going to the Microsoft Store and downloading Python **3.11**

- Also install Git, you can do so from [here](https://git-scm.com/download/win), download the .exe and go trough the install process

- After you've made sure you have python and git installed

- ‎ 

- Go to the releases page

- Download the source code .zip

- After it's downloaded unzip it

- Go into the unzipped folder

- Double click run.sh

- If it opens in the wrong app, right click it and choose Open In --> Git for Windows

- Ta-da!

- To run it again just run the run.sh file again

- ‎

- When run.sh updates the program, the window will close so you have to re-run it again to use the updated version

- ‎

- Sometimes it might take upto 30 seconds to load the alarms, sadly there is not much I can do for that, so just don't panic and let it load

#### MacOS

- Make sure you have python installed, you can install it from [here](https://www.python.org/downloads/macos), make sure to select pytyon 3.11.9

- After you've made sure you have python installed

- ‎ 

- Go to the releases page

- Download the source code .zip from the latest release [here](https://github.com/Arxari/OpenShockClock/releases/latest)

- After it's downloaded go into Finder and unzip it

- Open the unzipped folder

- Copy the location of run.sh

- Open your terminal and write ```chmod +x``` and paste your run.sh location

-Paste your run.sh and press enter to run the program

- Follow the text prompts in your terminal and you should be good to go :D

  

### Planned Features / Roadmap

- [ ] Release prebult binaries for Windows (.bat or .exe), MacOS (idk) and Linux (AUR)

- [ ] Port to mobile as a GUI app

- [ ] Create a GUI for desktop platforms



- [x] Add ability for multiple alarms

- [ ] ~~Add ability to disable ringtone and add support for custom ringtones~~



Massive thank you to [DexFolf](https://github.com/DexFolf) and their [OpenShock Telegram Bot](https://github.com/DexFolf/OpenShockTelegramBot).