Repository navigation
Expand file tree
/
Copy pathgetting-started.html
More file actions
214 lines (185 loc) · 7.01 KB
/
Copy pathgetting-started.html
File metadata and controls
214 lines (185 loc) · 7.01 KB
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Getting Started - OpenEyes v2.5.0</title>
<link rel="icon" type="image/svg+xml" href="assets/images/logo.svg">
<link rel="stylesheet" href="css/style.css">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
</head>
<body>
<nav class="navbar">
<div class="navbar-container">
<a href="index.html" class="navbar-logo">
<img src="assets/images/logo.svg" alt="OpenEyes">
<span>OpenEyes</span>
</a>
<ul class="navbar-links">
<li><a href="index.html">Home</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li><a href="commands.html">Commands</a></li>
<li><a href="ros2.html">ROS2</a></li>
<li><a href="hardware.html">Hardware</a></li>
<li><a href="safety.html">Safety</a></li>
<li><a href="contributing.html">Contribute</a></li>
<li><a href="https://github.com/mandarwagh9/openeyes">GitHub</a></li>
</ul>
<div class="navbar-toggle" onclick="toggleMenu()">
<span></span><span></span><span></span>
</div>
</div>
</nav>
<header class="page-header">
<h1>Getting Started</h1>
<p>Get up and running with OpenEyes in 5 minutes</p>
</header>
<main class="content">
<h2>Prerequisites</h2>
<ul>
<li>NVIDIA Jetson Orin Nano (4GB or 8GB), Raspberry Pi 5, Intel NPU, Hailo, or Qualcomm</li>
<li>CSI Camera (IMX219), USB Webcam, or RealSense D455</li>
<li>Ubuntu 22.04 installed</li>
<li>Internet connection</li>
</ul>
<h2>Clone & Install</h2>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code>git clone https://github.com/mandarwagh9/openeyes.git
cd openeyes
pip install -r requirements.txt</code></pre>
</div>
<h2>Verify Camera</h2>
<h3>USB Webcam</h3>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code>ls /dev/video*
python3 -c "import cv2; cap = cv2.VideoCapture(0); print('OK' if cap.isOpened() else 'Error'); cap.release()"</code></pre>
</div>
<h3>CSI Camera</h3>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code>ls -la /dev/video*
gst-launch-1.0 nvarguscamerasrc sensor-id=0 ! fakesink</code></pre>
</div>
<h2>Run the Vision System</h2>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code># With debug window
python src/main.py --debug
# Headless
python src/main.py
# With ROS2
python src/main.py --ros2
# With world model (predictive tracking)
python src/main.py --world-model lewm --follow
# With industry template
python src/main.py --template warehouse --debug
# Turbo mode for max FPS
python src/main.py --turbo --world-model lewm
# Process video files
python src/main.py --video input.mp4 --output output.mp4</code></pre>
</div>
<h2>Jetson Optimization</h2>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code>sudo bash scripts/jetson_perf.sh
# Sets MAXN SUPER mode + jetson_clocks</code></pre>
</div>
<h2>Next Steps</h2>
<ul>
<li><a href="commands.html">Explore all commands</a></li>
<li><a href="safety.html">Safety & Reliability Features</a></li>
<li><a href="ros2.html">Set up ROS2 integration</a></li>
<li><a href="hardware.html">View hardware specs</a></li>
</ul>
<h2>v2.5.0 — World Models & Predictive Intelligence</h2>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code># LeWM world model (15M params, 100-200 Hz planning)
python src/main.py --world-model lewm --follow
# With predictive safety evaluation
python src/main.py --world-model lewm --safety-predict
# Industry templates (warehouse, manufacturing-qa, agriculture, retail)
python src/main.py --template warehouse
python src/main.py --template manufacturing-qa
# Depth model selection (midas-small, da3-small, da3-base)
python src/main.py --depth-model da3-small</code></pre>
</div>
<h2>v0.7.0+ New Features</h2>
<h3>Multi-Modal Sensing</h3>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code># Enable LIDAR processing
python src/main.py --lidar --lidar-topic /scan
# Enable RealSense D455
python src/main.py --realsense
# Multi-camera mode
python src/main.py --multi-camera</code></pre>
</div>
<h3>VLA & Performance (v0.8.0+)</h3>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code># INT8 quantization (~2x faster)
python src/main.py --int8
# INT8 + DLA (~3x faster)
python src/main.py --int8 --dla
# Maximum FPS
python src/main.py --no-face --no-gesture --no-pose --no-depth --int8 --dla</code></pre>
</div>
<h3>Safety Features (v1.0.0+)</h3>
<div class="code-block">
<div class="code-header">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
</div>
<pre><code># Enable safety controller
python src/main.py --safety --max-velocity 0.5 --min-distance 0.5
# Enable health monitoring
python src/main.py --health-monitor
# Full production mode
python src/main.py --safety --health-monitor --ota-update</code></pre>
</div>
</main>
<footer class="footer">
<p>OpenEyes v2.5.0-dev — Hardware-agnostic edge robot vision</p>
<div class="footer-links">
<a href="https://github.com/mandarwagh9/openeyes">GitHub</a>
<a href="index.html">Home</a>
<a href="safety.html">Safety</a>
</div>
</footer>
<script>
function toggleMenu() { document.querySelector('.navbar-links').classList.toggle('active'); }
function copyCode(btn) {
const code = btn.closest('.code-block').querySelector('code').textContent;
navigator.clipboard.writeText(code).then(() => { btn.textContent = 'Copied!'; setTimeout(() => btn.textContent = 'Copy', 2000); });
}
</script>
</body>
</html>