BTC dashboard is a Python program that you can run on a Raspberry Pi or computer of your choice and displays the output on a screen. The program provides up-to-date tracking of key Bitcoin indicators. The program uses free API's online and automatically respects their free data request limits.
No accounts, API keys, or log-ins required
The dashboard indicators include:
- A Raspberry Pi 0w, 1, 2, 3, 4+ (tested on 0w and 4) or you can also run on a computer with Python installed
- Constant internet connection
- 7 Inch Display Monitor 1024X600. Larger displays should also work.
Install Raspberry Pi OS on your Raspberry Pi
Make sure everything is updated
sudo apt-get update && sudo apt-get upgrade -y
Clone this repository
git clone https://github.com/ChuckinBits/BTC-Dashboard.git
Now you will have BTC-Dashboard directory under /home/pi/
Right mouse click btclauncher.sh and click properties
Click the "Permissions" tab and change Execute option to "Anyone" and click OK
Navigate to the BTC-Dashboard directory in the terminal
cd BTC-Dashboard
Automatically install all of the required dependencies from the requirements.txt file
pip install -r requirements.txt
Intall Requests dependency to allow requesting of the API data
pip install requests
Install XTERM dependency to allow the screensaver to be suppressed
sudo apt-get install xterm
Install PILLOW dependecy
sudo apt-get install python3-pil python3-pil.imagetk
Install Custom Tkinter dependecy
pip3 install customtkinter
Open BTC-Dashboard folder and copy btclauncher.sh to your desktop. (optional) Also feel free to rename it to whatever you want
Double click or open btclauncher.sh and if prompted select "Execute" to run the program.
Select "Execute in Terminal" to run the program and have a terminal screen running in the background which shows you what the program is doing behind the scenes and is great for debugging if there are any errors. To see the terminal while the program is running use ALT + TAB or ALT + ESC
Enjoy the Dashboard!
btclauncher.sh contains commands which suppress the default screensaver so that the screen always stays on and doesn't turn off after a certain period of time.
If you already have your screensaver suppressed or prefer not to suppress the screensaver than you can simply run BTCDashboard.py using Python3
python3 BTCDashboard.py
Open the settings menu by clicking on the settings button in the upper right hand corner of the Dashboard
Under Mempool Data there are to options: "Default" and "Custom Node"
Click "Custom Node"
In the Input box type or paste your Node's Mempool URL and port
The prefilled text in the Custom Node URL input box shows you an example of how this should look
Click on "Test Connection" button
A messagebox will appear to let you know if the program is able to successfully connect to your node
If successful, click the "Apply" button
To stop the program, click on the Bitcoin logo.
Error messages will appear in purple below Lightning Capacity and above Last update time.
The associated indicators will still show the previous values but turn purple letting you know that those indicators have been potentially affected by the error and may not be up to date.
The associated indicators will turn back to normal colors when the error clears and connection to the associated data source is restored.
The program will keep running and attempt to reestablish connection at least once every 5 minutes depending on the free API limits.
We continually try and improve the program on our spare time.
Be sure to update every once and a while for performance improvements, new features, and bug fixes.
Version is now shown on the splash screen as of v2.0.0
Navigate to the BTC-Dashboard directory in the terminal
cd BTC-Dashboard
Once in the directory run this command
git pull
If there are any updates, it will download and apply them.
Enjoy!