Skip to content

Console installation and SDK management

Overview and readiness

Open the host console. Overview combines SDK service state, internet/audio/Jetson summaries and host CPU/memory/disk meters. It offers SDK Start, Restart and Stop where relevant. Metrics arrive through queries and live events; an old cached metric or a working API is not proof the SDK is healthy.

Use readiness links to fix network/audio/device prerequisites before installation. The top bar and More menu also link to Robot UI and VS Code. Opening VS Code is a separate remote development capability, not documentation hosting.

First installation form

The HRSDK setup page appears when the SDK is not installed. Its major stages are:

  1. Readiness: inspect host preflight and use Check again after changes.
  2. Credentials: provide GitHub, AWS and FRPC access through the form and choose Validate and save. Credential-ready state determines which release metadata can be loaded.
  3. Identity/release: select operator, exact compatible SDK release, configuration choice and head/body settings presented by the form. Character/world are resolved through the current configuration/environment; inspect them after startup.
  4. Network/audio: select robot Ethernet interface; use Network Setup to configure DDS routing and Audio to select/test devices.
  5. Install: Save progress for a draft, or Install and start SDK when prerequisites and selections are ready.

Release rows marked incompatible cannot be selected in the UI. An unavailable Ethernet interface is shown rather than silently replaced. Installation returns a task; follow progress and logs. Do not run another installer concurrently because the browser stopped receiving updates.

Existing SDK page

When installed, HRSDK shows selected configuration, service controls, stack version, update state, release switch and container information. Check updates fetches relevant metadata; pull configurations, update containers, and switch release have different effects.

Changing robot head/body changes configuration selection. Auto-detection is useful but cannot replace correct calibration. Save intended changes and verify the resulting environment/runtime identity after restart.

Expand container details to inspect individual images/status and use single-container updates only when that is the intended maintenance operation. For a coherent release change, use the release workflow and verify all artifacts, including Unity assets.

Runtime credentials

The credential panel stages secret updates and explicit removals separately. File credentials can be entered through an editor and staged in the expected format. Staging is not final application: review the pending changes, save, then inspect configured status. Do not paste credentials into ordinary configuration fields, screenshots, documentation, or support logs.

A configured marker means a value/file exists according to the backend; it is not proof of a successful external provider call. Use the relevant provider's functional check afterward.

Task/error handling

The UI polls running tasks and also consumes events. A failed task should show its stage/error; retain its ID for diagnosis. Some actions invalidate cached summaries after completion. Wait for refreshed state before deciding that a switch failed or repeating it.

If release metadata cannot load, inspect credentials/network rather than selecting arbitrary local tags. If configuration pull would conflict with local changes, preserve those changes and reconcile them deliberately.

Sources: hr_system_console/frontend/src/pages/{OverviewPage.jsx,HrsdkSetup.jsx,HrsdkPage.jsx}, REST client, setup and HRSDK services. Installation guide and update/rollback guide.