# Clean Dashboard for Pi-Hole
Minimal 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.
<p align="center">
<a href="https://pypi.org/project/pihole-dashboard/"><img alt="PyPI" src="https://img.shields.io/pypi/v/pihole-dashboard"></a>
<a href="#"><img alt="Updated" src="https://img.shields.io/github/last-commit/santoru/pihole-dashboard?label=updated"></a>
<a href="https://pi-hole.net/"><img alt="Powered-By" src="https://img.shields.io/badge/Powered--By-Pi--Hole-FF0000?logo=pi-hole"></a>
<br/>
<img src="/img/raspberry.jpg" alt="Raspberry Pi Zero" />
</p>
## My Setup
- Raspberry Pi Zero WH (You can also solder the headers by yourself)
- <a href="https://www.waveshare.com/2.13inch-e-paper-hat.htm">2.13 inch E-Ink display HAT for Raspberry Pi</a>
- <a href="https://pi-hole.net/">Pi-Hole</a> (I have v5.2.4 at the moment)
## Configuration
After 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 the `wlan0` interface, you can change this value in `/etc/pihole-dashboard/config.toml`.
### WaveShare e-Paper dependency
Making 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 spidev
```
In order to use the 2.13 inch E-Ink display with Python, you also need to get and build their `waveshare-epd` library:
```bash
git clone https://github.com/waveshare/e-Paper.git
cd e-Paper/RaspberryPi_JetsonNano/python/
sudo python3 setup.py install
```
You can check if the display is working by running the test example:
```bash
cd e-Paper/RaspberryPi_JetsonNano/python/
sudo python3 examples/epd_2in13_V2_test.py
```
Test 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 need **root** access to control the display, so be sure to run the python example as root.\
You also need to [enable the SPI interface](https://www.raspberrypi.org/documentation/hardware/raspberrypi/spi/README.md#software), 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.
## Installation
The installation requires to have already a Raspberry with Pi-Hole installed and correctly running, if you have problem installing Pi-Hole <a href="https://github.com/pi-hole/pi-hole">check their README</a>.
### Dependencies
Ensure that you have already this `Pillow` dependency installed:
```bash
sudo apt install libopenjp2-7
```
### From PyPI
```bash
sudo pip3 install pihole-dashboard
```
### From Source
```bash
git clone https://github.com/santoru/pihole-dashboard
cd pihole-dashboard
sudo pip3 install .
```
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.
## Uninstall
You can remove the tool anytime by running
```bash
sudo pip uninstall pihole-dashboard
```
You can also manually remove the cronjob and config file by running
```bash
sudo rm /etc/cron.d/pihole-dashboard-cron
sudo rm -rf /etc/pihole-dashboard/
```
## How it works
The 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.
## Troubleshooting
If the dashboard is not displaying, you can check if the script return an error by running
```bash
sudo pihole-dashboard-draw
```
If everything is working as expected, nothing will be printed out.
If you still have errors, please open an issue.
Raw data
{
"_id": null,
"home_page": "https://github.com/santoru/pihole-dashboard",
"name": "pihole-dashboard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.3.5",
"maintainer_email": "",
"keywords": "",
"author": "santoru",
"author_email": "santoru@pm.me",
"download_url": "https://files.pythonhosted.org/packages/8a/b0/85815f5b30520d037a376c9cb4fde5b0f6db5ba5d9985fe115a29bf31d0e/pihole-dashboard-1.0.3.tar.gz",
"platform": null,
"description": "# Clean Dashboard for Pi-Hole\nMinimal and clean dashboard to visualize some stats of Pi-Hole with an E-Ink display attached to your Raspberry Pi.\n\nThis 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.\nAdditionally, 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.\n<p align=\"center\">\n <a href=\"https://pypi.org/project/pihole-dashboard/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/pihole-dashboard\"></a>\n <a href=\"#\"><img alt=\"Updated\" src=\"https://img.shields.io/github/last-commit/santoru/pihole-dashboard?label=updated\"></a>\n <a href=\"https://pi-hole.net/\"><img alt=\"Powered-By\" src=\"https://img.shields.io/badge/Powered--By-Pi--Hole-FF0000?logo=pi-hole\"></a>\n <br/>\n <img src=\"/img/raspberry.jpg\" alt=\"Raspberry Pi Zero\" />\n</p>\n\n## My Setup\n- Raspberry Pi Zero WH (You can also solder the headers by yourself)\n- <a href=\"https://www.waveshare.com/2.13inch-e-paper-hat.htm\">2.13 inch E-Ink display HAT for Raspberry Pi</a>\n- <a href=\"https://pi-hole.net/\">Pi-Hole</a> (I have v5.2.4 at the moment)\n\n## Configuration\nAfter set the webui api token, the tool should run out of the box with standard installation of Pi-Hole.\\\nYou 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.\\\nIf your instance of Pi-Hole is running on a different port than 80, you should change it inside `/etc/pihole-dashboard/config.toml`.\\\nThe IP address is shown considering the `wlan0` interface, you can change this value in `/etc/pihole-dashboard/config.toml`.\n\n### WaveShare e-Paper dependency\nMaking 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.\n\nYou can find on the above link the list of required dependencies for Python and how to run and test the provided examples.\nJust for reference, this is the list of dependencies that should be installed on a Raspberry Pi Zero to configure the display I have:\n```\nsudo apt-get install python3-pip python3-pil python3-numpy\nsudo pip3 install RPi.GPIO\nsudo pip3 install spidev \n```\nIn order to use the 2.13 inch E-Ink display with Python, you also need to get and build their `waveshare-epd` library:\n```bash\ngit clone https://github.com/waveshare/e-Paper.git\ncd e-Paper/RaspberryPi_JetsonNano/python/\nsudo python3 setup.py install\n```\n\nYou can check if the display is working by running the test example:\n```bash\ncd e-Paper/RaspberryPi_JetsonNano/python/\nsudo python3 examples/epd_2in13_V2_test.py\n```\nTest script depends on your screen type. There should be a sticker which tells your screen type.\nIf yours is a newer V3, before run the test, your should change V2 to V3.\n\nRemember that you need **root** access to control the display, so be sure to run the python example as root.\\\nYou also need to [enable the SPI interface](https://www.raspberrypi.org/documentation/hardware/raspberrypi/spi/README.md#software), otherwise the display connection will not work.\n\nThe 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.\nIf the example does not work, do not proceed further with the installation as this probably will not work either.\n\n## Installation\nThe installation requires to have already a Raspberry with Pi-Hole installed and correctly running, if you have problem installing Pi-Hole <a href=\"https://github.com/pi-hole/pi-hole\">check their README</a>.\n\n### Dependencies\nEnsure that you have already this `Pillow` dependency installed:\n```bash\nsudo apt install libopenjp2-7\n```\n### From PyPI\n```bash\nsudo pip3 install pihole-dashboard\n```\n### From Source\n```bash\ngit clone https://github.com/santoru/pihole-dashboard\ncd pihole-dashboard\nsudo pip3 install .\n```\nOnce installed, **Add API key to your config file, change screen type if needed** (at `/etc/pihole-dashboard/config.toml`), then reboot the Raspberry Pi. \nThe dashboard should appear few minutes after the reboot.\n\n## Uninstall\nYou can remove the tool anytime by running\n```bash\nsudo pip uninstall pihole-dashboard\n```\nYou can also manually remove the cronjob and config file by running\n```bash\nsudo rm /etc/cron.d/pihole-dashboard-cron\nsudo rm -rf /etc/pihole-dashboard/\n```\n\n## How it works\nThe 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.\n\n## Troubleshooting\nIf the dashboard is not displaying, you can check if the script return an error by running\n```bash\nsudo pihole-dashboard-draw\n```\nIf everything is working as expected, nothing will be printed out.\nIf you still have errors, please open an issue.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Minimal dashboard for Pi-Hole that works with WaveShare's 2.13 inch HAT display",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/santoru/pihole-dashboard"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5daf3bbcc98c73c2f9ff9fc78f66720ca0c13475d912b5ba2f0eb0eac1fe7389",
"md5": "f56e009e6b0fc23486b9ab0516179ed4",
"sha256": "d25142270b3380efb37c48d205efea0fc644167ea24dff20ca51d3ec99773926"
},
"downloads": -1,
"filename": "pihole_dashboard-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f56e009e6b0fc23486b9ab0516179ed4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.3.5",
"size": 138105,
"upload_time": "2023-08-13T15:02:35",
"upload_time_iso_8601": "2023-08-13T15:02:35.187411Z",
"url": "https://files.pythonhosted.org/packages/5d/af/3bbcc98c73c2f9ff9fc78f66720ca0c13475d912b5ba2f0eb0eac1fe7389/pihole_dashboard-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ab085815f5b30520d037a376c9cb4fde5b0f6db5ba5d9985fe115a29bf31d0e",
"md5": "7c2acd306e8e83ba88a5238e6ef528d1",
"sha256": "523a8579743a25227579945bcccd139244a5568fae2ba347835ad5b3bbaf8e4b"
},
"downloads": -1,
"filename": "pihole-dashboard-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "7c2acd306e8e83ba88a5238e6ef528d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.3.5",
"size": 127806,
"upload_time": "2023-08-13T15:02:37",
"upload_time_iso_8601": "2023-08-13T15:02:37.564529Z",
"url": "https://files.pythonhosted.org/packages/8a/b0/85815f5b30520d037a376c9cb4fde5b0f6db5ba5d9985fe115a29bf31d0e/pihole-dashboard-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-13 15:02:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "santoru",
"github_project": "pihole-dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "waveshare-epd",
"specs": []
},
{
"name": "netifaces",
"specs": [
[
">=",
"0.10.9"
]
]
},
{
"name": "Pillow",
"specs": [
[
">=",
"8.2.0"
]
]
},
{
"name": "toml",
"specs": [
[
">=",
"0.10.2"
]
]
}
],
"lcname": "pihole-dashboard"
}
JSON
