{"id":15148381,"url":"https://github.com/willdurand/pihole-oled","last_synced_at":"2025-10-24T03:31:46.748Z","repository":{"id":45571430,"uuid":"171116040","full_name":"willdurand/pihole-oled","owner":"willdurand","description":":computer: Pi-hole and system stats displayed on an OLED 0.96\" screen.","archived":false,"fork":false,"pushed_at":"2022-12-08T14:18:26.000Z","size":14806,"stargazers_count":25,"open_issues_count":3,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-27T13:03:26.988Z","etag":null,"topics":["gpio","oled-display-ssd1306","pihole","raspberry-pi","system-info"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willdurand.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-17T11:50:45.000Z","updated_at":"2024-09-26T18:55:58.000Z","dependencies_parsed_at":"2023-01-25T05:31:25.235Z","dependency_job_id":null,"html_url":"https://github.com/willdurand/pihole-oled","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willdurand%2Fpihole-oled","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willdurand%2Fpihole-oled/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willdurand%2Fpihole-oled/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willdurand%2Fpihole-oled/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willdurand","download_url":"https://codeload.github.com/willdurand/pihole-oled/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219866820,"owners_count":16555824,"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":["gpio","oled-display-ssd1306","pihole","raspberry-pi","system-info"],"created_at":"2024-09-26T13:03:24.772Z","updated_at":"2025-10-24T03:31:45.803Z","avatar_url":"https://github.com/willdurand.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pihole-oled\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"./res/pihole-oled-demo.gif\"\u003e\u003c/p\u003e\n\n## Hardware\n\nThe OLED display is connected _via_ I2C with 4 wires: `SDA`, `SCL`, `3.3V` and\n`GND`. There is no `reset` pin. The \"HAT\" is made with a 8-pin female header, a\npiece of proto-board and short wires. There is nothing fancy here.\n\n## Installation\n\n:warning: This project requires a Raspberry Pi with\n[Pi-hole](https://pi-hole.net/) installed, the [I2C bus\nenabled](https://learn.adafruit.com/adafruits-raspberry-pi-lesson-4-gpio-setup/configuring-i2c)\nand Python 3.5.\n\n### Software requirements\n\nIf you do not have `pip3` installed, start by installing it:\n\n```\nsudo apt-get install python3-pip\n```\n\nIf you do not have `pipenv` installed, install it too:\n\n```\npip3 install --user pipenv\n```\n\nNote: the command above keeps everything into a `~/.local` directory. You can\nupdate the current user's `PATH` by adding the following lines into your\n`.bashrc` (or equivalent):\n\n```\nexport PY_USER_BIN=\"$(python -c 'import site; print(site.USER_BASE + \"/bin\")')\"\nexport PATH=\"$PY_USER_BIN:$PATH\"\n```\n\nNow install a few libraries for\n[Pillow](https://pillow.readthedocs.io/en/stable/index.html):\n\n```\nsudo apt-get install libopenjp2-7 libtiff5\n```\n\n### Project installation\n\nClone this project:\n\n```\ngit clone https://github.com/willdurand/pihole-oled.git /home/pi/pihole-oled\n```\n\nInstall the python dependencies:\n\n```\ncd /home/pi/pihole-oled\npipenv install\n```\n\nIf you plug the OLED display and run the command below, you should see some\ninformation on the display:\n\n```\npipenv run python3 main.py\n```\n\nYou can exit the script with \u003ckbd\u003ectrl\u003c/kbd\u003e+\u003ckbd\u003ec\u003c/kbd\u003e.\n\n### Systemd configuration\n\nYou can install a `systemd` service by copying the provided configuration file\nusing the command below. This service will automatically run the python script\nmentioned in the previous section on boot:\n\n```\nsudo cp pihole-oled.service /etc/systemd/user/\n```\n\nEnable, then start the `pihole-oled.service`:\n\n```\nsudo systemctl enable /etc/systemd/user/pihole-oled.service\nsudo systemctl start pihole-oled.service\n```\n\n\n## Dev corner\n\nThis sections is only relevant if you intent to work on this project.\n\nWe use\n[conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html)\nto ship a (hopefully) reproducible environment to work on this project. Start by\ninstalling `conda`, then create the environment for this project:\n\n```\nconda env create -f environment.yml\n```\n\nDo not forget to enable this environment:\n\n```\nconda activate\n```\n\nYou should have `python3` (3.5) and `pipenv` available now.\n\n\n## License\n\nThis project is released under the MIT License. See the bundled [LICENSE\nfile](./LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilldurand%2Fpihole-oled","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwilldurand%2Fpihole-oled","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilldurand%2Fpihole-oled/lists"}