cryptopaper    📈 📰

A BTC/LTC/USD dashboard with scraped headlines, topical statistics and data from on-going global crises.

Designed with high-visibility and at-a-glance updates in mind. Intended for 2200x1650* e-paper devices such as the Boox Mira. Well suited to low power instrumentation.
_{*Now supports any 4:3 resolution.}

<UP> and <DOWN> keys will adjust contrast

<ESC> to exit

Please note: As of v1.1.0 a local web service is launched on port 5000 to allow some basic web management. See options.py.

From left to right from top to bottom:

• Time, Date, BTC/USD Spot

• Headlines from BBC world news*

• BTC/USD high and low during the last six hours**

• Main BTC/USD chart for the last six hours.**

• Versatile Data Chart

  Currently shows statistics from Russia's brutal, destructive and entirely self-inflicted death-spiral. Was going to be climate data but ended up being used to show Covid-19 stats instead. Then Putin went on TV and told everyone, "I have decided..."

• Movement Indicator

  At a glance you can see whether BTC/USD is currently (relative to the six hour window) trending upwards or downards. It's a simplified high/low candle adapted for high visibility.

• Volatility Indicator

  If the inner circle fills the outer circle, there's been around 10% movement (or more) during the last six hours**. It's a high visibility indicator of the scale of the movement seen during the six hour window.

  Spread and change for this period are also shown above and below on its right hand side.

  This is also where you'll find the digital clock's analogue second hand.

• Weather, Status, LTC/USD

  Current weather, Configured locale, local IP, contrast level (if not default), uptime & LTC/USD

• LTC/BTC rate** will remain 'inverted' if below a preset threshold.
  
  

* Headlines will flash (alternating inverted state) if they match any of a set of words defined in lib/watch-words.txt.

** Chart will need six hours from launch to fill with data as no files are written to or saved at any point.

---

Installation:

git clone https://github.com/KF-R/cryptopaper
cd cryptopaper
pip install -r requirements.txt

Optionally, if you would like to run it directly on linux or macs:

mv cryptopaper.py cryptopaper
chmod +x cryptopaper

Now you can run it from the command line with ./cryptopaper.

I don't know why I feel the need to mention any of this. You're here, after all.

---

Customizations:

• Watch Words

  lib/watch-words.txt contains an editable list of newline-separated search strings.

  Any headline containing any of these strings will flash (toggling inverted status every other second).

• Options

  lib/options.txt contains two editable values; one for LTC/BTC threshold and one for the weather search string i.e. your ___location.

  Below the LTC/BTC threshold specified in this file, the LTC/BTC indicator will be inverted (white on black). The weather locale is fed to the most excellent wttr.in so ___location strings valid there should work here.

• Resolution

  As of v1.0.5, any 4:3 resolution is supported through smooth rescaling, which may degrade performance on low powered platforms. Anything from a Pi 4 upwards should be fine. In order to use the custom resolutions, simply pass the desired width in pixels as an integer argument:

  python3 cryptopaper.py 1200

  or

  ./cryptopaper 1872

• Versatile Data Chart

  Currently the data is pulled from the 2022-Ukraine-Russia-War-Dataset. The plan is to abstract this into a plug-in module so it's more... versatile.

---

Notes:

    This little project was never intended for public consumption, but I found it so useful that it kept getting hacked into a slightly better version until eventually it felt like something I should share. Maybe someone will want to tweak the files and run it on a Pi with a nice e-paper display like I do; maybe I've saved someone ten minutes because they can pinch some code or ideas. In any case, enjoy.
    Oh, and Slava Ukraini.