OpenCastor/.env.example at main · craigm26/OpenCastor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# ============================================================================
# OpenCastor Environment Configuration
# ============================================================================
# Copy this file to .env and fill in the values you need.
#   cp .env.example .env
#
# For the recommended RPi RC Car stack, you only need to set:
#   1. ANTHROPIC_API_KEY   (your Claude API key)
#   2. TWILIO_*            (WhatsApp credentials from twilio.com)
# ============================================================================

# --- AI Providers (The Brain) ------------------------------------------------
# At least ONE provider key is required.

# Anthropic Claude Opus 4.6 (Recommended -- best reasoning + vision)
ANTHROPIC_API_KEY=

# Google Gemini
# GOOGLE_API_KEY=

# OpenAI GPT-4.1
# OPENAI_API_KEY=

# OpenRouter (Access many models through a single key)
# OPENROUTER_API_KEY=

# DeepSeek (deepseek-chat, deepseek-reasoner, deepseek-coder)
# DEEPSEEK_API_KEY=

# xAI Grok (grok-2, grok-2-vision, grok-2-mini)
# XAI_API_KEY=

# Mistral AI (mistral-large-latest, mistral-small-latest, codestral-latest)
# MISTRAL_API_KEY=

# Local Ollama (No key needed - just the URL)
# OLLAMA_BASE_URL=http://localhost:11434

# Taalas HC1 (local ASIC inference, 17K tokens/sec — no key needed)
# TAALAS_ENDPOINT=http://localhost:8000

# Google Vertex AI (Enterprise Gemini via Google Cloud)
# VERTEX_PROJECT=my-gcp-project
# VERTEX_LOCATION=us-central1
# GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json

# --- Messaging Channels ------------------------------------------------------
# Enable any channels you want the robot to receive commands from.

# WhatsApp (Recommended) -- No credentials needed!
# Just run `castor gateway` and scan the QR code with your phone.
# Session data is stored in ~/.opencastor/whatsapp_session.db
# To use a custom data directory, set:
# OPENCASTOR_DATA_DIR=/path/to/data

# WhatsApp via Twilio (Legacy) -- Only needed if you prefer the Twilio integration
# TWILIO_ACCOUNT_SID=
# TWILIO_AUTH_TOKEN=
# TWILIO_WHATSAPP_NUMBER=whatsapp:+14155238886

# Telegram Bot
# TELEGRAM_BOT_TOKEN=

# Discord Bot
# DISCORD_BOT_TOKEN=

# Slack Bot
# SLACK_BOT_TOKEN=xoxb-...
# SLACK_APP_TOKEN=xapp-...
# SLACK_SIGNING_SECRET=

# --- API Gateway --------------------------------------------------------------
# The built-in FastAPI server for remote control and channel webhooks.

# Secret token for authenticating API requests (generate with: openssl rand -hex 32)
# OPENCASTOR_API_TOKEN=

# JWT secret for RCAN protocol authentication (optional, enables JWT auth)
# Generate with: openssl rand -hex 32
# OPENCASTOR_JWT_SECRET=

# Gateway bind address (use 0.0.0.0 to accept WhatsApp webhooks from the internet)
OPENCASTOR_API_HOST=0.0.0.0

# Gateway port (default: 8000)
OPENCASTOR_API_PORT=8000

# RCAN config file to load at startup
OPENCASTOR_CONFIG=config/presets/rpi_rc_car.rcan.yaml

# --- Hardware -----------------------------------------------------------------

# Dynamixel serial port (default: /dev/ttyUSB0)
# DYNAMIXEL_PORT=/dev/ttyUSB0

# Camera device index for USB cameras (CSI cameras auto-detected via picamera2)
# CAMERA_INDEX=0

# --- Runtime ------------------------------------------------------------------
# Log level (DEBUG, INFO, WARNING, ERROR)
# LOG_LEVEL=INFO