Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 7.77 KB

README.md

File metadata and controls

109 lines (71 loc) · 7.77 KB

exhale

exhale

Introduction

Research indicates we blink less and breathe more shallowly when we are looking at screens. This minimal app is intended as a friendly indicator and reminder to continue to take full and deep breaths. As looking at screens for long periods of time is typically less than ideal, this tool is intended as a means to potentially ameliorate those negative impacts.

Each of these implementations allows users to set an inhale, inhale hold, exhale, and exhale hold duration, in seconds, to fit their needs. For beginners who might be curious what a good starting value might be for these, I recommend keeping it simple, using 4 for the in duration and 4 for the out duration. Eventually you can work your way up to 6 and 8, and set the out duration to be twice that of the in duration to facilitate activation of the parasympathetic nervous system. Some users might like to start out with box breathing, which is inhale 4, inhale hold 4, exhale 4, exhale hold 4. Remember, if intense feelings arise while practicing, taking a break is encouraged - it's important to not overdo it.

Disclaimer

The information and guidance provided by this breathing app are intended for general informational purposes only and should not be construed as medical advice, diagnosis, or treatment. The creator of this app is not a medical professional, and the app is not a substitute for professional medical advice or consultation with a qualified healthcare provider. Always seek the advice of a physician or other qualified healthcare provider with any questions you may have regarding a medical condition or health objectives. Do not disregard or delay seeking professional medical advice because of the information or suggestions provided by this app. In the event of a medical emergency, call your doctor or dial your local emergency number immediately. Use of this app is at your own risk, and the creator assumes no responsibility for any adverse effects or consequences resulting from its use.

Download

You can download the build for your respective operating system on the Releases page. Using the latest release is recommended, but if you run into issues you could try a previous release to see if that yields better results. If you do encounter a problem, please document the issue you encountered.

Mac App Usage

circle-swift rectangle-swift settings-swift

Note: This is built natively in Swift.

To launch the app on Catalina or newer for the first time, you may have to right click and select "Open" instead of double clicking on it, and you may need to do this twice. That's Apple's take on "security" for non-notarized binaries, or if you are not connected to the Internet.

You can use Cmd + , to toggle settings open and closed. The Tint feature can be used to tint your screen the color of your selected background color, or make your screen darker than otherwise possible for nighttime work (which can compound with both Night Shift and f.lux.

git clone https://github.com/peterklingelhofer/exhale.git
cd exhale
cd swift
xed .

Windows & Linux App Usage

exhaleElectron exhaleElectronCircular Screenshot 2024-06-01 at 1 35 36 PM

Note: This implementation is built with TypeScript & Electron. The macOS will build but it is not very performant and is far more CPU-intensive than the native Swift build, and as a result the Swift build is recommended for macOS users.

git clone https://github.com/peterklingelhofer/exhale.git
cd exhale
cd typescript
yarn
yarn start

To recompile automatically and use electron-reload, run in a separate terminal:

yarn run watch

Modify settings by going to Application (found in the top right via >>) > Local storage > file://. While the Developer Tools are open, you can resize the window, and opacity values are ignored, so you can position the window and change settings to your liking, and then close the Dev Tools window by clicking the x in the top right, or use F12 or Ctrl + Shift + I(Linux/Windows) or Cmd + Shift + I (macOS) to toggle Developer Tools to access and modify these settings, and Ctrl + R (Linux/Windows) or Cmd + R (macOS) to refresh the app to use your newly selected settings. If no settings appear on the first run of the application, you can manually add them), following the format of the storedValues variable in /src/renderer.ts. To add them manually, go to the Console and copy paste the following code into the console and press Enter or Return to populate your localStorage (these are the defaults as of the time of writing):

localStorage = {
  colorExhale = "rgb(0, 0, 255)",
  colorInhale = "rgb(255, 0, 0)",
  colorStyle = "linear", // can be "linear" or "constant"
  shape = "fullscreen", // can be "circle" or "rectangle" or "fullscreen"
  durationInhale = 5,
  durationPostInhalePause = 0,
  durationExhale = 10,
  durationPostExhalePause = 0,
  opacity = 0.25,
};

Once added, you can modify all values from the Local Storage pane. Or, if you prefer the terminal, in the Console you can write localStorage.opacity = "0.15" for example.

Screen Shot 2023-03-11 at 2 12 30 PM

Python Script Usage

exhalePython

Note: This implementation seems to work well on Windows and macOS, but not Linux for some reason.

git clone https://github.com/peterklingelhofer/exhale.git
cd exhale
cd python
python main.py

Modify variables at the top of the file for preferred in and out duration, in seconds.

For the full-screen resizable version, use, IS_FULL_SCREEN = True which makes the window entirely resizable by clicking and dragging from the corners.

Perl Script

Companion repository made in Perl can be found here.

Sponsorship

This app is free and will always be free, but if you want to support me or want a more rapid response time on feature requests, feel free to buy me a coffee:

Buy Me A Coffee