From 999a6fb40523c63602f04e1f9cc31a4cf50075a6 Mon Sep 17 00:00:00 2001 From: JakeTheRabbit <123831499+JakeTheRabbit@users.noreply.github.com> Date: Sun, 9 Aug 2026 05:28:23 +1200 Subject: [PATCH] docs: link parts list to maintained catalogue --- PARTS_LIST.md | 62 +++++++-------------------------- Packages/CropSteering/README.md | 10 ++++++ Packages/ReadMe.MD | 3 ++ README.md | 62 ++++++++++++++++++++++----------- esphome/README.md | 13 ++++--- growingSOPs/README.md | 3 ++ teros-12/Readme.md | 5 +-- 7 files changed, 81 insertions(+), 77 deletions(-) create mode 100644 Packages/CropSteering/README.md diff --git a/PARTS_LIST.md b/PARTS_LIST.md index 5e10114..fb61d6e 100644 --- a/PARTS_LIST.md +++ b/PARTS_LIST.md @@ -1,54 +1,18 @@ -# Parts list +# Parts list moved -The bill of materials behind this build. Where there's more than one option, the **bold** one is what's actually in use; the rest are known-good equivalents. +The hand-maintained HAGR bill of materials has been replaced by **[Awesome Grow Room Parts](https://jaketherabbit.github.io/awesome-grow-room-parts/)**. -## Environmental control +The catalogue is the current source for: -### CO₂ injection +- searchable and filterable grow-room hardware +- observed pricing and vendor links +- deployment evidence and quality tiers +- I²C addresses and collision warnings +- calibration notes and documented failure modes +- scrubbed ESPHome examples +- complete build recipes with calculated totals +- DIY versus proprietary platform comparisons -- **[Growshop NZ CO₂ regulator + solenoid set](https://growshop.co.nz/products/co2regulatorsolenoidset)** — or any equivalent CO₂ solenoid + regulator. +The structured source data, safety guidance, and contribution workflow are in the **[Awesome Grow Room Parts repository](https://github.com/JakeTheRabbit/awesome-grow-room-parts)**. -### CO₂ sensing - -Any Sensirion SCD3x / SCD4x will do. Pick by form factor. - -| Sensor | Form | Source | -|---|---|---| -| SCD30 | Bare PCB | [DigiKey – Sensirion SCD30](https://www.digikey.co.nz/en/products/detail/sensirion-ag/SCD30/8445334) | -| SCD40 | M5Stack Grove unit | [M5Stack – CO₂ unit (SCD40)](https://shop.m5stack.com/products/co2-unit-with-temperature-and-humidity-sensor-scd40) | -| **SCD41** | M5Stack Grove unit | [M5Stack – CO₂L unit (SCD41)](https://shop.m5stack.com/products/co2l-unit-with-temperature-and-humidity-sensor-scd41) | - -### Smart plugs (HA-controllable) - -Any Tuya or TP-Link Kasa works. In use: **[TP-Link Kasa KP303 multi-plug](https://www.pbtech.co.nz/product/SURTPL3020/TP-Link-Kasa-KP303-Smart-Wi-Fi-Surge-Strip-3-x-Out)**. - -## Substrate sensing - -- **TEROS-12** or a compatible SDI-12 sensor — see [`teros-12/Readme.md`](teros-12/Readme.md) for wiring, the ESP32 sketch, and calibration. -- **THC-S soil sensor** — the coco-coir-calibrated pwEC template lives in [`esphome/THC-S Home Assistant Template Sensors calibrated for Coco coir`](esphome/THC-S%20Home%20Assistant%20Template%20Sensors%20calibrated%20for%20Coco%20coir). -- **Recommended for new builds:** [Chill-Division SDI-12 substrate sensor](https://github.com/Chill-Division/sdi12-substrate-sensor) — calibrated and auto-discovers over MQTT, so you skip the whole calibration hassle. - -## Fertigation - -- **Atlas Scientific EZO modules** — pH, EC, RTD probes for reservoir and batch-tank monitoring. See [`esphome/atlas_wifi_hydroponics_kit.yaml`](esphome/atlas_wifi_hydroponics_kit.yaml). -- **Peristaltic pumps** — driven from an ESPPoE relay/PWM. See [`esphome/espoe_peristaltic_pumps.yaml`](esphome/espoe_peristaltic_pumps.yaml). -- **Ultrasonic distance sensor** for tank level — see [`esphome/m5stack-dial-tank-monitor.yaml`](esphome/m5stack-dial-tank-monitor.yaml) for the M5Stack Dial readout. -- **Load cell + HX711** for CO₂ cylinder weight — see [`esphome/m5stack-dial-scales-co2-tank.yaml`](esphome/m5stack-dial-scales-co2-tank.yaml). - -## Microcontrollers and host boards - -- **M5Stack Atom / Atom S3 Lite / Atom Lite** — compact ESP32 boards with Grove ports for plug-and-play sensors. -- **M5Stack ESPPoE** — ESP32 with PoE for permanent installs where you don't want to deal with flaky WiFi. -- **M5Stack AirQ** — purpose-built air-quality node. -- **M5Stack Dial** — round display + rotary encoder, good for at-tank readouts. - -Most of the sensors here come from the [M5Stack sensor catalogue](https://shop.m5stack.com/collections/m5-sensor). - -## Optical / thermal - -- **MLX90614** (single-pixel IR) — direct leaf-surface temperature for leaf-VPD. See [`esphome/thermal_camera_leaf_temp.yaml`](esphome/thermal_camera_leaf_temp.yaml). -- **MLX90640** (32 × 24 thermal array) — canopy temperature mapping. See [`esphome/espatom_mlx90640.yaml`](esphome/espatom_mlx90640.yaml). - -## Lighting - -- **PWM-dimmable LED drivers** (0-10 V or PWM input) — wire the M5 PWM unit in place of the potentiometer. See [`esphome/pwm_led_lights.yaml`](esphome/pwm_led_lights.yaml). +HAGR's field configs remain available in [`esphome/`](esphome/) for existing installations and implementation reference. New builds should choose hardware in the catalogue first, then follow the linked maintained firmware or recipe. diff --git a/Packages/CropSteering/README.md b/Packages/CropSteering/README.md new file mode 100644 index 0000000..658fea3 --- /dev/null +++ b/Packages/CropSteering/README.md @@ -0,0 +1,10 @@ +# Legacy crop-steering package + +This Home Assistant package remains available for existing HAGR installations and as an implementation reference. + +For new installations use: + +1. **[HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy)** for the custom integration, room and zone configuration, sensor fusion, and Home Assistant entities. +2. **[f2-control](https://github.com/JakeTheRabbit/f2-control)** for the one-click Home Assistant add-on that runs the P0-P3 control engine, safety gates, hardware sequencing, and dashboards. + +The YAML files in this directory are not being removed, so existing links, forks, and installations continue to work. The original detailed guide is [`../ReadMe.MD`](../ReadMe.MD). diff --git a/Packages/ReadMe.MD b/Packages/ReadMe.MD index 1c30c11..a0def79 100644 --- a/Packages/ReadMe.MD +++ b/Packages/ReadMe.MD @@ -1,5 +1,8 @@ # Home Assistant Advanced Crop Steering Package +> [!IMPORTANT] +> **Legacy package:** retained for existing HAGR installations and reference. For new installs use [HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy) with the one-click [f2-control Home Assistant add-on](https://github.com/JakeTheRabbit/f2-control). The maintained controller adds multi-zone isolation, sensor fusion, fail-closed hardware checks, UI setup, and current dashboards. + This package implements a dynamic, four-phase crop steering system for hydroponic setups within Home Assistant. It aims to optimize irrigation based on Volumetric Water Content (VWC), Electrical Conductivity (EC), time, and user-defined growth strategies (Vegetative vs. Generative). ## Core Principles diff --git a/README.md b/README.md index a54b283..a9d6689 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ A running, lived-in Home Assistant build for cannabis grow rooms. VPD-aware climate control, four-phase crop steering, automated batch-tank dosing, PWM-dimmable LEDs, ESPHome sensors everywhere, and consolidated alerting. It's also the front door to a wider set of related repos — controllers, calculators, sensor firmware, training material, infrastructure bits. +> [!IMPORTANT] +> **HAGR is the ecosystem entry point and implementation archive.** Start with the maintained project for the job, then use the configs here as field-tested reference material. + +| What you need | Current home | +|---|---| +| Parts, prices, compatibility, wiring notes, and complete BOMs | **[Awesome Grow Room Parts](https://jaketherabbit.github.io/awesome-grow-room-parts/)** | +| Crop-steering control for Home Assistant | **[HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy)** + **[f2-control](https://github.com/JakeTheRabbit/f2-control)** | +| Athena feed, foliar, stock-tank, and pH calculations | **[Athena Grow Calculator](https://jaketherabbit.github.io/Athena-Batch-Tank-Nutrient-Calculator/)** | +| Evidence-linked cultivation guides | **[The Cannabis White Papers](https://jaketherabbit.github.io/cannabis-white-papers/)** | + Fertigation control dashboard --- @@ -107,7 +117,7 @@ homeassistant: | Folder | What's inside | |---|---| -| [`Packages/CropSteering/`](Packages/CropSteering/) | A four-phase (P0/P1/P2/P3) crop-steering package — input helpers, template sensors, automations, and a long user guide. Start with [`Packages/ReadMe.MD`](Packages/ReadMe.MD) and [`crop_steering_installation_guide_improved.md`](Packages/CropSteering/crop_steering_installation_guide_improved.md). | +| [`Packages/CropSteering/`](Packages/CropSteering/) | Legacy four-phase (P0/P1/P2/P3) crop-steering package, retained for existing installs and reference. **For new installs use [HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy) with the [f2-control add-on](https://github.com/JakeTheRabbit/f2-control).** | Two standalone YAMLs sit at the repo root and can be `!include`d into your own setup: @@ -123,7 +133,7 @@ Device YAMLs for the sensor and actuator nodes used in the build. Each file's he | Config | Device | What it does | |---|---|---| | [`CO2_Sensor_espatoms3.yaml`](esphome/CO2_Sensor_espatoms3.yaml) | [M5Stack Atom S3 Lite](https://shop.m5stack.com/products/atoms3-lite-esp32s3-dev-kit) + [SCD41](https://shop.m5stack.com/products/co2l-unit-with-temperature-and-humidity-sensor-scd41) (Grove) | Roaming CO₂, temp, RH, VPD. | -| [`SCD4x_m5stack_ESPOE.yaml`](esphome/SCD4x_m5stack_ESPOE.yaml) | [M5Stack ESPPoE](https://shop.m5stack.com/products/m5stack-atom-poe-kit-with-w5500-hy601742e) + [SCD41](https://shop.m5stack.com/products/co2l-unit-with-temperature-and-humidity-sensor-scd41) | PoE-powered CO₂ sensor with VPD, daily min/max, and CO₂ alerts as template sensors. | +| [`SCD4x_m5stack_ESPOE_WiFi.yaml`](esphome/SCD4x_m5stack_ESPOE_WiFi.yaml) | [M5Stack ESPPoE](https://shop.m5stack.com/products/m5stack-atom-poe-kit-with-w5500-hy601742e) + [SCD41](https://shop.m5stack.com/products/co2l-unit-with-temperature-and-humidity-sensor-scd41) | PoE-powered CO₂ sensor with VPD, daily min/max, and CO₂ alerts as template sensors. | | [`esphome_m5stack_scd41.yaml`](esphome/esphome_m5stack_scd41.yaml) | [M5Stack Atom Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit) + [SCD41](https://shop.m5stack.com/products/co2l-unit-with-temperature-and-humidity-sensor-scd41) | Compact CO₂ + environment monitor. | | [`m5Stack_AirQ.yaml`](esphome/m5Stack_AirQ.yaml) | [M5Stack AirQ](https://shop.m5stack.com/products/atomic-airq-kit-w-co2-tvoc-eco2) | Dual CO₂ sensors with auto-calibration, PM, RH, temperature. | | [`m5stack-dial-tank-monitor.yaml`](esphome/m5stack-dial-tank-monitor.yaml) ([README](esphome/m5stack-dial-tank-monitor-README.md)) | [M5Stack Dial](https://shop.m5stack.com/products/m5stack-dial-esp32-s3-smart-rotary-knob-w-1-28-round-touch-screen) + [ultrasonic](https://shop.m5stack.com/products/i2c-ultrasonic-distance-unit-rcwl-9620) | Tank water level — distance and percentage, displayed on the dial mounted outside the tank. | @@ -134,8 +144,8 @@ Device YAMLs for the sensor and actuator nodes used in the build. Each file's he | [`atlas_wifi_hydroponics_kit.yaml`](esphome/atlas_wifi_hydroponics_kit.yaml) | [Atlas Scientific EZO](https://atlas-scientific.com/embedded-solutions/) hydroponics kit on [ESP32](https://www.espressif.com/en/products/socs/esp32) | pH, EC, and RTD (temperature) from [Atlas Scientific EZO modules](https://atlas-scientific.com/probes/). | | [`espoe_peristaltic_pumps.yaml`](esphome/espoe_peristaltic_pumps.yaml) | [M5Stack ESPPoE](https://shop.m5stack.com/products/m5stack-atom-poe-kit-with-w5500-hy601742e) + relay/PWM | Peristaltic pump control for automated dosing. | | [`m5Stack ESPPOE PB HUB 2CH-DualButton-BLEproxy.yaml`](esphome/m5Stack%20ESPPOE%20PB%20HUB%202CH-DualButton-BLEproxy.yaml) | [M5Stack ESPPoE](https://shop.m5stack.com/products/m5stack-atom-poe-kit-with-w5500-hy601742e) + [PB Hub](https://shop.m5stack.com/products/pbhub-unit-v1-1) | Two-channel switch / dual-button with BLE proxy. | -| [`pwm_led_lights.yaml`](esphome/pwm_led_lights.yaml) | [M5Stack Atom Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit) + [PWM unit](https://shop.m5stack.com/products/pwm-unit) | Dim a 0-10 V or PWM LED driver as a native HA `light` entity. Wired in place of the potentiometer. | -| [`espatom_mlx90640.yaml`](esphome/espatom_mlx90640.yaml) | [M5Stack Atom Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit) + [MLX90640](https://shop.m5stack.com/products/thermal2-unit-mlx90640) | 32 × 24 thermal IR array for canopy temperature mapping. | +| [`pwm_led_lights.yaml`](esphome/pwm_led_lights.yaml) | [M5Stack Atom Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit) + [Atom PWM](https://docs.m5stack.com/en/atom/atom_pwm) | Legacy low-voltage PWM example. Verify that the exact LED driver accepts non-isolated, common-ground PWM before connecting it; the M5Stack unit is not an isolated 0-10 V interface. | +| [`espatom_mlx90640.yaml`](esphome/espatom_mlx90640.yaml) | [M5Stack Atom Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit) + [MLX90640](https://shop.m5stack.com/products/thermal2-unit-mlx90640) | Legacy 32 × 24 thermal IR config. New installs should use the maintained [esphome-m5-thermal2 component](https://github.com/JakeTheRabbit/esphome-m5-thermal2). | | [`thermal_camera_leaf_temp.yaml`](esphome/thermal_camera_leaf_temp.yaml) | [M5Stack Atom Lite](https://shop.m5stack.com/products/atom-lite-esp32-development-kit) + [MLX90614](https://shop.m5stack.com/products/mini-temperature-unit-mlx90614) | Single-pixel IR for direct leaf-surface temperature. Feeds the leaf-VPD calculation. | | [`THC-S Home Assistant Template Sensors calibrated for Coco coir`](esphome/THC-S%20Home%20Assistant%20Template%20Sensors%20calibrated%20for%20Coco%20coir) | HA template (not ESPHome) | Coco-coir-calibrated pwEC formula for the [THC-S soil sensor](https://github.com/kromadg/soil-sensor). | | [`secrets.yaml.example`](esphome/secrets.yaml.example) | — | Template for `secrets.yaml`. Copy and fill in WiFi credentials, API encryption key, and OTA password. | @@ -177,42 +187,51 @@ Path: [`growingSOPs/`](growingSOPs/) | File | What it does | |---|---| | [`automated_batch_tank.md`](automated_batch_tank.md) | System diagram and the full automation for batch-tank fill and dose. | -| [`athena.html`](athena.html) | Standalone single-file Athena Pro Line batch-tank calculator. The hosted version lives at [`batch_tank_calculator`](https://github.com/JakeTheRabbit/batch_tank_calculator). | -| [`crop_steering_package.yaml`](crop_steering_package.yaml) | Earlier single-file crop-steering snapshot. For new installs use [`Packages/CropSteering/`](Packages/CropSteering/). | +| [`athena.html`](athena.html) | Legacy standalone Athena Pro Line calculator. Use the current [Athena Grow Calculator](https://jaketherabbit.github.io/Athena-Batch-Tank-Nutrient-Calculator/) or its [source repository](https://github.com/JakeTheRabbit/Athena-Batch-Tank-Nutrient-Calculator). | +| [`crop_steering_package.yaml`](crop_steering_package.yaml) | Earlier single-file crop-steering snapshot. For new installs use [HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy) with [f2-control](https://github.com/JakeTheRabbit/f2-control). | | [`vpd_configuration.yaml`](vpd_configuration.yaml) | Leaf and air VPD template sensors. | -| [`PARTS_LIST.md`](PARTS_LIST.md) | Bill of materials — sensors, valves, plugs, microcontrollers, drivers. | +| [`PARTS_LIST.md`](PARTS_LIST.md) | Permanent signpost to the maintained [Awesome Grow Room Parts catalogue](https://jaketherabbit.github.io/awesome-grow-room-parts/). | --- ## Related repositories -The wider system, broken into focused repos. Some are reference implementations, some are the production code, some are companion tools. +The wider system, broken into focused repos. These are the maintained destinations; HAGR keeps older configs in place so existing links and installations do not break. + +### Hardware catalogue and device firmware + +| Repo | What it is | +|---|---| +| **[Awesome Grow Room Parts](https://github.com/JakeTheRabbit/awesome-grow-room-parts)** · **[live catalogue](https://jaketherabbit.github.io/awesome-grow-room-parts/)** | The canonical hardware catalogue. Searchable parts, observed prices, evidence tiers, I²C collision planning, ESPHome examples, safety notes, and complete build recipes. Supersedes the hand-maintained `PARTS_LIST.md`. | +| **[TDR-Sensor](https://github.com/JakeTheRabbit/TDR-Sensor)** | Maintained TEROS-12 and compatible SDI-12 substrate-sensor firmware, calibration, analytics, dashboards, and ready-to-flash ESPHome configs. Supersedes `teros-12/` for new installs. | +| **[Growlink TerraLink for ESPHome](https://github.com/JakeTheRabbit/Grownlink-Terralink-Substrate-Sensor-for-ESP-Home)** | Dedicated TerraLink wiring, calibration, deployment notes, and ESPHome configuration. Supersedes the standalone `esphome/terralink.yaml` guide. | +| **[esphome-m5-thermal2](https://github.com/JakeTheRabbit/esphome-m5-thermal2)** | Maintained external component and ready-to-flash configs for the M5Stack Unit Thermal2. Use this instead of the legacy generic MLX90640 config for that packaged unit. | ### Crop steering and irrigation | Repo | What it is | |---|---| -| **[HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy)** | A proper multi-zone (1-6) crop-steering controller for Home Assistant. Custom integration plus AppDaemon modules. Phase state machine, VWC/EC-driven irrigation, full dashboards. The most actively developed crop-steering setup in this ecosystem. | +| **[HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy)** | The maintained multi-room, multi-zone crop-steering controller for Home Assistant. Its custom integration handles configuration and sensor fusion; f2-control owns phase logic, hardware sequencing, safety gates, and operator dashboards. | +| **[f2-control](https://github.com/JakeTheRabbit/f2-control)** | One-click Home Assistant add-on repository for the controller engine used with HA-Irrigation-Strategy. Install the integration first, then add this URL to the Home Assistant Add-on Store. | | **[open-crop-steering](https://github.com/JakeTheRabbit/open-crop-steering)** | A Home Assistant add-on (with a Docker fallback) that turns cultivation recipes into versioned, immutable plans. Adds an AI runtime layer bounded by hard guardrails, and produces tamper-evident audit records suitable for regulated facilities. v0.1, in development. | -| **[irrigation_unlimited](https://github.com/JakeTheRabbit/irrigation_unlimited)** | Fork of the Irrigation Unlimited HA integration (rgc99), pinned for the irrigation stack. | ### Calculators and tools | Repo | What it is | |---|---| -| **[batch_tank_calculator](https://github.com/JakeTheRabbit/batch_tank_calculator)** | Athena Pro Line batch-tank nutrient calculator — metric and imperial, scales to any reservoir volume, persists calculations to local storage, exports to CSV. **[Live site](https://jaketherabbit.github.io/Athena-Batch-Tank-Nutrient-Calculator/)**. | +| **[Athena-Batch-Tank-Nutrient-Calculator](https://github.com/JakeTheRabbit/Athena-Batch-Tank-Nutrient-Calculator)** | Current Athena calculator for feed reservoirs, foliar sprays, stock concentrates, tank life, and pH correction. Self-hosted and phone-friendly. **[Live site](https://jaketherabbit.github.io/Athena-Batch-Tank-Nutrient-Calculator/)**. | +| **[cannabis-white-papers](https://github.com/JakeTheRabbit/cannabis-white-papers)** | Maintained evidence-linked cultivation library covering propagation, crop steering, environment, plant health, irrigation, and facility quality. **[Read online](https://jaketherabbit.github.io/cannabis-white-papers/)**. | | **[cannabis-grow-room-levers](https://github.com/JakeTheRabbit/cannabis-grow-room-levers)** | A systems-thinking field guide — the grow room treated as a coupled energy / moisture / carbon / salt / biology system. Eleven control levers, four balances, a lever-interaction matrix, a diagnostic chain, six common failure modes. Single self-contained HTML. **[Live site](https://jaketherabbit.github.io/cannabis-grow-room-levers/)**. | | **[Grow Room Training](https://github.com/JakeTheRabbit/grow-room-training)** | Training material distilled from the levers framework — a visual manual, a 15-chapter textbook with auto-scored MCQs, printable field cards, and an LLM-agent playbook for autonomous HA control. | -| **[cultivation-intelligence](https://github.com/JakeTheRabbit/cultivation-intelligence)** | AI cultivation intelligence platform — keeps every sensor reading and irrigation event in a time-series history, with an LLM advisory layer on top. | -### Infrastructure and integrations +### Dashboards and grow records | Repo | What it is | |---|---| -| **[mosquitto-bridge-setup](https://github.com/JakeTheRabbit/mosquitto-bridge-setup)** | Mosquitto bridge configuration for dual-boot Windows/Linux relaying. Useful when a no-auth nutrient doser has to talk to authenticated HA MQTT. | -| **[visitors_repo](https://github.com/JakeTheRabbit/visitors_repo)** | A small visitor sign-in / sign-out tracker for HA. Built to be quick and to not get tangled up when visitors forget to sign out. | -| **[rosinlab](https://github.com/JakeTheRabbit/rosinlab)** | Local-first rosin press and sift logging web app. Embeds inside Home Assistant via an iframe card. Compare mode plays up to three press videos side by side with parameters. | -| **[TDR-Sensor](https://github.com/JakeTheRabbit/TDR-Sensor)** | The newer dedicated repo for TEROS-12 and compatible SDI-12 substrate sensor builds. Supersedes the [`teros-12/`](teros-12/) folder here. | +| **[plant-state-dashboard](https://github.com/JakeTheRabbit/plant-state-dashboard)** | Field guide, interactive demo, and reusable spec for dashboards that lead with plant state, leading indicators, and bounded advisories instead of raw graphs. | +| **[GrowScope](https://github.com/JakeTheRabbit/growscope)** | Home Assistant grow registry, automatic timelapse, full-resolution sensor history, recipe overlays, journals, and side-by-side grow replay. | +| **[grow-sensor-card](https://github.com/JakeTheRabbit/grow-sensor-card)** | Compact Home Assistant card for displaying grow-room sensor state and thresholds. | +| **[cultivation-intelligence](https://github.com/JakeTheRabbit/cultivation-intelligence)** | AI cultivation intelligence platform — keeps every sensor reading and irrigation event in a time-series history, with an LLM advisory layer on top. | --- @@ -223,15 +242,15 @@ The stack covers: - **CO₂ control** — day/night setpoints, hysteresis, safety auto-off, low and high alerting, and an option to auto-dim lights when CO₂ is sustained low. See [`blueprints/co2_control_and_alerts.yaml`](blueprints/co2_control_and_alerts.yaml). - **VPD calculations** — live air VPD and leaf VPD via [`vpd_configuration.yaml`](vpd_configuration.yaml). Leaf VPD uses an [MLX90614](https://shop.m5stack.com/products/mini-temperature-unit-mlx90614) IR temperature reading. - **Automatic VPD control** — drives a humidifier or dehumidifier to hold leaf VPD steady through temperature and RH drift. -- **Crop steering and irrigation** — full four-phase (P0/P1/P2/P3) package in [`Packages/CropSteering/`](Packages/CropSteering/). For larger multi-zone setups use [HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy). -- **Substrate sensing** — [TEROS-12](https://www.metergroup.com/en/meter-environment/products/teros-12) and [SDI-12](https://sdi-12.org/) sensors talking to an [ESP32](https://www.espressif.com/en/products/socs/esp32), giving you VWC and pore-water EC. See [`teros-12/`](teros-12/) and [`esphome/teros-12-sdi-12.yaml`](esphome/teros-12-sdi-12.yaml). If you want something that just works, use [Chill-Division/sdi12-substrate-sensor](https://github.com/Chill-Division/sdi12-substrate-sensor) — calibrated and auto-discovers over MQTT. +- **Crop steering and irrigation** — the original four-phase (P0/P1/P2/P3) package remains in [`Packages/CropSteering/`](Packages/CropSteering/) for existing installs. New installs should use [HA-Irrigation-Strategy](https://github.com/JakeTheRabbit/HA-Irrigation-Strategy) with [f2-control](https://github.com/JakeTheRabbit/f2-control). +- **Substrate sensing** — HAGR retains its original TEROS-12, TerraLink, and SDI-12 configs. For current firmware use [TDR-Sensor](https://github.com/JakeTheRabbit/TDR-Sensor) or the dedicated [TerraLink ESPHome repository](https://github.com/JakeTheRabbit/Grownlink-Terralink-Substrate-Sensor-for-ESP-Home), and compare probe options in [Awesome Grow Room Parts](https://jaketherabbit.github.io/awesome-grow-room-parts/). - **Nutrient dosing** — peristaltic pumps run from an [M5Stack ESPPoE](https://shop.m5stack.com/products/m5stack-atom-poe-kit-with-w5500-hy601742e), automated batch-tank fill, multi-part [Athena Pro Line](https://athenaag.com/) dosing, then a post-dose pH/EC verification through [Atlas Scientific EZO](https://atlas-scientific.com/probes/) probes. See [`automated_batch_tank.md`](automated_batch_tank.md) and [`automations/refill_tank_triggered_by_low_level.yaml`](automations/refill_tank_triggered_by_low_level.yaml). -- **Lighting** — 0-10 V or PWM-dimmable LED drivers exposed as native HA `light` entities through the [M5Stack PWM unit](https://shop.m5stack.com/products/pwm-unit). See [`esphome/pwm_led_lights.yaml`](esphome/pwm_led_lights.yaml). A linear PPFD acclimation ramp lives in [`automations/light_acclimation.yaml`](automations/light_acclimation.yaml). +- **Lighting** — compatible low-voltage PWM drivers exposed as native HA `light` entities through the [M5Stack Atom PWM](https://docs.m5stack.com/en/atom/atom_pwm). This is not an isolated 0-10 V interface; verify the exact driver's control input first. See [`esphome/pwm_led_lights.yaml`](esphome/pwm_led_lights.yaml). A linear PPFD acclimation ramp lives in [`automations/light_acclimation.yaml`](automations/light_acclimation.yaml). - **Tank level monitoring** — ultrasonic distance sensor on the tank lid with the readout on an [M5Stack Dial](https://shop.m5stack.com/products/m5stack-dial-esp32-s3-smart-rotary-knob-w-1-28-round-touch-screen) mounted outside the tank. See [`esphome/m5stack-dial-tank-monitor.yaml`](esphome/m5stack-dial-tank-monitor.yaml). - **Notifications** — consolidated environmental alerts with day/night thresholds, mute and pause actions, and an optional AI summary line. See [`addons/appdaemon/grow_monitor/`](addons/appdaemon/grow_monitor/). - **Fan speed control** — [AC Infinity](https://acinfinity.com/) fans driven from an external temp sensor. See [`automations/Adjust ACI Fan Speed External Sensor.md`](automations/Adjust%20ACI%20Fan%20Speed%20External%20Sensor.md). - **AC control** — IR-blaster control of a wall-mount split AC with PID, holding the room to about ±0.2 °C with regular hardware. See HA's [Broadlink](https://www.home-assistant.io/integrations/broadlink) and [SmartIR](https://github.com/smartHomeHub/SmartIR) integrations. -- **Thermal canopy temperature** — [ESP32](https://www.espressif.com/en/products/socs/esp32) with an [MLX90640](https://shop.m5stack.com/products/thermal2-unit-mlx90640) 32 × 24 thermal array, or an [MLX90614](https://shop.m5stack.com/products/mini-temperature-unit-mlx90614) single-pixel for spot leaf temp. See [`esphome/espatom_mlx90640.yaml`](esphome/espatom_mlx90640.yaml) and [`esphome/thermal_camera_leaf_temp.yaml`](esphome/thermal_camera_leaf_temp.yaml). +- **Thermal canopy temperature** — [ESP32](https://www.espressif.com/en/products/socs/esp32) with an [MLX90640](https://shop.m5stack.com/products/thermal2-unit-mlx90640) 32 × 24 thermal array, or an [MLX90614](https://shop.m5stack.com/products/mini-temperature-unit-mlx90614) single-pixel for spot leaf temp. For the packaged M5Stack Unit Thermal2 use [esphome-m5-thermal2](https://github.com/JakeTheRabbit/esphome-m5-thermal2); the older configs remain under [`esphome/`](esphome/). --- @@ -460,6 +479,7 @@ Integrations you actually have to set up — `default_config` auto-loaders aren' ### Sensors and firmware +- [Awesome Grow Room Parts](https://jaketherabbit.github.io/awesome-grow-room-parts/) — maintained catalogue, compatibility data, evidence tiers, build recipes, and current purchasing links. - [Chill-Division/M5Stack-ESPHome](https://github.com/Chill-Division/M5Stack-ESPHome) — M5Stack ESPHome configurations for indoor gardening. - [Chill-Division/sdi12-substrate-sensor](https://github.com/Chill-Division/sdi12-substrate-sensor) — Calibrated SDI-12 substrate sensor with MQTT auto-discovery. Use this rather than rolling your own TEROS-12. - [kromadg/soil-sensor](https://github.com/kromadg/soil-sensor) — THC-S soil-sensor reference. diff --git a/esphome/README.md b/esphome/README.md index 429c22f..864353a 100644 --- a/esphome/README.md +++ b/esphome/README.md @@ -2,6 +2,9 @@ Device firmware definitions for the sensor and actuator nodes used in the build. +> [!NOTE] +> These are field configs retained for existing installations and reference. Choose hardware and current firmware through **[Awesome Grow Room Parts](https://jaketherabbit.github.io/awesome-grow-room-parts/)** first. Dedicated successor repos are linked below where they exist. + > **Before you flash:** copy [`secrets.yaml.example`](secrets.yaml.example) to `secrets.yaml` and fill in your WiFi creds, API encryption key, and OTA password. Some configs in this directory still have those values inline — swap them for `!secret` references before flashing anything for real. [ESPHome secrets docs](https://esphome.io/guides/faq.html#how-do-i-use-secrets-passwords-in-yaml). ## Environmental sensing @@ -9,27 +12,27 @@ Device firmware definitions for the sensor and actuator nodes used in the build. | Config | Hardware | What it measures | |---|---|---| | [`CO2_Sensor_espatoms3.yaml`](CO2_Sensor_espatoms3.yaml) | M5Stack Atom S3 Lite + SCD41 (Grove) | CO2, temperature, RH, VPD. Roaming/handheld form factor. | -| [`SCD4x_m5stack_ESPOE.yaml`](SCD4x_m5stack_ESPOE.yaml) | M5Stack ESPPoE + SCD41 | CO2, temperature, RH on PoE. Daily min/max template sensors + CO2 alerts. | +| [`SCD4x_m5stack_ESPOE_WiFi.yaml`](SCD4x_m5stack_ESPOE_WiFi.yaml) | M5Stack ESPPoE + SCD41 | CO2, temperature, RH on PoE. Daily min/max template sensors + CO2 alerts. | | [`esphome_m5stack_scd41.yaml`](esphome_m5stack_scd41.yaml) | M5Stack Atom + SCD41 | Compact CO2 + temperature + RH monitor. Self-documented header. | | [`m5Stack_AirQ.yaml`](m5Stack_AirQ.yaml) | M5Stack AirQ | Dual CO2 sensors with auto-calibration, PM (1/2.5/10), temperature, RH. | | [`thermal_camera_leaf_temp.yaml`](thermal_camera_leaf_temp.yaml) | M5Stack Atom + MLX90614 | Single-pixel IR for direct leaf-surface temperature — input to the leaf-VPD calculation. | -| [`espatom_mlx90640.yaml`](espatom_mlx90640.yaml) | M5Stack Atom + MLX90640 | 32 × 24 thermal IR array for canopy temperature mapping. | +| [`espatom_mlx90640.yaml`](espatom_mlx90640.yaml) | M5Stack Atom + MLX90640 | Legacy 32 × 24 thermal config. For M5Stack Unit Thermal2 use [esphome-m5-thermal2](https://github.com/JakeTheRabbit/esphome-m5-thermal2). | ## Substrate and fertigation sensing | Config | Hardware | What it measures | |---|---|---| -| [`teros-12-sdi-12.yaml`](teros-12-sdi-12.yaml) | M5Stack Atom (ESP32) + SDI-12 interface | VWC, pore-water EC, substrate temperature from a TEROS-12 / compatible SDI-12 sensor. Calibration + pwEC math in templates. | +| [`teros-12-sdi-12.yaml`](teros-12-sdi-12.yaml) | M5Stack Atom (ESP32) + SDI-12 interface | Legacy TEROS-12 config. For ready-to-flash boards, calibration, analytics, and dashboards use [TDR-Sensor](https://github.com/JakeTheRabbit/TDR-Sensor). | | [`m5stack_dial_ec_tdr_sdi12.yaml`](m5stack_dial_ec_tdr_sdi12.yaml) | M5Stack Dial + SDI-12 | Multi-sensor SDI-12 logger with a dial display. | | [`atlas_wifi_hydroponics_kit.yaml`](atlas_wifi_hydroponics_kit.yaml) | EZO ESP32 hydroponics kit (Atlas Scientific) | pH, EC, RTD (temperature) for the reservoir or batch tank. | -| [`terralink.yaml`](terralink.yaml) | Growlink Terralink + M5Atom Lite | Repurposes a Terralink controller as an ESPHome node. | +| [`terralink.yaml`](terralink.yaml) | Growlink TerraLink + M5Atom Lite | Legacy config. Use the dedicated [Growlink TerraLink ESPHome repository](https://github.com/JakeTheRabbit/Grownlink-Terralink-Substrate-Sensor-for-ESP-Home) for wiring, calibration, and deployment guidance. | | [`THC-S Home Assistant Template Sensors calibrated for Coco coir`](THC-S%20Home%20Assistant%20Template%20Sensors%20calibrated%20for%20Coco%20coir) | (HA template, not ESPHome) | Coco-coir-calibrated pwEC formula for the THC-S soil sensor. Paste into `templates:` in HA. | ## Lighting and actuation | Config | Hardware | What it does | |---|---|---| -| [`pwm_led_lights.yaml`](pwm_led_lights.yaml) | M5Stack Atom + M5 PWM unit | Replaces the potentiometer on a 0-10 V / PWM LED grow driver with HA-controllable PWM. Light is exposed as a native HA `light` entity. | +| [`pwm_led_lights.yaml`](pwm_led_lights.yaml) | M5Stack Atom + [Atom PWM](https://docs.m5stack.com/en/atom/atom_pwm) | Legacy low-voltage PWM example. Verify that the exact driver accepts non-isolated, common-ground PWM; this unit is not an isolated 0-10 V interface. | | [`espoe_peristaltic_pumps.yaml`](espoe_peristaltic_pumps.yaml) | M5Stack ESPPoE + relay/PWM channel | Peristaltic pump control for automated nutrient dosing. | | [`m5Stack ESPPOE PB HUB 2CH-DualButton-BLEproxy.yaml`](m5Stack%20ESPPOE%20PB%20HUB%202CH-DualButton-BLEproxy.yaml) | M5Stack ESPPoE + PB Hub | Two-channel switch + dual physical button with BLE proxy. Useful as a multi-purpose plant-room node. | diff --git a/growingSOPs/README.md b/growingSOPs/README.md index 35666fa..33a5505 100644 --- a/growingSOPs/README.md +++ b/growingSOPs/README.md @@ -2,6 +2,9 @@ Standard operating procedures and reference material for indoor cannabis cultivation. Plain markdown, written for working growers. +> [!NOTE] +> These original notes remain for stable inbound links. The maintained, evidence-linked library is **[The Cannabis White Papers](https://jaketherabbit.github.io/cannabis-white-papers/)**, with current guides covering the same topics and a broader curriculum. + | Document | Topic | |---|---| | [`cloning.md`](cloning.md) | Cloning / propagation — substrate prep, cut handling, rooting conditions, transplant timing. | diff --git a/teros-12/Readme.md b/teros-12/Readme.md index 02d80b4..b02a88f 100644 --- a/teros-12/Readme.md +++ b/teros-12/Readme.md @@ -1,4 +1,5 @@ -# DEPRECATED: New version here: https://github.com/JakeTheRabbit/TDR-Sensor +> [!IMPORTANT] +> **Deprecated:** use the maintained [TDR-Sensor repository](https://github.com/JakeTheRabbit/TDR-Sensor) for new installs. Compare TEROS-12 and lower-cost probes in [Awesome Grow Room Parts](https://jaketherabbit.github.io/awesome-grow-room-parts/). This page remains for existing links and legacy MQTT installations. # TEROS-12 Soil Moisture Sensor with ESP32 and MQTT @@ -507,5 +508,5 @@ If you find any issues or have suggestions for improvements, please open an issu ## License -This project is open-source and available under the [MIT License](LICENSE). +This project is open-source and available under the [MIT License](../LICENSE).