Skip to content

Hardware: add Universal Robots arm setup tutorial#4988

Open
shannonbradshaw wants to merge 1 commit intoviamrobotics:mainfrom
shannonbradshaw:shannonbradshaw/ur-setup-tutorial
Open

Hardware: add Universal Robots arm setup tutorial#4988
shannonbradshaw wants to merge 1 commit intoviamrobotics:mainfrom
shannonbradshaw:shannonbradshaw/ur-setup-tutorial

Conversation

@shannonbradshaw
Copy link
Copy Markdown
Collaborator

Summary

  • Adds docs/hardware/tutorials/universal-robots.md, a full end-to-end setup guide for UR3e / UR5e / UR7e / UR20 arms: power-on, admin password, static IP on the pendant, enabling Security → Services (the silent-failure step new e-Series arms hit), Remote Control mode, dashboard port verification, Viam component configuration, and a troubleshooting catalog keyed to real failure modes.
  • Adds docs/hardware/tutorials/_index.md as the landing page for a new Hardware tutorials subsection, intended to hold step-by-step vendor-specific setup guides whose quirks don't fit the generic common-components/add-a-* pages.
  • Fixes a factual error in docs/hardware/common-components/add-an-arm.md: the arm-model search list claimed UR10e and UR16e are supported. The viam:universal-robots module actually supports UR3e, UR5e, UR7e, UR20. Updates the list and links the arm row to the new tutorial.

Why this page exists

Setting up a UR arm on Viam right now requires piecing together information from the module README (attributes only), the generic add-an-arm page (no UR specifics), and Universal Robots documentation (no Viam specifics). The failure modes are opaque: ping works while the Viam module reports "Failed to connect to UR dashboard" because Security → Services ships with Dashboard Server, Primary Client Interface, and RTDE disabled on new arms. Remote Control requires two separate toggles. The tutorial captures the full sequence so new users don't have to reverse-engineer it.

Test plan

  • Reviewer with a UR arm runs through the steps on a fresh compute machine and confirms the arm is controllable in the Viam CONTROL tab at the end.
  • Verify the Netlify deploy preview renders both new pages and the nav picks up the new Hardware → Tutorials subsection.
  • Verify the updated link in add-an-arm.md resolves to the new tutorial.

🤖 Generated with Claude Code

Covers the pendant and network steps that aren't anywhere in the
existing arm documentation or the viam:universal-robots module
README: admin password prompt, static IP, Security > Services (the
silent-failure step), Remote Control mode, dashboard port
verification, and component configuration.

Also fixes an incorrect claim in add-an-arm.md that the
universal-robots module supports UR10e and UR16e (it supports UR3e,
UR5e, UR7e, UR20), and links the arm row to the new tutorial.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 20, 2026

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit c32a2ba
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/69e69c0e915e0f00083b7254
😎 Deploy Preview https://deploy-preview-4988--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 41 (no change from production)
Accessibility: 99 (no change from production)
Best Practices: 92 (no change from production)
SEO: 89 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants