Skip to content

Add 'Run as a Kiosk' section to README #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mzac wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add 'Run as a Kiosk' section to README #175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
406d9b5
Add 'Run as a Kiosk' section to README
mzac May 2, 2026
a033fe0
Update README with fullscreen configuration details
mzac May 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ https://community.weatherflow.com/
**[Installation Instructions](#installation-instructions)**<br>
**[Update Instructions](#update-instructions)**<br>
**[Auto-Start Instructions](#auto-start-instructions)**<br>
**[Run as a Kiosk](#run-as-a-kiosk)**<br>
**[Advanced: Custom Panels](#advanced-custom-panels)**<br>
**[Advanced: Device Replacement](#advanced-device-replacement)**<br>
**[Advanced: Windows Installation](#advanced-installation-windows)**<br>
Expand Down Expand Up @@ -179,6 +180,35 @@ stop command or a hard shutdown:
wfpiconsole stop
```

## Run as a Kiosk

When the console is launched into the default Raspberry Pi OS LXDE session, the lxpanel taskbar can prevent the console from covering the full screen even with `Fullscreen = 1`. To run the Pi as a dedicated weather console with no desktop panel or icons, edit `/etc/xdg/lxsession/LXDE-pi/autostart` and remove (or comment out) the `@lxpanel` and `@pcmanfm --desktop` lines. Optionally add three `xset` lines to keep the display awake 24/7:

```bash
sudo cp /etc/xdg/lxsession/LXDE-pi/autostart /etc/xdg/lxsession/LXDE-pi/autostart.bak
sudo tee /etc/xdg/lxsession/LXDE-pi/autostart > /dev/null <<'EOF'
@xset s off
@xset -dpms
@xset s noblank
EOF
sudo reboot
```

To restore the original desktop:
```bash
sudo cp /etc/xdg/lxsession/LXDE-pi/autostart.bak /etc/xdg/lxsession/LXDE-pi/autostart
sudo reboot
```

This change is system-wide and only applies to LXDE/X11 sessions. The Wayfire/Wayland sessions used on newer Raspberry Pi OS releases require a different approach.

If after applying this you still see a window title bar with the bottom of the console clipped, openbox is putting the console in maximized state instead of true fullscreen. Force fullscreen at startup by also setting the following in `~/.kivy/config.ini` under `[graphics]`:

```
fullscreen = auto
borderless = 1
```

## Advanced: Custom Panels

The console is distributed with 7 built-in panels to display weather, forecast
Expand Down