{"id":21222610,"url":"https://github.com/faithvoid/piholed","last_synced_at":"2025-03-15T01:28:05.041Z","repository":{"id":221841050,"uuid":"755522072","full_name":"faithvoid/PiHOLED","owner":"faithvoid","description":"PiHOLED is a basic Python script to display Raspberry Pi, Network \u0026 PiHole statistics on SH1106-based 1.3 inch (128x64) OLED display HATs, such as the Waveshare 1.3inch OLED Raspberry Pi HAT (can be modified to run on SSD1306-based HATs). Tested on a Raspberry Pi Zero W running DietPi.","archived":false,"fork":false,"pushed_at":"2024-02-16T12:26:09.000Z","size":3244,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T17:22:22.227Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/faithvoid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-10T13:22:10.000Z","updated_at":"2024-02-11T22:41:08.000Z","dependencies_parsed_at":"2024-02-16T13:43:13.847Z","dependency_job_id":null,"html_url":"https://github.com/faithvoid/PiHOLED","commit_stats":null,"previous_names":["faithvoid/piholed","faithvoid/retropiholed"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faithvoid%2FPiHOLED","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faithvoid%2FPiHOLED/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faithvoid%2FPiHOLED/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faithvoid%2FPiHOLED/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faithvoid","download_url":"https://codeload.github.com/faithvoid/PiHOLED/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243670650,"owners_count":20328502,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-20T22:45:50.404Z","updated_at":"2025-03-15T01:28:05.019Z","avatar_url":"https://github.com/faithvoid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PiHOLED\nPiHOLED is a basic Python script to display Raspberry Pi, Network \u0026 PiHole statistics on SH1106-based 1.3 inch (128x64) OLED display HATs, such as the Waveshare 1.3inch OLED Raspberry Pi HAT (can be modified to run on SSD1306-based HATs). Tested on a Raspberry Pi Zero W running DietPi but should theoretically work on any SBC + distro combination with a similar GPIO pinout. \n\nSupports safe reboot by holding KEY1 for 3 seconds, safe shutdown by holding KEY2 for 3 seconds, rotating between brightness settngs with KEY3, and switching between System / Network monitoring using the joystick (left + right).\n\n![](1.jpg)\n![](2.jpg)\n\u003cp align=\"center\"\u003e\u003ci\u003e An aesthetically modified build of PiHOLED using the supErphoniX2 font. \u003c/i\u003e \u003c/p\u003e\n\n## Features:\n### Menus:\n- Hardware - Shows your CPU, RAM and storage.\n- Network - Shows your IP address, sent/received packets, and both total and blocked queries from PiHole.\n- Music - Shows your currently playing Spotify track! (WIP)\n- Games - Shows your current running emulator/core, system name \u0026 game name! (WIP)\n\n### Buttons:\nKEY1 - Hold for 3 seconds to safely reboot.\nKEY2 - Hold for 3 seconds to shutdown.\nKEY3 - Press to cycle LCD brightness, hold mapping isn't set (yet) but you can modify the code to easily use it for whatever!\nJoystick - L/R switches between menu pages, U/D does nothing (yet?)\n\n## Requirements:\n- SPI + I2C enabled in DietPi/Raspbian (or similar distro)\n- python3\n- python3-pip\n- libopenjp2-7\n- psutil (pip)\n- requests (pip)\n- luma.oled (pip)\n- gpiozero (pip)\n\nTo install these on DietPi, install Python \u0026 RPi.GPIO via the DietPi Software installer \u0026 afterwards type \"sudo apt install libopenjp2-7 \u0026\u0026 pip3 install psutil requests luma.oled\" into your terminal. \n\nFor non-DietPi users, type \"sudo apt install python3 python3-pip libopenjp2-7 \u0026\u0026 pip3 install psutil requests luma.oled gpiozero\" instead, and modify the .service file to reflect your username.\n\n## How to install:\n- Download PiHOLED.py\n- Copy PiHOLED.py to your /home/dietpi directory\n- Edit PiHOLED.py \u0026 replace \u003cYOURAUTHTOKEN\u003e with your the contents of \"WEBPASSWORD\" in \"/etc/pihole/setupVars.con\".\n- Copy the PiHOLED.service script to /lib/systemd/system\n- Type \"systemctl enable PiHOLED \u0026\u0026 systemctl start PiHOLED\"\n\n## Configuration:\n- Rotate Screen: You can rotate the screen 180 degrees by finding \"rotate=2\" and changing it to \"rotate=0\" (or vice versa).\n\n## How to use with SSD1306-based HAT:\n- Open PiHOLED.py in Nano or a similar text editor\n- Change any instance of \"sh1106\" to \"ssd1306\"\n\n## TBD:\n- Choose better font for increased visual clarity. (supErphoniX2 works great at size 9 but it's not open-source).\n- Add an option to cycle between menu states automatically (for SH1106/SSD1306 LCDs without physical controls).\n- Further optimize CPU usage\n## Bugs:\n- CPU usage spikes by about 10% when screen refreshes, seemingly fine if you're just running PiHole but any headroom lost is still headroom lost. As far as I can tell from testing other similar Python scripts, this amount of CPU usage is about expected, but I would love to be shown otherwise.\n\nAny and all feedback (optimizations, etc) is appreciated! Although feature requests will most likely be ignored as the scope of this project (basic PiHole + Pi statistics) has largely been covered already.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaithvoid%2Fpiholed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaithvoid%2Fpiholed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaithvoid%2Fpiholed/lists"}