Bump og3 again, revised README (gemini)

Author: chl33

README.md

@@ -1,71 +1,112 @@
 # Plant133
 
-This is a full distribution of the Plant133 plant-watering device.  This device can monitor and water up to 4 plants at a time.  This repository hosts the firmware, PCBA design, and OpenSCAD code for the all components.
+This is a full distribution of the Plant133 plant-watering device. This device can monitor and water up to 4 plants at a time. This repository hosts the firmware, PCBA design, and OpenSCAD code for all components.
 
 A writeup about this project is at "[Plant1337: "Water 4 plants](https://selectiveappeal.org/posts/plant1337/)."
 
 ![Plant133 device](images/plant1337_deployed_trim-1400x600.webp)
 
+## Features
 
-## Setup
+*   **Multi-Plant Support**: Monitors and independently waters up to 4 plants.
+*   **Sensors**:
+    *   Capacitive soil moisture sensing for each plant.
+    *   SHT3x temperature and humidity sensor for environmental monitoring.
+    *   Reservoir water level float switch detection.
+*   **User Interface**:
+    *   **OLED Screen**: Rotates through status screens showing IP address, moisture levels, and environment data.
+    *   **Web Dashboard**: A modern Svelte-based responsive web interface for real-time monitoring and configuration.
+*   **Integration**:
+    *   **MQTT**: Full support for Home Assistant auto-discovery and state reporting.
+*   **Safety**:
+    *   **Watchdog Timer**: Hardware watchdog protects against system hangs.
+    *   **Dose Limiting**: Prevents over-watering by limiting the maximum number of pump cycles per day.
+    *   **Reservoir Check**: Prevents pump damage by detecting low water levels.
 
-Please see the [instructions](instructions.md) for how to setup a Plant133 device if you are lucky enough to have one.
+## Usage
 
+Please see the [instructions](instructions.md) for how to assemble and set up a Plant133 device hardware.
 
-## Software
+## Development
 
-This project is built using my C++ framework for ESP devices.
-- [og3](https://github.com/chl33/og3) My application framework.
-- [og3x-oled](https://github.com/chl33/og3x-oled) Support for the OLED screen I use with this project
-- [og3x-shtc3](https://github.com/chl33/og3x-shtc3) Support for the SHTC3 temperature/humidty sensor used by this project.
+### Prerequisites
+*   [PlatformIO](https://platformio.org/) (Core or VSCode extension)
+*   [Node.js](https://nodejs.org/) (for building the web interface)
 
-The web interface for the project uses the Svelte framework, and was partially generated by Claude (Anthropic). Claude said it was OK to include the code in this MIT-licensed project. The web interface integration is performed using [svelteesp32](https://github.com/BCsabaEngine/svelteesp32).
+### Building the Web Interface
+The web interface is built with Svelte and must be compiled before uploading to the ESP32's filesystem.
 
-![Plant133 web interface](images/plant133-svelte-interface-v091.jpg)
+```bash
+cd svelte
+npm install
+npm run build
+```
 
+This generates the static HTML/CSS/JS files in `data/static/`.
 
+### Building and Flashing Firmware
 
-## PCBA
+1.  **Configure Secrets**: Copy `secrets.ini.example` to `secrets.ini` and set your WiFi credentials, OTA password, and MQTT details.
+2.  **Build Firmware**:
+    ```bash
+    pio run
+    ```
+3.  **Upload Filesystem** (contains the web interface):
+    ```bash
+    pio run -t uploadfs
+    ```
+4.  **Upload Firmware**:
+    ```bash
+    pio run -t upload
+    ```
 
-The full [KiCAD](https://www.kicad.org/) project for the printed circuit board is in the [KiCAD](KiCAD/) subdirectory.  KiCAD is a cross platform, open source electronics design system.
+## API Reference
 
-![Plant1337 PCBA rendered by KiCAD](images/plant1337-board-kicad.png)
-
-## Components which can be printed with a 3D printer
+The device exposes a JSON API for integration and control:
 
-Several components for the Plant133 device are printed with a 3D printer. These are designed as 3D geometry descriptions in [OpenSCAD](https://openscad.org/).  The code for these are in the [scad](scad/) subdirectory.
+*   `GET /api/status`: Returns system status (temp, humidity, water level).
+*   `GET /api/plants`: Returns configuration for all plants.
+*   `GET /api/moisture`: Returns current moisture readings.
+*   `PUT /api/plants/{id}`: Update configuration for a specific plant.
+*   `POST /test/pump`: Run a pump for a specific duration (JSON body: `{ "pumpId": 1, "duration": 1000 }`).
+*   `POST /api/restart`: Restart the device.
 
-### Project box
+## Software Libraries
 
-OpenSCAD code for the project box housing the PCBA is in the [scad/box/](scad/box/) subdirectory.  It requires the library at https://github.com/chl33/ProjectBox.
+This project is built using a custom C++ framework for ESP devices:
+- [og3](https://github.com/chl33/og3): Application framework.
+- [og3x-oled](https://github.com/chl33/og3x-oled): OLED screen support.
+- [og3x-shtc3](https://github.com/chl33/og3x-shtc3): SHTC3 sensor support.
+- [svelteesp32](https://github.com/BCsabaEngine/svelteesp32): Web interface integration.
 
-![EBox design in OpenSCAD](images/scad-plant133-ebox.png)
+## Hardware
 
-### Project box reservoir hanger
+### PCBA
 
-Code for a plate which allows you to hang the EBox on the side of a water reservoir is in [scad/ebox_hook](scad/ebox_hook). This is screwed to the bottom part of the EBox.
+The full [KiCAD](https://www.kicad.org/) project for the printed circuit board is in the [KiCAD](KiCAD/) subdirectory.
 
-![Reservoir hanger](images/ebox-reservoir-hook.png)
+![Plant1337 PCBA rendered by KiCAD](images/plant1337-board-kicad.png)
 
-### Reservoir insert
+### 3D Printed Components
 
-Inside the water reservoir, an insert holds a float for detecting the water level and 1-4 aquarium pumps for watering the plants.  The code for this insert is in [scad/reservoir_insert](scad/reservoir_insert).
+Components are designed in [OpenSCAD](https://openscad.org/). Source code is in the [scad](scad/) subdirectory.
 
-![Reservoir insert with 2 pumps](images/scad-insert-2-pumps.png)
+#### Project box
+Housing for the PCBA ([scad/box/](scad/box/)).
+![EBox design in OpenSCAD](images/scad-plant133-ebox.png)
 
-### Moisture sensor cap
+#### Reservoir Hanger
+Mounts the box to a water reservoir ([scad/ebox_hook](scad/ebox_hook)).
+![Reservoir hanger](images/ebox-reservoir-hook.png)
 
-A cap for the moisture sensor can hold the end of the watering tube in place in the plant's pot, for when the watering spike is not used.
+#### Reservoir Insert
+Holds pumps and water level float ([scad/reservoir_insert](scad/reservoir_insert)).
+![Reservoir insert with 2 pumps](images/scad-insert-2-pumps.png)
 
+#### Moisture Sensor Cap
+Holds the watering tube at the sensor location ([scad/moisture_sensor_cap](scad/moisture_sensor_cap)).
 ![Moisture sensor cap top](images/scad-moisture-sensor-cap-4.png)
-![Moisture sensor cap bottom](images/scad-moisture-sensor-cap-bot.png)
-
-### Watering spike
-
-The end of the watering tube can be inserted into a 3D-printed spike with holes in it, which can be inserted into the soil in the plant pot to spread water through the pot.
-
-The spike is printed in two halves which can be epoxied together.
 
+#### Watering Spike
+Alternative watering method using a soil spike ([scad/spike](scad/spike)).
 ![Watering spike half](images/scad-spike.png)
-
-![Spike photo](images/spike.jpg)

platformio.ini

@@ -25,7 +25,7 @@ monitor_filters = esp32_exception_decoder
 build_type = release
 lib_deps =
 ;        watering
-	og3@^0.3.98
+	chl33/og3@^0.3.99
 	og3x-oled@^0.3.1
 	og3x-shtc3@^0.3.0
 	adafruit/Adafruit BusIO