Skip to content

Commit 792c80f

Browse files
committed
Initial commit
0 parents  commit 792c80f

273 files changed

Lines changed: 66552 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.cargo/config.toml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Linux builds use mold for faster linking. Install it before building, or
2+
# override these target-specific rustflags to use your system linker. macOS
3+
# uses its default linker.
4+
5+
[target.x86_64-unknown-linux-gnu]
6+
rustflags = ["-C", "link-arg=-fuse-ld=mold"]
7+
8+
[target.aarch64-unknown-linux-gnu]
9+
rustflags = ["-C", "link-arg=-fuse-ld=mold"]
10+
11+
# libwebrtc (livekit-cameras) must be built with clang 21+, not GCC. Set CC and CXX in
12+
# your shell to override, e.g. `CC=clang CXX=clang++` on macOS, where Apple clang is the
13+
# default and `clang-21` does not exist.
14+
# [env]
15+
# CC = "clang-21"
16+
# CXX = "clang++-21"
17+
18+
# Configure sccache in your user Cargo configuration if you use it.

‎.env.example‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copy to .env in the directory where the station and examples are launched.
2+
OPENAI_API_KEY=
3+
ANTHROPIC_API_KEY=
4+
GEMINI_API_KEY=
5+
LIVEKIT_URL=
6+
LIVEKIT_API_KEY=
7+
LIVEKIT_API_SECRET=
8+
# HEBBIAN_PHONE_PAGE_URL=https://your-trusted-page.example/

‎.github/workflows/check.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Check
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
python:
14+
runs-on: ubuntu-24.04
15+
steps:
16+
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
17+
with:
18+
persist-credentials: false
19+
- uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
20+
with:
21+
version: "0.13.6"
22+
python-version: "3.14"
23+
- run: uv sync --locked
24+
- run: uv run ruff check
25+
- run: uv run ruff format --check
26+
- run: uv run ty check
27+
- run: uv run pytest
28+
- run: uv lock --check --project examples/python
29+
30+
rust:
31+
runs-on: ubuntu-24.04
32+
timeout-minutes: 60
33+
env:
34+
CC: clang-21
35+
CXX: clang++-21
36+
steps:
37+
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
38+
with:
39+
persist-credentials: false
40+
- name: Install native build tools
41+
run: |
42+
curl -fsSL https://apt.llvm.org/llvm-snapshot.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/llvm.gpg
43+
echo 'deb [signed-by=/usr/share/keyrings/llvm.gpg] https://apt.llvm.org/noble/ llvm-toolchain-noble-21 main' | sudo tee /etc/apt/sources.list.d/llvm.list
44+
sudo apt-get update
45+
sudo apt-get install -y pkg-config mold libudev-dev libglib2.0-dev clang-21 libclang-21-dev
46+
- run: rustup show active-toolchain
47+
- run: cargo fmt --all -- --check
48+
- run: cargo clippy --locked --all-targets --all-features
49+
- run: cargo test --locked --workspace --all-features

‎.gitignore‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
node_modules/
2+
dist/
3+
.venv/
4+
__pycache__/
5+
.env
6+
.env.*
7+
!.env.example
8+
*.pem
9+
*.key
10+
.ruff_cache/
11+
.ty_cache/
12+
/recordings/*
13+
!/recordings/Cargo.toml
14+
!/recordings/README.md
15+
!/recordings/src/
16+
!/recordings/tests/
17+
18+
/.cache/
19+
/profiles/local/
20+
/target/
21+
22+
# Executor and control-loop cycle traces
23+
/traces/
24+
/executor/traces/
25+
/station/traces/
26+
27+
.DS_Store
28+
*.egg-info/
29+
30+
# Credentials
31+
.gemini-key*
32+
33+
/runs/
34+
35+
36+
# Local metadata
37+
/EXPORT.json

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.14

‎AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Read [CONTRIBUTING.md](./CONTRIBUTING.md).

‎CLAUDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Read [AGENTS.md](./AGENTS.md).

‎CONTRIBUTING.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
This is an early release of part of our robotics stack. Feedback and issue reports
4+
are welcome.
5+
6+
For development, follow [source setup](docs/getting-started.md#from-source), then
7+
run `uv sync --locked` from the checkout root. The pinned Rust toolchain includes
8+
Clippy and rustfmt. Python checks run on 3.14; the package supports Python 3.12+.
9+
Python dependencies keep a three-day minimum release age.
10+
11+
For Python changes:
12+
13+
```sh
14+
uv run ruff check --fix
15+
uv run ruff format
16+
uv run ty check
17+
uv run pytest
18+
```
19+
20+
For Rust changes:
21+
22+
```sh
23+
cargo fmt
24+
cargo clippy --all-targets --all-features
25+
cargo test --workspace --all-features
26+
```
27+
28+
Check documentation links with `lychee --offline -v .`; use `lychee -v .` to
29+
include external links. CI checks Python and Rust on Ubuntu 24.04.
30+
31+
The media build needs the prerequisites in [camera setup](docs/cameras.md).
32+
Keep credentials, recordings and per-arm calibration out of commits.
33+
34+
For camera changes, verify a real USB or phone stream with LiveKit: browser
35+
video, SDK snapshots, simultaneous readers, reconnection and shutdown. Simulator
36+
checks do not cover a physical camera or arm.
37+
38+
## Code style
39+
40+
- Use descriptive function and variable names, even when they are verbose.
41+
- Prefer explicit types and typed variants; make invalid states hard to represent.
42+
- Use exhaustive matching where practical, and parse external values at boundaries.
43+
- Share internal operations instead of duplicating behavior across entry points.
44+
- Preserve and log unknown external values when the boundary permits recovery.
45+
- Comment on non-obvious decisions rather than restating the code.
46+
- Test observable outcomes and real business logic, not mocks or library internals.
47+
- Use uv for Python. Keep changes scoped and run targeted checks first.
48+
49+
Use the workspace's existing Clippy allowances and Python lint settings. The
50+
release uses `panic = "abort"`; default test builds retain unwinding. Configure
51+
sccache in your own Cargo settings rather than requiring it for contributors.

0 commit comments

Comments
 (0)