Document module lifecycle states in machine status#5211
Open
btshrewsbury-viam wants to merge 1 commit into
Open
Document module lifecycle states in machine status#5211btshrewsbury-viam wants to merge 1 commit into
btshrewsbury-viam wants to merge 1 commit into
Conversation
Add a Module status states subsection to the module developer reference covering the ModuleStatus.State enum and its fields (state, last_updated, error, consecutive_failures) as reported by GetMachineStatus, plus a troubleshooting entry in the deploy guide for diagnosing a module that failed to start. Closes #5206
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
btshrewsbury-viam
marked this pull request as ready for review
July 15, 2026 16:42
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
2 participants
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.
Closes #5206.
What
Documents the new per-module lifecycle states surfaced through
GetMachineStatus(robot.v1.ModuleStatus), so users can tell whether a module downloaded, started, is running, or failed.Source: viamrobotics/rdk#6120 and viamrobotics/api#867.
Changes (additive only)
docs/build-modules/module-reference.md— new### Module status statessubsection under Module lifecycle (reference): theModuleStatus.Stateenum mapped to what the module process is doing, the accompanying fields (module_name,state,last_updated,error,consecutive_failures), a note distinguishing per-module state from the machine-level state, and a short diagnose-a-failed-module note.docs/build-modules/deploy-a-module.md— new Troubleshooting expand entry that points to the reference subsection for diagnosing a module that fails to start or keeps restarting.Notes
api#867proto diff (robot.v1.ModuleStatus.State):STATE_UNSPECIFIED,STATE_PENDING,STATE_STARTING,STATE_READY,STATE_UNHEALTHY,STATE_CLOSING. Uses the real enum names, not the announcement paraphrase.static/include/robot/apis/generated/robot.md) does not surfaceModuleStatus, so it was left untouched (no hand-edits to generated files).make build-prodnot run locally (coordinator builds serially); please verify the/reference/apis/robot/#getmachinestatusanchor resolves.