docs: honest capability disclosure (MQTT/temp-humidity are stubs), Related Repos - #2
Open
SuperInstance wants to merge 2 commits into
Open
docs: honest capability disclosure (MQTT/temp-humidity are stubs), Related Repos#2SuperInstance wants to merge 2 commits into
SuperInstance wants to merge 2 commits into
Conversation
added 2 commits
July 10, 2026 17:17
…Related Repos Up-to-date: the feature list overstated MQTT (PubSubClient is included but never instantiated; connect/publish/subscribe are stubbed) and temperature/ humidity reads (analogRead*0.1 placeholders). Converted the 'What This Gives You' pitch into a Status + Capabilities section with ✅/⚠️ honesty markers so readers know what actually runs on hardware. Fixed the misleading 'DHT22 on GPIO 23' Quick Start comment and the unverified '<100KB RAM' metric. Added a command reference and noted the CI/platformio test env. Inter-connective: added a Related Repos section linking plato-edge (the Plato runtime these shells report into), nexus-edge-runtime (heavier full-agent edge sibling), and vessel-bridge (shares the GPIO-to-fleet concern). Tone: replaced marketing-style feature list with plain, precise descriptions; kept real technical claims (12-bit ADC, mDNS .local registration, 14 tests).
…mples links The README audit that added honest MQTT/temp-humidity stub disclosures (both independently re-verified against source: connectMQTT() only sets a flag with PubSubClient commented out as a placeholder; temperature/ humidity reads are analogRead(pin) * 0.1, literally commented "Simulated conversion" in the source) also removed 3 real, existing sibling-repo links (openconstruct-jetson, plato-fleet, openconstruct-examples) from "How It Fits", replacing them with vaguer unlinked prose. Verified via `gh repo view` that all 3 are real, current repos accurately described by the original text. Restored them alongside the new Related Repos section (which keeps its own valid additions: plato-edge, nexus-edge-runtime, vessel-bridge).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation follow-up to PR#1. Found and disclosed 2 real, previously-uncaught overclaims, verified against actual source before trusting:
connectMQTT()only sets an internal flag (// This is a placeholder structure),publishStatus()/subscribeToCommands()are commented out. No MQTT messages are actually sent or received.readTemperatureSensor/readHumiditySensorreturnanalogRead(pin) * 0.1, literally commented// Simulated conversionin the source.Both marked⚠️ in a new "Capabilities" section distinguishing implemented vs. placeholder behavior.
A note on this PR's own history
An earlier version of this branch's diff (from the automated dispatch) removed 3 real, existing sibling-repo links (
openconstruct-jetson,plato-fleet,openconstruct-examples) while adding a new "Related Repos" section, replacing specific real references with vaguer unlinked prose. I verified viagh repo viewthat all 3 are real, current, accurately-described repos and restored them before opening this PR — the final diff keeps both the new Related Repos section (plato-edge, nexus-edge-runtime, vessel-bridge — also verified real) and the original OpenConstruct-ecosystem links.Independent verification (by me, before opening this PR)
src/OpenConstructESP32.cppdirectly (line-level:connectMQTT()~L133,readTemperatureSensor/readHumiditySensor~L216-224).gh repo view.Base is
production-round3-2026-07-10since this branch builds on top of that PR's work.