Skip to content

docs: add Troubleshooting section to README#101

Merged
GageLawton merged 1 commit into
mainfrom
docs/troubleshooting
May 26, 2026
Merged

docs: add Troubleshooting section to README#101
GageLawton merged 1 commit into
mainfrom
docs/troubleshooting

Conversation

@GageLawton
Copy link
Copy Markdown
Owner

Summary

Adds a Troubleshooting section to README.md covering the most common failure modes when setting up WeatherDisplay on a Pi.

Sections added

  • LCD garbled/blank - contrast potentiometer explanation
  • LCD stuck on Connecting... - how to check logs, what env vars to verify
  • I2C devices not detected - i2cdetect, raspi-config, Pi 5 bus IDs
  • NeoPixel ring dark/flickering - GPIO 10 / SPI requirement, group membership
  • Email alerts not arriving - App Password requirement, engineering mode tip
  • Service not starting - where to look in journald, binary install path

Test plan

  • Verify Markdown renders correctly on GitHub
  • Confirm commands are accurate for the systemd setup described in the README

Closes #28

Covers the most common failure modes reported or noted in code comments:
LCD contrast adjustment, perpetual "Connecting..." state, I2C not
detected, NeoPixel ring dark/flickering, email alerts not sending, and
systemd service failing to start. Each entry lists symptoms, the
relevant log command, and the fix.

Closes #28

https://claude.ai/code/session_01VdFLjQPRxkWMY96TZBNHKp
@GageLawton GageLawton merged commit f80684c into main May 26, 2026
2 checks passed
@GageLawton GageLawton deleted the docs/troubleshooting branch May 26, 2026 04:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature/Improve Documentation for WeatherDisplay

2 participants