Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cutwell/e-paper-pyos
Python-based operating system for touchscreen e-paper devices.
https://github.com/cutwell/e-paper-pyos
e-paper os python-os raspberry-pi-zero-2-w spotify spotify-control waveshare-epaper
Last synced: about 1 month ago
JSON representation
Python-based operating system for touchscreen e-paper devices.
- Host: GitHub
- URL: https://github.com/cutwell/e-paper-pyos
- Owner: Cutwell
- License: mit
- Created: 2024-01-16T14:23:27.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-18T23:59:45.000Z (10 months ago)
- Last Synced: 2024-10-14T19:28:56.231Z (about 1 month ago)
- Topics: e-paper, os, python-os, raspberry-pi-zero-2-w, spotify, spotify-control, waveshare-epaper
- Language: Python
- Homepage:
- Size: 96.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 
E-Paper PyOS
Python-based operating system for touchscreen e-paper devices.
[](https://opensource.org/licenses/MIT)
- A Python-based OS for e-paper applications.
- e.g.: Spotify playback control
- Plug-and-play compatability with the [Waveshare 2.13" Touch E-paper Hat](https://www.waveshare.com/2.13inch-touch-e-paper-hat.htm) and [Raspberry Pi Zero 2W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/).
## Setup
Follow this guide to setup your Raspberry Pi Zero 2W and Waveshare 2.13" Touch E-paper Hat:
1. Follow [this](https://developer.spotify.com/documentation/web-api/tutorials/getting-started#create-an-app) Spotify guide to create an app.
2. Create `.envrc`, using `.envrc.example.sh` as a template, and add your client ID/secret, etc.
3. Install [direnv](https://direnv.net/) with `make install-direnv`.
3. Access variables in your terminal environment with `direnv allow`.
_❗ Developer note: Try using `make ssh` as a shortcut to connect to your RPi._
### Installation
1. Setup your RPi using the [WaveShare documentation](https://www.waveshare.com/wiki/2.13inch_Touch_e-Paper_HAT_Manual#Raspberry_Pi). Follow the guide until `Libraries Installation`, then follow the steps below:
2. Install dependencies and libraries..
On a fresh Raspberry Pi:
```sh
make install-all
```
Install dependencies selectively:
|Dependency||
|:---:|:---:|
|[BCM2835](https://www.airspayce.com/mikem/bcm2835/) (RPi Broadcom chip) C library|`make install-bcm2835`|
|[WiringPi](https://github.com/WiringPi/WiringPi) C library|`make install-wiringpi`|
|[Rust](https://www.rust-lang.org/tools/install) (to install [PyOpenSSL](https://pypi.org/project/pyOpenSSL/))|`make install-rust`|
|[PyEnv](https://github.com/pyenv/pyenv) & [Python 3.9.18](https://www.python.org/downloads/release/python-3918/)|`make install-pyenv`|
|[Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)|`make install-poetry`|
|Poetry-managed Python dependencies|`make install-poetry-deps`|
_❗ Note: If you're having issues installing PyEnv, [make sure your build environment is set up correctly](https://github.com/pyenv/pyenv/wiki#suggested-build-environment)._
_❗ Note: Certain e-paper apps require you to login to services on your phone by scanning QR codes. Login tokens are then shared with the e-paper via callback to the devices `.local` presence on your local network. If your device defaults to HTTPS, you will need to generate an OpenSSL certificate for app servers, using `make generate-ssl-cert`._
3. Test your installation was successful by running:
```sh
make test-install
```
### Troubleshooting
The following dependencies might be missing from your system:
```sh
sudo apt-get install liblcms1-dev -y
```
## Contributing
For information on how to set up your dev environment and contribute, see [here](.github/CONTRIBUTING.md).
## License
MIT