sickprodigy/Raspberry-Pi-Pico-Thermostat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: Update README for project renaming and clarify thermostat features

Browse Source
This commit is contained in:
Aaron
2025-11-28 10:09:47 -05:00
parent 5cfa36e558
commit 27f901ff6a
1 changed files with 31 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -1,16 +1,22 @@
# 🌱 Auto Garden
> Automated climate control system using Raspberry Pi Pico W with web interface and scheduling
# 🌡️ Raspberry Pi Pico Thermostat
> **Forked from [Auto-Garden](https://gitea.rcs1.top/sickprodigy/Auto-Garden)**
> Smart thermostat and climate control system using Raspberry Pi Pico W with web interface, scheduling, and relay control
## Recent Updates ## Recent Updates
- 🆕 **Immediate schedule application:** When resuming scheduling from hold mode, the system now instantly applies the current schedule targets (no delay). - 🆕 **Immediate schedule application:** When resuming scheduling from hold mode, the thermostat instantly applies the current schedule targets (no delay).
- 🆕 **Aggressive memory management:** Garbage collection runs every 5 seconds for improved reliability. - 🆕 **Aggressive memory management:** Garbage collection runs every 5 seconds for improved reliability.
- 🆕 **Manual hold settings:** `ac_target` and `heater_target` in `config.json` now only store your last manual hold settings, not schedule targets. - 🆕 **Manual hold settings:** `ac_target` and `heater_target` in `config.json` now only store your last manual hold settings, not schedule targets.
- 🆕 **NTP sync optimization:** NTP modules are loaded only when needed, saving RAM. - 🆕 **NTP sync optimization:** NTP modules are loaded only when needed, saving RAM.
- 🆕 **Temperature validation:** Impossible sensor readings are ignored for safety. - 🆕 **Temperature validation:** Impossible sensor readings are ignored for safety.
- 🆕 **Improved config persistence:** All changes are saved and reloaded immediately. - 🆕 **Improved config persistence:** All changes are saved and reloaded immediately.
## Features ## Features
- **Core Features** - **Core Features**
@@ -24,9 +30,8 @@
- ✅ Graceful shutdown with Ctrl+C - ✅ Graceful shutdown with Ctrl+C
- ✅ **Aggressive garbage collection for stability** - ✅ **Aggressive garbage collection for stability**
- **Climate Control** - **Thermostat Control**
- ✅ Automated AC control with temperature swing logic - ✅ Automated AC and heater control with temperature swing logic
- ✅ Automated heater control with separate swing settings
- ✅ Short-cycle protection for both AC and heater - ✅ Short-cycle protection for both AC and heater
- ✅ Dual relay control via opto-coupler for 110V AC - ✅ Dual relay control via opto-coupler for 110V AC
- ✅ Mutual exclusion (AC and heater never run simultaneously) - ✅ Mutual exclusion (AC and heater never run simultaneously)
@@ -53,6 +58,7 @@
- ✅ Auto-refresh dashboard (30 seconds) - ✅ Auto-refresh dashboard (30 seconds)
- ✅ **Settings and schedule changes are reflected instantly** - ✅ **Settings and schedule changes are reflected instantly**
## Configuration Notes ## Configuration Notes
- **AC/Heater target settings:** - **AC/Heater target settings:**
@@ -61,7 +67,7 @@
- This ensures the config file always reflects the current operating temperatures, whether in hold mode or schedule mode. - This ensures the config file always reflects the current operating temperatures, whether in hold mode or schedule mode.
- **Immediate schedule application:** - **Immediate schedule application:**
- When you click "Resume Scheduling," the system applies the current schedule targets instantly, so the dashboard updates without delay. - When you click "Resume Scheduling," the thermostat applies the current schedule targets instantly, so the dashboard updates without delay.
- **Memory management:** - **Memory management:**
- Garbage collection runs every 5 seconds to prevent memory fragmentation and crashes. - Garbage collection runs every 5 seconds to prevent memory fragmentation and crashes.
@@ -69,6 +75,7 @@
- **Sensor validation:** - **Sensor validation:**
- Temperatures outside the range -50°F to 150°F are ignored to prevent false readings. - Temperatures outside the range -50°F to 150°F are ignored to prevent false readings.
## Quick Start ## Quick Start
### 1. Hardware Setup ### 1. Hardware Setup
@@ -223,10 +230,11 @@ Upload all files to your Pico:
The Pico will auto-start `main.py` on boot and be accessible at **<http://192.168.x.x>** The Pico will auto-start `main.py` on boot and be accessible at **<http://192.168.x.x>**
## Project Structure ## Project Structure
```text ```text
Auto-Garden/ Raspberry-Pi-Pico-Thermostat/
├── main.py # Entry point, configuration, system initialization ├── main.py # Entry point, configuration, system initialization
├── secrets.py # WiFi & Discord credentials (gitignored) ├── secrets.py # WiFi & Discord credentials (gitignored)
├── secrets.example.py # Template for secrets.py ├── secrets.example.py # Template for secrets.py
@@ -241,6 +249,7 @@ Auto-Garden/
└── web_server.py # Web interface for monitoring and control └── web_server.py # Web interface for monitoring and control
``` ```
## How It Works ## How It Works
### Temperature Monitoring ### Temperature Monitoring
@@ -354,6 +363,7 @@ Access at **<http://192.168.x.x>**
- **Auto-reconnect:** Attempts every 60 seconds if disconnected - **Auto-reconnect:** Attempts every 60 seconds if disconnected
- **Static IP:** Always accessible at <http://192.168.x.x> - **Static IP:** Always accessible at <http://192.168.x.x>
## Temperature Logs ## Temperature Logs
Logs are saved to `/temp_logs.csv` on the Pico: Logs are saved to `/temp_logs.csv` on the Pico:
@@ -365,6 +375,7 @@ Logs are saved to `/temp_logs.csv` on the Pico:
Format: `timestamp,location,sensor_id,temperature_f` Format: `timestamp,location,sensor_id,temperature_f`
## Customization ## Customization
### Via Web Interface (Recommended) ### Via Web Interface (Recommended)
@@ -405,6 +416,7 @@ check_interval=10 # Temperature check frequency
report_interval=30 # Discord report frequency report_interval=30 # Discord report frequency
``` ```
## Safety Notes ## Safety Notes
⚠️ **High Voltage Warning:** ⚠️ **High Voltage Warning:**
@@ -429,6 +441,7 @@ report_interval=30 # Discord report frequency
- Hold modes reset on reboot (schedules always resume) - Hold modes reset on reboot (schedules always resume)
- Static IP ensures web interface always accessible - Static IP ensures web interface always accessible
## Troubleshooting ## Troubleshooting
**Web interface not loading:** **Web interface not loading:**
@@ -501,14 +514,17 @@ report_interval=30 # Discord report frequency
- Ensure config.json has write permissions - Ensure config.json has write permissions
- Try manual edit of config.json and reboot - Try manual edit of config.json and reboot
## Contributing ## Contributing
Feel free to open issues or submit pull requests for improvements! Feel free to open issues or submit pull requests for improvements!
## License ## License
MIT License - See LICENSE file for details MIT License - See LICENSE file for details
## Resources ## Resources
- [Raspberry Pi Pico W Documentation](https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html) - [Raspberry Pi Pico W Documentation](https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html)