Skip to content

ATR-Lab/PepperKit

Repository files navigation

PepperKit

PepperKit is a monorepo for building and operating a Pepper robot stack with:

  • An Ubuntu 24.04 containerized Android Studio environment reachable in-browser.
  • A backend WebSocket service that orchestrates OpenAI Realtime interactions.
  • A QiSDK Android client that streams microphone input, captures camera images on request, and speaks assistant text with QiSDK Say.

Repository Layout

  • infra/: Container and infrastructure assets.
  • contracts/: Wire protocol schemas and contract tests.
  • backend/: Backend WebSocket and agent runtime services.
  • android-client/: Pepper Android client application.
  • docs/: Setup guides, runbooks, and test plans.
  • scripts/: Shared validation and helper scripts.

Quality Gates

The repository enforces strict verification with warning-fail behavior where supported.

  • Python: lint, type-check, test.
  • Android: Gradle build and lint with -Dorg.gradle.warning.mode=fail.
  • Contracts: schema validation tests.

Run all available checks:

make verify

Run smoke validation:

make e2e-smoke

Compose

Start backend only:

docker compose up --build backend

Start backend plus browser-accessible Android Studio environment:

docker compose --profile ide up --build backend android-studio-webrtc

Detailed operational steps live in docs/runbook.md.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors