btcticker  by veebch

Cryptocurrency price ticker for ePaper display

Created 4 years ago
328 stars

Top 83.1% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides an ePaper cryptocurrency ticker for Raspberry Pi, displaying price information from CoinGecko on a Waveshare monochrome ePaper display. It's designed for users who want a low-power, visually unobtrusive way to monitor crypto prices, supporting customization of coins, currencies, exchanges, and display options.

How It Works

The Python script fetches cryptocurrency data from CoinGecko at a configurable interval (default 5 minutes). It then formats this data, including price, volume, rank, and optional sparklines, and renders it to a Waveshare 2.7-inch ePaper display using the waveshare_epd library. The approach leverages the low power consumption and high readability of ePaper technology for a static, always-on display.

Quick Start & Requirements

  • Install: Clone the repository and install dependencies using python3 -m pip install -r requirements.txt.
  • Prerequisites: Raspberry Pi with internet, Python 3, pip, SSH access, Waveshare 2.7-inch ePaper display (V1 or V2 with modification), SPI enabled (sudo raspi-config nonint do_spi 0).
  • Setup: Requires installing system packages (sudo apt-get install ...), cloning repositories (git clone ...), copying configuration (cp config_example.yaml config.yaml), and setting up a systemd service for autostart.
  • Links: Video

Highlighted Details

  • Supports all coins, currencies, and exchanges listed on CoinGecko.
  • Optional button controls for cycling through displayed coins/fiat currencies and rotating/inverting the display.
  • Configurable update frequency, display orientation, and inclusion of volume, rank, and trending coins.
  • Autostart functionality via systemd service.

Maintenance & Community

The project is maintained by veebch. Contribution guidelines are provided, encouraging pull requests.

Licensing & Compatibility

  • License: GNU GENERAL PUBLIC LICENSE Version 3.0 (GPL-3.0).
  • Compatibility: GPL-3.0 is a strong copyleft license. Use in commercial or closed-source projects may require careful consideration of derivative works and source code distribution obligations.

Limitations & Caveats

The project is designed specifically for Raspberry Pi and the Waveshare 2.7-inch ePaper display. Button control introduces a few seconds of lag due to the ePaper's refresh rate. The autostart configuration assumes the user is named 'pi'.

Health Check
Last Commit

2 months ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
0 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.