Skip to main content

Official Python SDK for the RCAN robot communication protocol

Project description

rcan-py

Python SDK for the RCAN protocol — build robots that communicate securely, audit every action, and enforce safety gates locally.

PyPI version RCAN Spec Tests License Python

Install

pip install rcan==0.6.0

Optional extras:

pip install rcan[http]    # httpx for registry client
pip install rcan[crypto]  # cryptography for Ed25519 signing
pip install rcan[all]     # everything

Quick Start

from rcan import RobotURI, RCANMessage, ConfidenceGate
from rcan.audit import AuditChain, CommitmentRecord
from rcan.replay import ReplayCache
from rcan.qos import QoSLevel
from rcan.consent import ConsentRequest

# 1. Address a robot
uri = RobotURI.build(manufacturer="acme", model="arm", version="v2", device_id="unit-001")
# rcan://registry.rcan.dev/acme/arm/v2/unit-001

# 2. Gate on AI confidence before acting
gate = ConfidenceGate(threshold=0.8)
confidence = 0.91

if gate.allows(confidence):
    msg = RCANMessage(
        cmd="move_forward",
        target=uri,
        params={"distance_m": 1.0},
        confidence=confidence,
        model_identity="gemini-2.5-flash",
    )

# 3. Replay attack prevention — deduplicate incoming messages
cache = ReplayCache(window_seconds=300)
if cache.is_replay(msg.msg_id):
    raise ValueError("Replay attack detected")
cache.record(msg.msg_id)

# 4. Tamper-evident audit chain — every action sealed and linked
chain = AuditChain(secret="your-hmac-secret")
chain.append(CommitmentRecord(
    action="move_forward",
    robot_uri=str(uri),
    confidence=confidence,
    model_identity="gemini-2.5-flash",
    safety_approved=True,
))
chain.verify_all()  # raises if chain is tampered

# 5. Request human consent before a sensitive action
req = ConsentRequest(
    action="open_gripper",
    robot_uri=str(uri),
    requester="operator-alice",
    scope="control",
)
print(req.to_json())

What's in v0.6.0

Module Description
rcan.message Core RCANMessage envelope with all v1.6 fields
rcan.address RobotURI — parse, build, and validate RCAN robot addresses
rcan.audit AuditChain + CommitmentRecord — tamper-evident HMAC-chained logs
rcan.gates ConfidenceGate, HiTLGate — safety gates for AI-driven actions
rcan.replay ReplayCache — sliding-window replay attack prevention (GAP-03)
rcan.clock ClockSyncStatus — NTP clock sync verification (GAP-04)
rcan.qos QoSLevel — FIRE_AND_FORGET / ACKNOWLEDGED / EXACTLY_ONCE (GAP-11)
rcan.consent Consent wire protocol — request/grant/deny (GAP-05)
rcan.revocation Robot identity revocation with TTL cache (GAP-02)
rcan.training_consent Training data consent, GDPR/EU AI Act Annex III §5 (GAP-10)
rcan.delegation Command delegation chain, max 4 hops, Ed25519-signed (GAP-01)
rcan.offline Offline operation mode — ESTOP always allowed (GAP-06)
rcan.fault FaultCode structured fault taxonomy (GAP-20)
rcan.federation Federated consent — cross-registry trust, DNS discovery (GAP-16)
rcan.transport Constrained transports — compact CBOR, 32-byte ESTOP minimal, BLE (GAP-17)
rcan.multimodal Multi-modal payloads — inline/ref media, streaming (GAP-18)
rcan.identity Level of Assurance — LoA policies, JWT parsing (GAP-14)
rcan.keys Key rotation with JWKS-compatible KeyStore (GAP-09)
rcan.config_update CONFIG_UPDATE protocol with safety scope enforcement (GAP-07)
rcan.node NodeClient — resolve RRNs across federated registry nodes (§17)
rcan.validate L1/L2/L3 conformance validation for configs, messages, URIs

Protocol 66 Compliance

Protocol 66 is RCAN's safety layer. Key invariants enforced by this SDK:

  • ESTOP always deliveredQoSLevel.EXACTLY_ONCE, never blocked by QoS downgrade
  • Local safety winsoffline module enforces local limits even without cloud connectivity
  • Confidence gates run locallyConfidenceGate never makes a network call
  • Audit chain requiredAuditChain.verify_all() before executing any flagged command
from rcan.offline import OfflineMode
from rcan.safety import SafetyInvariant

mode = OfflineMode()
mode.assert_estop_reachable()   # raises if ESTOP path is blocked

CLI

# Validate a robot config (L1/L2/L3 conformance)
rcan-validate config myrobot.rcan.yaml

# Validate a RCAN message
rcan-validate message command.json

# Verify an audit chain
rcan-validate audit audit.jsonl

# Validate a Robot URI
rcan-validate uri 'rcan://registry.rcan.dev/acme/arm/v2/unit-001'

# Run all checks
rcan-validate all myrobot.rcan.yaml

Spec Compliance

Implements RCAN v1.6 — 587 tests, 0 skipped.

Covered sections: §1 Robot URI · §2 RBAC · §3 Message Format · §5 Authentication · §5.3 QoS · §6 Safety Invariants · §8.3 Replay Prevention · §8.4 Clock Sync · §8.5 Sender Type · §8.6 Key Lifecycle · §8.7 Level of Assurance · §9 Capabilities · §11 Behavior Scripts · §12 Command Delegation · §13 Revocation · §14 Offline Mode · §16 AI Accountability · §17 Distributed Registry · §18 Federation · §19 Constrained Transport · §21 Registry Integration

Ecosystem

Package Version Purpose
rcan-py (this) v0.6.0 Python SDK
rcan-ts v0.6.0 TypeScript SDK
rcan-spec v1.6.0 Protocol spec
OpenCastor v2026.3.17.1 Robot runtime (reference impl)
RRF v1.6.0 Robot identity registry
Fleet UI live Web fleet dashboard
Docs live Runtime reference, RCAN, API

Contributing

Issues and PRs welcome at github.com/continuonai/rcan-py.

Spec discussions: github.com/continuonai/rcan-spec/issues

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rcan-1.3.0.tar.gz (140.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rcan-1.3.0-py3-none-any.whl (107.8 kB view details)

Uploaded Python 3

File details

Details for the file rcan-1.3.0.tar.gz.

File metadata

  • Download URL: rcan-1.3.0.tar.gz
  • Upload date:
  • Size: 140.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rcan-1.3.0.tar.gz
Algorithm Hash digest
SHA256 65b4e3a26949992c2e31d793886520988ba53bcd3e63d45ce5c3ce2ebb8a0aab
MD5 ed789bb841d1cc754f0917aa0222e004
BLAKE2b-256 0e8e013730853dab6dc908236e8f00d487461946060e9e1941ecaa3249da9349

See more details on using hashes here.

File details

Details for the file rcan-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: rcan-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 107.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rcan-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0752ff01ce0cc6565f2e56cf5c19fd0ce28c2358803bfe1d385709e0609cc3b0
MD5 ec02f265e071bcb9053916b4a49ac529
BLAKE2b-256 342ed81b43dbb2ef0b275aa5a790c6a522c26973db9f73ba6370c5030b69fd20

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page