Package: pihole-dashboard
Clean Dashboard for Pi-HoleMinimal and clean dashboard to visualize some stats of Pi-Hole with an E-Ink display attached to your Raspberry Pi.This is very useful if you keep a Pi Zero with Pi-Hole connected to your router and you want a clean dashboard to monitor its status.
Additionally, I do not use static IP so if this ever change, I have an easy way to get the real time IP of the Raspberry.My SetupRaspberry Pi Zero WH (You can also solder the headers by yourself)2.13 inch E-Ink display HAT for Raspberry PiPi-Hole(I have v5.2.4 at the moment)ConfigurationAfter set the webui api token, the tool should run out of the box with standard installation of Pi-Hole.You can find your API in Pi-Hole's webpage: Settings - API - Show API token - Yes, show API token. Then, RAW API Token is the token.If your instance of Pi-Hole is running on a different port than 80, you should change it inside/etc/pihole-dashboard/config.toml.The IP address is shown considering thewlan0interface, you can change this value in/etc/pihole-dashboard/config.toml.WaveShare e-Paper dependencyMaking the E-Ink display work is not fully covered here, as it depends mostly on the display you use. As said before, I have the WaveShare's 2.13 inch E-Ink display, that has a nice detailed Wiki here:https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT.You can find on the above link the list of required dependencies for Python and how to run and test the provided examples.
Just for reference, this is the list of dependencies that should be installed on a Raspberry Pi Zero to configure the display I have:sudo apt-get install python3-pip python3-pil python3-numpy
sudo pip3 install RPi.GPIO
sudo pip3 install spidevIn order to use the 2.13 inch E-Ink display with Python, you also need to get and build theirwaveshare-epdlibrary:gitclonehttps://github.com/waveshare/e-Paper.gitcde-Paper/RaspberryPi_JetsonNano/python/
sudopython3setup.pyinstallYou can check if the display is working by running the test example:cde-Paper/RaspberryPi_JetsonNano/python/
sudopython3examples/epd_2in13_V2_test.pyTest script depends on your screen type. There should be a sticker which tells your screen type.
If yours is a newer V3, before run the test, your should change V2 to V3.Remember that you needrootaccess to control the display, so be sure to run the python example as root.You also need toenable the SPI interface, otherwise the display connection will not work.The example will print several geometric objects on the screen if everything is working as expected, followed by a simple clock program that updates every second.
If the example does not work, do not proceed further with the installation as this probably will not work either.InstallationThe installation requires to have already a Raspberry with Pi-Hole installed and correctly running, if you have problem installing Pi-Holecheck their README.DependenciesEnsure that you have already thisPillowdependency installed:sudoaptinstalllibopenjp2-7From PyPIsudopip3installpihole-dashboardFrom Sourcegitclonehttps://github.com/santoru/pihole-dashboardcdpihole-dashboard
sudopip3install.Once installed,Add API key to your config file, change screen type if needed(at/etc/pihole-dashboard/config.toml), then reboot the Raspberry Pi.
The dashboard should appear few minutes after the reboot.UninstallYou can remove the tool anytime by runningsudopipuninstallpihole-dashboardYou can also manually remove the cronjob and config file by runningsudorm/etc/cron.d/pihole-dashboard-cron
sudorm-rf/etc/pihole-dashboard/How it worksThe tool will install a Cron Job on the Raspberry Pi that will check the status of Pi-Hole every minute. If there's an update to display, the screen will refresh and update its content.TroubleshootingIf the dashboard is not displaying, you can check if the script return an error by runningsudopihole-dashboard-drawIf everything is working as expected, nothing will be printed out.
If you still have errors, please open an issue.