Skip to content
R2Kernel Runtime Kernel for Robotics v1.0.0rc1
R2Kernel Runtime Kernel for Robotics v1.0.0rc1

    Quickstart

    Use this page for the first run after installing R2Kernel. The goal is simple. confirm the installed runtime, prepare your Python environment, open the local Web Console, and choose the next path.

    1. Install R2Kernel

    Complete Installation first.

    The default install prefix is this.

    /opt/r2kernel

    Default install output includes the following.

    • runtime under /opt/r2kernel/runtime
    • SDK payloads under /opt/r2kernel/sdk
    • tutorials under /opt/r2kernel/tutorials
    • benchmarks under /opt/r2kernel/benchmarks
    • license and notice documents under /opt/r2kernel/licenses

    Source the installed environment helper in each shell that will run R2Kernel commands.

    . /opt/r2kernel/env.sh

    2. Check Python SDK Availability

    Ubuntu / Debian.

    sudo apt update
sudo apt install -y python3-venv python3-pip

    The installer places the Python SDK wheel and an unpacked managed-package runtime under /opt/r2kernel/sdk/python. After sourcing env.sh, installed tutorial packages and managed Python packages can import the SDK without a separate source checkout.

    . /opt/r2kernel/env.sh
python3 -c 'import r2kernel; print("R2Kernel Python SDK ready")'

    Use a virtual environment only when you want an isolated development shell.

    python3 -m venv r2kernel-quickstart
. r2kernel-quickstart/bin/activate
. /opt/r2kernel/env.sh
python -m pip install /opt/r2kernel/sdk/python/r2kernel_client-*.whl

    You do not need an SDK source checkout for normal installed tutorial or benchmark runs.

    3. Check The Control Backend

    If r2kernel-control.service was installed.

    sudo systemctl status r2kernel-control.service --no-pager

    The important line is Active: active (running). The service uses /opt/r2kernel/runtime/config.yaml by default, where the bundled Web Console and HTTP API listen on port 8001.

    Check readiness.

    curl -sf http://127.0.0.1:8001/api/v1/ready

    Open the local Web Console.

    http://127.0.0.1:8001/

    If your browser is running on a different machine, replace 127.0.0.1 with the runtime host address. Do this only on a trusted network or after enabling Web/API security.

    If systemctl status also shows pmc ... bind failed: Permission denied line, that message is from linuxptp time-sync telemetry, not from the Web Console itself. Check the dedicated time-sync service separately.

    sudo systemctl status r2kernel-timesyncd.service --no-pager
r2kernel timesync doctor

    4. If Services Were Skipped

    Some tutorial and package flows require the resource service. If installation skipped system services, register them before running managed packages.

    sudo /opt/r2kernel/bin/r2kernel system install \
  --prefix /opt/r2kernel

    For cross-host or site-specific configs.

    sudo /opt/r2kernel/bin/r2kernel system install \
  --prefix /opt/r2kernel \
  --config /path/to/config.yaml

    For time-sync details, use Time Sync Operations.

    5. Continue

    After the first install check, continue in this order. Tutorial and benchmark checks are covered on the pages that use them.

    1. Operate - service status, Web Console, resource control, time sync, security, and deployment checks.
    2. Develop - the cleaner robot tutorial and subsystem/package development workflow.
    3. Performance - benchmark tracks and measurement rules.

    Clone source repositories only when you need editable source work.

    • clone r2kernel-sdk for editable SDK development, source-level SDK tests, or advanced benchmark matrix tooling
    • use the entry repository's r2kernel.repos manifest when you need the matching SDK and docs source workspace
    • clone r2kernel-demo separately when you want complete robotics application demos