zeroclaw/docs
ehushubhamshaw 83f1d474bd feat(hardware): add RPi GPIO, Aardvark I2C/SPI/GPIO, and hardware plugin system
Extends the hardware subsystem with three clusters of functionality,
all feature-gated (hardware / peripheral-rpi) with no impact on default builds.

Raspberry Pi native support:
- src/hardware/rpi.rs: board self-discovery (model, serial, revision),
  sysfs GPIO pin read/write, and ACT LED control
- scripts/99-act-led.rules: udev rule for non-root ACT LED access
- scripts/deploy-rpi.sh, scripts/rpi-config.toml, scripts/zeroclaw.service:
  one-shot deployment helper and systemd service template

Total Phase Aardvark USB adapter (I2C / SPI / GPIO):
- crates/aardvark-sys/: new workspace crate with FFI bindings loaded at
  runtime via libloading; graceful stub fallback when .so is absent or
  arch mismatches (Rosetta 2 detection)
- src/hardware/aardvark.rs: AardvarkTransport implementing Transport trait
- src/hardware/aardvark_tools.rs: agent tools i2c_scan, i2c_read,
  i2c_write, spi_transfer, gpio_aardvark
- src/hardware/datasheet.rs: datasheet search/download for detected devices
- docs/aardvark-integration.md, examples/hardware/aardvark/: guide + examples

Hardware plugin / ToolRegistry system:
- src/hardware/tool_registry.rs: ToolRegistry for hardware module tool sets
- src/hardware/loader.rs, src/hardware/manifest.rs: manifest-driven loader
- src/hardware/subprocess.rs: subprocess execution helper for board I/O
- src/gateway/hardware_context.rs: POST /api/hardware/reload endpoint
- src/hardware/mod.rs: exports all new modules; merge_hardware_tools and
  load_hardware_context_prompt helpers

Integration hooks (minimal surface):
- src/hardware/device.rs: DeviceKind::Aardvark, DeviceRuntime::Aardvark,
  has_aardvark / resolve_aardvark_device on DeviceRegistry
- src/hardware/transport.rs: TransportKind::Aardvark
- src/peripherals/mod.rs: gate create_board_info_tools behind hardware feature
- src/agent/loop_.rs: TOOL_CHOICE_OVERRIDE task-local for Anthropic provider
- src/providers/anthropic.rs: read TOOL_CHOICE_OVERRIDE; add tool_choice field
- Cargo.toml: add aardvark-sys to workspace and as dependency
- firmware/zeroclaw-nucleo/: update Cargo.toml and Cargo.lock

Non-goals:
- No changes to agent orchestration, channels, providers, or security policy
- No new config keys outside existing [hardware] / [peripherals] sections
- No CI workflow changes

Risk: Low. All new paths are feature-gated; aardvark.so loads at runtime
only when present. No schema migrations or persistent state introduced.

Rollback: revert this single commit.
2026-03-14 18:18:55 -04:00
..
assets docs: restructure docs/ into topic-based directory layout 2026-03-09 22:25:20 -04:00
contributing fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
hardware chore: migrate GitHub URLs from theonlyhennygod to zeroclaw-labs 2026-03-09 23:49:56 -04:00
i18n fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
maintainers fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
ops docs: replace main branch references with master (#3194) 2026-03-11 21:54:08 -04:00
reference fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
security fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
setup-guides fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
vi fix(docs): remove stale onboarding flags after CLI changes (#3516) 2026-03-14 17:54:14 -04:00
aardvark-integration.md feat(hardware): add RPi GPIO, Aardvark I2C/SPI/GPIO, and hardware plugin system 2026-03-14 18:18:55 -04:00
README.ar.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.bn.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.cs.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.da.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.de.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.el.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.es.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.fi.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.fr.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
README.he.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.hi.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.hu.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.id.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.it.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.ja.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
README.ko.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.nb.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.nl.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.pl.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.pt.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.ro.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.ru.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
README.sv.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.th.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.tl.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.tr.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.uk.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.ur.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
README.vi.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
README.zh-CN.md docs(i18n/zh-CN): Complete full Chinese documentation translation and… (#3429) 2026-03-13 18:46:29 -04:00
SUMMARY.ar.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.bn.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.cs.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.da.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.de.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.el.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.es.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.fi.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.fr.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
SUMMARY.he.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.hi.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.hu.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.id.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.it.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.ja.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
SUMMARY.ko.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.nb.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.nl.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.pl.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.pt.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.ro.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.ru.md docs: update all internal links to match topic-based directory layout 2026-03-09 23:09:09 -04:00
SUMMARY.sv.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.th.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.tl.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.tr.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.uk.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.ur.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.vi.md docs(i18n): add documentation hub translations for all 30 languages (#3450) 2026-03-13 18:42:26 -04:00
SUMMARY.zh-CN.md docs(i18n/zh-CN): Complete full Chinese documentation translation and… (#3429) 2026-03-13 18:46:29 -04:00

ZeroClaw Documentation Hub

This page is the primary entry point for the documentation system.

Last refreshed: February 21, 2026.

Localized hubs: العربية · বাংলা · Čeština · Dansk · Deutsch · Ελληνικά · Español · Suomi · Français · עברית · हिन्दी · Magyar · Bahasa Indonesia · Italiano · 日本語 · 한국어 · Norsk Bokmål · Nederlands · Polski · Português · Română · Русский · Svenska · ไทย · Tagalog · Türkçe · Українська · اردو · Tiếng Việt · 简体中文.

Start Here

I want to… Read this
Install and run ZeroClaw quickly README.md (Quick Start)
Bootstrap in one command one-click-bootstrap.md
Update or uninstall on macOS macos-update-uninstall.md
Find commands by task commands-reference.md
Check config defaults and keys quickly config-reference.md
Configure custom providers/endpoints custom-providers.md
Configure Z.AI / GLM provider zai-glm-setup.md
Use LangGraph integration patterns langgraph-integration.md
Operate runtime (day-2 runbook) operations-runbook.md
Troubleshoot install/runtime/channel issues troubleshooting.md
Run Matrix encrypted-room setup and diagnostics matrix-e2ee-guide.md
Browse docs by category SUMMARY.md
See project PR/issue docs snapshot project-triage-snapshot-2026-02-18.md

Quick Decision Tree (10 seconds)

By Audience

Users / Operators

Contributors / Maintainers

Security / Reliability

Note: this area includes proposal/roadmap docs. For current behavior, start with config-reference.md, operations-runbook.md, and troubleshooting.md.

System Navigation & Governance