Skip to content

Commit

Permalink
Move information from Wiki to Readme
Browse files Browse the repository at this point in the history
see pi-hole#333 

Signed-off-by: Michael Woolweaver <[email protected]>
  • Loading branch information
mwoolweaver authored Feb 14, 2025
1 parent ca33114 commit 6289af7
Showing 1 changed file with 47 additions and 1 deletion.
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ curl -sSL https://install.padd.sh -o padd.sh
sudo chmod +x padd.sh
```

- Set PADD to auto run by adding the following to the end of `~/.bashrc`:
- Set PADD to auto run on the PiTFT screen by adding the following to the end of `~/.bashrc`:

```bash
# Run PADD
Expand All @@ -49,6 +49,18 @@ cd ~ ; echo "if [ \"\$TERM\" == \"linux\" ] ; then\n while :\n do\n ./padd.

- Reboot your Pi-Hole by running `sudo reboot`. PADD should now run when your Pi-Hole has completed booting.

### (Optional) Put the PiTFT Display to Sleep at Night
*If you don't want your PiTFT on all night when you are asleep, you can put it to sleep! (Note: __these instructions only apply to a PiTFT__.)*

- To do so, edit cron as root (`sudo crontab -e`) and add the following:
```bash
# PiTFT+ SLEEPY TIME
# Turn off the PiTFT+ at midnight
00 00 * * * sh -c 'echo "0" > /sys/class/backlight/soc\:backlight/brightness'
# Turn on the PiTFT+ at 8:00 am
00 08 * * * sh -c 'echo "1" > /sys/class/backlight/soc\:backlight/brightness'
```

## Updating PADD
- Simply run

Expand All @@ -72,3 +84,37 @@ If you're running Pi-hole in the official Docker Container, `padd.sh` is pre-ins
```bash
docker exec -it <container_name> padd [padd_options]
```

## Sizes
PADD will display on screens that anywhere from 20x10 characters to over 80x26 characters.

As your screen gets smaller, you’ll be presented with less information… however, you’ll always get the most important details:
- The status of your Pi-hole (is it online, in need of an update?),
- How many ads have been blocked,
- Your hostname and IP, and
- Your CPU’s current load.

It will also run in the following modes (shown further below):
- Pico: 20x10 characters
- Nano: 24x12 characters
- Micro: 30x16 characters
- Mini: 40x18 characters
- Tiny: 53x20 characters
- Slim: 60x21 characters
- Regular: 60x22 characters (takes up the entire screen on a 3.5" Adafruit PiTFT using the Terminal font at 8x14.)
- Mega: 80x26 characters

### Sizing Your PADD
How PADD will display on your screen depends on the size of the screen in *characters*, not *pixels*! PADD doesn’t care if it is running on a 5k Retina display on your $5,000 iMac Pro or on a $5 display you bought on eBay.

If you want to change how PADD displays on a small display attached to your Raspberry Pi, use
```bash
sudo dpkg-reconfigure console-setup
```
to configure your font settings to an ideal size for you.

If you want to change how PADD displays through a terminal emulator (PuTTY, Terminal.app, iTerm2, etc.), resize your window or play with font sizes in your app of choice.

### The Sizes

![PADD Sizes GIF](https://github.com/pi-hole/graphics/blob/master/PADD/PADDsizes.gif)

0 comments on commit 6289af7

Please sign in to comment.