Skip to content

docs: refresh CO2 import notes + fix grow_monitor README formatting#5

Open
JakeTheRabbit wants to merge 1 commit into
mainfrom
docs/readme-refresh
Open

docs: refresh CO2 import notes + fix grow_monitor README formatting#5
JakeTheRabbit wants to merge 1 commit into
mainfrom
docs/readme-refresh

Conversation

@JakeTheRabbit

Copy link
Copy Markdown
Owner

Follow-up doc pass after the blueprint modernization (#4).

automations/co2_automation.MD — rewrite

It embedded a full, stale copy of the pre-rewrite CO₂ blueprint, including code that never worked (states('!input ...') — a literal !input inside a Jinja string) and a flow diagram of the old logic. That duplicate had drifted out of sync with the shipped blueprint.

  • Removed the inline blueprint copy; point to the canonical blueprints/co2_control_and_alerts.yaml instead (no more drift).
  • Accurate helper list, import steps, and an updated mermaid flow matching the new structure (day/night target → high-CO₂ safety → relay-stuck auto-off → low alert + dim → recovery restore → hysteresis control with high-lockout and fail-safes).
  • Added the 2024.10 interface-change note.

addons/appdaemon/grow_monitor/Readme.MD — formatting fix

Markdown structure had collapsed from step 3 onward — headings and numbered steps were swallowed into prose and code fences. Restored section headings, list structure, and code-fence languages. Content unchanged.

Reviewed, no change needed

README.md and blueprints/README.md were already updated in #4. automations/, addons/, esphome/, growingSOPs/, and Packages/ READMEs are accurate as-is. teros-12/ (deprecated → TDR-Sensor), the dial-monitor device doc, and the vendored ESP32-SDI12 lib README were intentionally left alone.

Verification

Code-fence balance checked (even) on both files; no !input/platform:/service:/strptime tokens remain in the CO₂ doc.

🤖 Generated with Claude Code

co2_automation.MD embedded a full, stale copy of the pre-rewrite CO2 blueprint —
including code that never worked (states('!input ...'), literal !input inside Jinja)
and a flow diagram of the old logic. Replaced the inline duplicate with a pointer to
the canonical blueprints/co2_control_and_alerts.yaml, an accurate helper list, an
updated mermaid flow (day/night target, high-CO2 safety, relay-stuck auto-off, low
alert + dim, recovery restore, hysteresis control with lockout/fail-safes), and the
2024.10 interface-change note.

grow_monitor/Readme.MD had its markdown structure collapsed from step 3 onward
(headings and numbered steps swallowed into prose and code fences). Restored the
section headings, list structure, and code-fence languages. Content unchanged.

Co-Authored-By: Claude Opus 4.8 <[email protected]>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9c4fb073de

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

co2_target_input: { name: CO₂ Target Input, min: 0, max: 5000, step: 1, unit_of_measurement: ppm, mode: box }
co2_tolerance_input: { name: CO₂ Tolerance Input, min: 0, max: 1000, step: 1, unit_of_measurement: ppm, mode: box }
co2_day_target_input: { name: Daytime CO₂ Target Input, min: 0, max: 5000, step: 1, unit_of_measurement: ppm, mode: box }
co2_night_target_input:{ name: Nighttime CO₂ Target Input,min: 0, max: 5000, step: 1, unit_of_measurement: ppm, mode: box }

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add the missing space before the flow mapping

When users copy this helper block into configuration.yaml, this line is not valid YAML because the key/value separator is written as co2_night_target_input:{ instead of co2_night_target_input: {. I verified the block fails to parse with Ruby/Psych (mapping values are not allowed in this context), so Home Assistant will reject the config before users can create the required helper.

Useful? React with 👍 / 👎.

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.

1 participant