Code Monkey home page Code Monkey logo

btcticker's Introduction

Bitcoin (with Small Love Potion) ePaper Ticker

V1.0

A Python3 ePaper Cryptocurrency price ticker that runs on a Raspberry Pi connected to a Waveshare 2.7 inch monochrome ePaper display. The script periodically takes data from CoinGecko and prints a summary to the ePaper.

A few minutes work gives you a desk ornament that will tastefully monitor Bitcoin's journey moonward.

Action Shot

Getting started

Prerequisites

(These instructions assume that your Raspberry Pi is already connected to the Internet, happily running pip and has Python3 installed)

If you are running the Pi headless, connect to your Raspberry Pi using ssh.

Install the Waveshare Python module following the instructions on their Wiki.

(To install the waveshare_epd python module, you need to run the setup file in their repository)

cd e-Paper/RaspberryPi\&JetsonNano/python
sudo python3 setup.py install

Install & Run

Copy the files from this repository onto the Pi, or clone using:

git clone https://github.com/llvllch/btcticker.git
cd btcticker

Install the required modules using pip:

python3 -m pip install -r requirements.txt

If you'd like the script to persist once you close the session, use screen.

Start a screen session:

screen bash

Run the script using:

python3 btcticker.py

Detatch from the screen session using CTRL-A followed by CTRL-D

The ticker will now pull data every 10 minutes and update the display.

Interface

The ePaper is slow. There is a lag of a few seconds between button press and a change to the display.

Here's what the buttons do:

  • Button 1: Toggle to next currency listed in config.yaml
  • Button 2: Rotate Display -90 degrees
  • Button 3: Invert Display
  • Button 4: Hide Display. Replace with 1 coin = 1 coin message

Update frequency can be changed in the config.yaml file (default is 600 seconds).

Fork original CODE by "snarflakes/btcticker" and customize your coins!

  • Update Coins name by changing one of the existing coins to your desired coin in the config.yaml file. Example and quirk: Small love potion should be written as small-love-potion (no spaces). Make sure you then add an Image to go with the coin. Click Image directory, Click Currency directory, and add file there which should be named nameofyourcoin.bmp.

OR

Fork my changes and just replace the Axie Graphic for your own.

  • Update Graphic (axie) of your custom Coin. Click Image directory, Click Currency directory, delete current small-love-potion graphic and upload 100x100bmp file of your own Axie (rename to small-love-potion.bmp) or do the same with the official SLP graphic.

Contributing

To contribute, please fork the repository and use a feature branch. Pull requests are welcome.

Links

Licencing

The code in this project is licensed under MIT license.

btcticker's People

Contributors

rossdonald97 avatar snarflakes avatar spendiff avatar veebch avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.