https://github.com/sourcetortoise/zzz
A sleep computer to promote lucid dreaming
https://github.com/sourcetortoise/zzz
dreaming lucid raspberry-pi sleep
Last synced: 3 months ago
JSON representation
A sleep computer to promote lucid dreaming
- Host: GitHub
- URL: https://github.com/sourcetortoise/zzz
- Owner: sourcetortoise
- License: gpl-3.0
- Created: 2024-10-29T18:16:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T17:24:59.000Z (over 1 year ago)
- Last Synced: 2025-10-25T15:29:51.859Z (7 months ago)
- Topics: dreaming, lucid, raspberry-pi, sleep
- Language: Python
- Homepage:
- Size: 143 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# zzz – sleep computer
Feeling tired? Why not stay up and hack together a machine to help you experience [lucid dreams](https://en.wikipedia.org/wiki/Lucid_dream).
`zzz` uses a trigger-style mouse to play distinctive sounds. Wear it during sleep and test your reality in dreams by squeezing your finger or thumb. If you hear the sounds, you can recognize that you're asleep and take control of the dream.
## Equipment
You will need:
- A [Raspberry Pi](https://www.raspberrypi.com/)
- An ergonomic handheld trigger mouse
- Speaker or headphones
## Setup
Clone the repo to your Pi. Install Python:
```
sudo apt update
sudo apt install python3 python3-pip
```
Install dependencies:
```
pip3 install pygame evdev
```
Depending on your Pi OS version you may need to add `--break-system-packages` here; this is fine if your Pi will be a dedicated `zzz` machine and you don't care about your Python environment; otherwise, create a virtual environment.
Put sounds in the `sound` directory and link them to your desired buttons in `zzz.py`.
Adjust volume with `alsamixer`.
## Running
Run `sh run.sh` in the project directory.
Timestamped logs are collected in `sleep.log`.
## License
This program is licensed by GPL-3.0.