robot_lab 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.architecture/AGENTS.md +32 -0
- data/.architecture/config.yml +8 -0
- data/.architecture/members.yml +60 -0
- data/.architecture/reviews/feature-free-will.md +490 -0
- data/.architecture/reviews/overall-codebase.md +427 -0
- data/.claude/settings.local.json +57 -0
- data/.codex/config.toml +2 -0
- data/.irbrc +2 -2
- data/.rubocop.yml +172 -0
- data/CHANGELOG.md +72 -0
- data/CLAUDE.md +139 -0
- data/README.md +91 -95
- data/Rakefile +109 -3
- data/agent2agent_review.md +192 -0
- data/agentf_improvements.md +253 -0
- data/agents.md +14 -0
- data/docs/examples/index.md +37 -2
- data/docs/getting-started/configuration.md +20 -7
- data/docs/guides/index.md +16 -16
- data/docs/guides/knowledge.md +7 -1
- data/docs/guides/observability.md +132 -0
- data/docs/index.md +30 -3
- data/docs/superpowers/plans/2026-05-06-agentskills.md +1303 -0
- data/docs/superpowers/specs/2026-05-06-agentskills-design.md +247 -0
- data/examples/.envrc +1 -0
- data/examples/01_simple_robot.rb +5 -9
- data/examples/02_tools.rb +5 -9
- data/examples/03_network.rb +8 -9
- data/examples/04_mcp.rb +21 -29
- data/examples/05_streaming.rb +12 -18
- data/examples/06_prompt_templates.rb +11 -19
- data/examples/07_network_memory.rb +16 -31
- data/examples/08_llm_config.rb +10 -22
- data/examples/09_chaining.rb +16 -27
- data/examples/10_memory.rb +12 -28
- data/examples/11_network_introspection.rb +15 -29
- data/examples/12_message_bus.rb +5 -12
- data/examples/13_spawn.rb +5 -10
- data/examples/14_rusty_circuit/.envrc +1 -0
- data/examples/14_rusty_circuit/comic.rb +2 -0
- data/examples/14_rusty_circuit/heckler.rb +1 -1
- data/examples/14_rusty_circuit/open_mic.rb +1 -3
- data/examples/14_rusty_circuit/scout.rb +2 -0
- data/examples/15_memory_network_and_bus/.envrc +1 -0
- data/examples/15_memory_network_and_bus/editorial_pipeline.rb +6 -3
- data/examples/15_memory_network_and_bus/linux_writer.rb +1 -1
- data/examples/15_memory_network_and_bus/output/combined_article.md +6 -6
- data/examples/15_memory_network_and_bus/output/final_article.md +6 -8
- data/examples/15_memory_network_and_bus/output/linux_draft.md +4 -2
- data/examples/15_memory_network_and_bus/output/mac_draft.md +3 -3
- data/examples/15_memory_network_and_bus/output/memory.json +6 -6
- data/examples/15_memory_network_and_bus/output/revision_1.md +10 -11
- data/examples/15_memory_network_and_bus/output/revision_2.md +6 -8
- data/examples/15_memory_network_and_bus/output/windows_draft.md +3 -3
- data/examples/16_writers_room/.envrc +1 -0
- data/examples/16_writers_room/writers_room.rb +2 -4
- data/examples/17_skills.rb +8 -17
- data/examples/18_rails/Gemfile +1 -0
- data/examples/19_token_tracking.rb +9 -15
- data/examples/20_circuit_breaker.rb +10 -19
- data/examples/21_learning_loop.rb +11 -20
- data/examples/22_context_compression.rb +6 -13
- data/examples/23_convergence.rb +6 -17
- data/examples/24_structured_delegation.rb +11 -15
- data/examples/25_history_search.rb +5 -12
- data/examples/26_document_store.rb +6 -13
- data/examples/27_incident_response/incident_response.rb +4 -5
- data/examples/28_mcp_discovery.rb +8 -11
- data/examples/29_ractor_tools.rb +4 -9
- data/examples/30_ractor_network.rb +10 -19
- data/examples/31_launch_assessment.rb +10 -23
- data/examples/32_newsletter_reader.rb +188 -0
- data/examples/33_stock_generator.rb +80 -0
- data/examples/33_stock_predictor.rb +306 -0
- data/examples/34_agentskills.rb +72 -0
- data/examples/README.md +1 -1
- data/examples/common.rb +76 -0
- data/examples/ruboruby.md +423 -0
- data/examples/temp.md +51 -0
- data/lib/robot_lab/agent_skill.rb +63 -0
- data/lib/robot_lab/agent_skill_catalog.rb +74 -0
- data/lib/robot_lab/ask_user.rb +2 -2
- data/lib/robot_lab/bus_poller.rb +12 -5
- data/lib/robot_lab/config.rb +1 -12
- data/lib/robot_lab/delegation_future.rb +1 -1
- data/lib/robot_lab/doom_loop_detector.rb +98 -0
- data/lib/robot_lab/history_compressor.rb +4 -10
- data/lib/robot_lab/mcp/client.rb +1 -2
- data/lib/robot_lab/mcp/connection_poller.rb +3 -3
- data/lib/robot_lab/mcp/server.rb +1 -1
- data/lib/robot_lab/mcp/server_discovery.rb +0 -2
- data/lib/robot_lab/memory.rb +32 -27
- data/lib/robot_lab/memory_change.rb +2 -2
- data/lib/robot_lab/message.rb +4 -4
- data/lib/robot_lab/network.rb +11 -6
- data/lib/robot_lab/robot/agent_skill_matching.rb +99 -0
- data/lib/robot_lab/robot/bus_messaging.rb +9 -27
- data/lib/robot_lab/robot/history_search.rb +4 -1
- data/lib/robot_lab/robot/mcp_management.rb +5 -11
- data/lib/robot_lab/robot/template_rendering.rb +60 -40
- data/lib/robot_lab/robot.rb +323 -206
- data/lib/robot_lab/robot_result.rb +6 -5
- data/lib/robot_lab/run_config.rb +5 -11
- data/lib/robot_lab/script_tool.rb +76 -0
- data/lib/robot_lab/state_proxy.rb +7 -5
- data/lib/robot_lab/tool.rb +3 -3
- data/lib/robot_lab/tool_config.rb +1 -1
- data/lib/robot_lab/tool_manifest.rb +5 -7
- data/lib/robot_lab/user_message.rb +2 -2
- data/lib/robot_lab/version.rb +1 -1
- data/lib/robot_lab/waiter.rb +1 -1
- data/lib/robot_lab.rb +41 -52
- data/logfile +8 -0
- data/mkdocs.yml +2 -3
- data/robot_concurrency.md +38 -0
- data/simple_acp_review.md +298 -0
- data/site/404.html +2300 -0
- data/site/api/core/index.html +2706 -0
- data/site/api/core/memory/index.html +3793 -0
- data/site/api/core/network/index.html +3500 -0
- data/site/api/core/robot/index.html +4566 -0
- data/site/api/core/state/index.html +3390 -0
- data/site/api/core/tool/index.html +3843 -0
- data/site/api/index.html +2635 -0
- data/site/api/mcp/client/index.html +3435 -0
- data/site/api/mcp/index.html +2783 -0
- data/site/api/mcp/server/index.html +3252 -0
- data/site/api/mcp/transports/index.html +3352 -0
- data/site/api/messages/index.html +2641 -0
- data/site/api/messages/text-message/index.html +3087 -0
- data/site/api/messages/tool-call-message/index.html +3159 -0
- data/site/api/messages/tool-result-message/index.html +3252 -0
- data/site/api/messages/user-message/index.html +3212 -0
- data/site/api/streaming/context/index.html +3282 -0
- data/site/api/streaming/events/index.html +3347 -0
- data/site/api/streaming/index.html +2738 -0
- data/site/architecture/core-concepts/index.html +3757 -0
- data/site/architecture/index.html +2797 -0
- data/site/architecture/message-flow/index.html +3238 -0
- data/site/architecture/network-orchestration/index.html +3433 -0
- data/site/architecture/robot-execution/index.html +3140 -0
- data/site/architecture/state-management/index.html +3498 -0
- data/site/assets/css/custom.css +56 -0
- data/site/assets/images/favicon.png +0 -0
- data/site/assets/images/robot_lab.jpg +0 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js +16 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js.map +7 -0
- data/site/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
- data/site/assets/javascripts/lunr/tinyseg.js +206 -0
- data/site/assets/javascripts/lunr/wordcut.js +6708 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css +1 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css.map +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
- data/site/concepts/index.html +3455 -0
- data/site/examples/basic-chat/index.html +2880 -0
- data/site/examples/index.html +2907 -0
- data/site/examples/mcp-server/index.html +3018 -0
- data/site/examples/multi-robot-network/index.html +3131 -0
- data/site/examples/rails-application/index.html +3329 -0
- data/site/examples/tool-usage/index.html +3085 -0
- data/site/getting-started/configuration/index.html +3745 -0
- data/site/getting-started/index.html +2572 -0
- data/site/getting-started/installation/index.html +2981 -0
- data/site/getting-started/quick-start/index.html +2942 -0
- data/site/guides/building-robots/index.html +4290 -0
- data/site/guides/creating-networks/index.html +3858 -0
- data/site/guides/index.html +2586 -0
- data/site/guides/mcp-integration/index.html +3581 -0
- data/site/guides/memory/index.html +3586 -0
- data/site/guides/rails-integration/index.html +4019 -0
- data/site/guides/streaming/index.html +3157 -0
- data/site/guides/using-tools/index.html +3802 -0
- data/site/index.html +2671 -0
- data/site/search/search_index.json +1 -0
- data/site/sitemap.xml +183 -0
- data/site/sitemap.xml.gz +0 -0
- data/site/tags.json +1 -0
- data/temp.md +6 -0
- data/tool_manifest_plan.md +155 -0
- metadata +154 -92
- data/docs/examples/rails-application.md +0 -419
- data/docs/guides/ractor-parallelism.md +0 -364
- data/docs/guides/rails-integration.md +0 -681
- data/docs/superpowers/plans/2026-04-14-ractor-integration.md +0 -1538
- data/docs/superpowers/specs/2026-04-14-ractor-integration-design.md +0 -258
- data/lib/generators/robot_lab/install_generator.rb +0 -90
- data/lib/generators/robot_lab/job_generator.rb +0 -40
- data/lib/generators/robot_lab/robot_generator.rb +0 -55
- data/lib/generators/robot_lab/templates/initializer.rb.tt +0 -42
- data/lib/generators/robot_lab/templates/job.rb.tt +0 -21
- data/lib/generators/robot_lab/templates/migration.rb.tt +0 -32
- data/lib/generators/robot_lab/templates/result_model.rb.tt +0 -52
- data/lib/generators/robot_lab/templates/robot.rb.tt +0 -31
- data/lib/generators/robot_lab/templates/robot_job.rb.tt +0 -18
- data/lib/generators/robot_lab/templates/robot_test.rb.tt +0 -34
- data/lib/generators/robot_lab/templates/routing_robot.rb.tt +0 -59
- data/lib/generators/robot_lab/templates/thread_model.rb.tt +0 -40
- data/lib/robot_lab/document_store.rb +0 -155
- data/lib/robot_lab/ractor_boundary.rb +0 -42
- data/lib/robot_lab/ractor_job.rb +0 -37
- data/lib/robot_lab/ractor_memory_proxy.rb +0 -85
- data/lib/robot_lab/ractor_network_scheduler.rb +0 -154
- data/lib/robot_lab/ractor_worker_pool.rb +0 -117
- data/lib/robot_lab/rails_integration/engine.rb +0 -29
- data/lib/robot_lab/rails_integration/job.rb +0 -158
- data/lib/robot_lab/rails_integration/railtie.rb +0 -51
- data/lib/robot_lab/rails_integration/turbo_stream_callbacks.rb +0 -72
|
@@ -0,0 +1,2981 @@
|
|
|
1
|
+
|
|
2
|
+
<!doctype html>
|
|
3
|
+
<html lang="en" class="no-js">
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="utf-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
8
|
+
|
|
9
|
+
<meta name="description" content="Multi-robot LLM workflow orchestration for Ruby">
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<meta name="author" content="Dewayne VanHoozer">
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
<link rel="canonical" href="https://madbomber.github.io/robot_lab/getting-started/installation/">
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<link rel="prev" href="../">
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<link rel="next" href="../quick-start/">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
<link rel="icon" href="../../assets/images/favicon.png">
|
|
28
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<title>Installation - RobotLab</title>
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
53
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
54
|
+
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<link rel="stylesheet" href="../../assets/css/custom.css">
|
|
59
|
+
|
|
60
|
+
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</head>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber">
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
82
|
+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
83
|
+
<label class="md-overlay" for="__drawer"></label>
|
|
84
|
+
<div data-md-component="skip">
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<a href="#installation" class="md-skip">
|
|
88
|
+
Skip to content
|
|
89
|
+
</a>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
<div data-md-component="announce">
|
|
93
|
+
|
|
94
|
+
</div>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
|
|
102
|
+
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
103
|
+
<a href="../.." title="RobotLab" class="md-header__button md-logo" aria-label="RobotLab" data-md-component="logo">
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
|
|
107
|
+
|
|
108
|
+
</a>
|
|
109
|
+
<label class="md-header__button md-icon" for="__drawer">
|
|
110
|
+
|
|
111
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
|
112
|
+
</label>
|
|
113
|
+
<div class="md-header__title" data-md-component="header-title">
|
|
114
|
+
<div class="md-header__ellipsis">
|
|
115
|
+
<div class="md-header__topic">
|
|
116
|
+
<span class="md-ellipsis">
|
|
117
|
+
RobotLab
|
|
118
|
+
</span>
|
|
119
|
+
</div>
|
|
120
|
+
<div class="md-header__topic" data-md-component="header-topic">
|
|
121
|
+
<span class="md-ellipsis">
|
|
122
|
+
|
|
123
|
+
Installation
|
|
124
|
+
|
|
125
|
+
</span>
|
|
126
|
+
</div>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<form class="md-header__option" data-md-component="palette">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
|
137
|
+
|
|
138
|
+
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
|
139
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
140
|
+
</label>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
|
147
|
+
|
|
148
|
+
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
|
149
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
150
|
+
</label>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
</form>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<label class="md-header__button md-icon" for="__search">
|
|
164
|
+
|
|
165
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
166
|
+
</label>
|
|
167
|
+
<div class="md-search" data-md-component="search" role="dialog">
|
|
168
|
+
<label class="md-search__overlay" for="__search"></label>
|
|
169
|
+
<div class="md-search__inner" role="search">
|
|
170
|
+
<form class="md-search__form" name="search">
|
|
171
|
+
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
172
|
+
<label class="md-search__icon md-icon" for="__search">
|
|
173
|
+
|
|
174
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
175
|
+
|
|
176
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
177
|
+
</label>
|
|
178
|
+
<nav class="md-search__options" aria-label="Search">
|
|
179
|
+
|
|
180
|
+
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
|
181
|
+
|
|
182
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
|
183
|
+
</a>
|
|
184
|
+
|
|
185
|
+
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
186
|
+
|
|
187
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
188
|
+
</button>
|
|
189
|
+
</nav>
|
|
190
|
+
|
|
191
|
+
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
192
|
+
|
|
193
|
+
</form>
|
|
194
|
+
<div class="md-search__output">
|
|
195
|
+
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
196
|
+
<div class="md-search-result" data-md-component="search-result">
|
|
197
|
+
<div class="md-search-result__meta">
|
|
198
|
+
Initializing search
|
|
199
|
+
</div>
|
|
200
|
+
<ol class="md-search-result__list" role="presentation"></ol>
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<div class="md-header__source">
|
|
210
|
+
<a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
|
|
211
|
+
<div class="md-source__icon md-icon">
|
|
212
|
+
|
|
213
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="md-source__repository">
|
|
216
|
+
madbomber/robot_lab
|
|
217
|
+
</div>
|
|
218
|
+
</a>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
</nav>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
226
|
+
<div class="md-grid">
|
|
227
|
+
<ul class="md-tabs__list">
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<li class="md-tabs__item">
|
|
237
|
+
<a href="../.." class="md-tabs__link">
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
Home
|
|
244
|
+
|
|
245
|
+
</a>
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<li class="md-tabs__item md-tabs__item--active">
|
|
261
|
+
<a href="../" class="md-tabs__link">
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
Getting Started
|
|
268
|
+
|
|
269
|
+
</a>
|
|
270
|
+
</li>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<li class="md-tabs__item">
|
|
283
|
+
<a href="../../architecture/" class="md-tabs__link">
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
Architecture
|
|
290
|
+
|
|
291
|
+
</a>
|
|
292
|
+
</li>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<li class="md-tabs__item">
|
|
305
|
+
<a href="../../guides/" class="md-tabs__link">
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
Guides
|
|
312
|
+
|
|
313
|
+
</a>
|
|
314
|
+
</li>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="md-tabs__item">
|
|
327
|
+
<a href="../../api/" class="md-tabs__link">
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
API Reference
|
|
334
|
+
|
|
335
|
+
</a>
|
|
336
|
+
</li>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<li class="md-tabs__item">
|
|
349
|
+
<a href="../../examples/" class="md-tabs__link">
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
Examples
|
|
356
|
+
|
|
357
|
+
</a>
|
|
358
|
+
</li>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</ul>
|
|
364
|
+
</div>
|
|
365
|
+
</nav>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</header>
|
|
369
|
+
|
|
370
|
+
<div class="md-container" data-md-component="container">
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<main class="md-main" data-md-component="main">
|
|
376
|
+
<div class="md-main__inner md-grid">
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
381
|
+
<div class="md-sidebar__scrollwrap">
|
|
382
|
+
<div class="md-sidebar__inner">
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
|
390
|
+
<label class="md-nav__title" for="__drawer">
|
|
391
|
+
<a href="../.." title="RobotLab" class="md-nav__button md-logo" aria-label="RobotLab" data-md-component="logo">
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
|
|
395
|
+
|
|
396
|
+
</a>
|
|
397
|
+
RobotLab
|
|
398
|
+
</label>
|
|
399
|
+
|
|
400
|
+
<div class="md-nav__source">
|
|
401
|
+
<a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
|
|
402
|
+
<div class="md-source__icon md-icon">
|
|
403
|
+
|
|
404
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
405
|
+
</div>
|
|
406
|
+
<div class="md-source__repository">
|
|
407
|
+
madbomber/robot_lab
|
|
408
|
+
</div>
|
|
409
|
+
</a>
|
|
410
|
+
</div>
|
|
411
|
+
|
|
412
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<div class="md-nav__link md-nav__container">
|
|
444
|
+
<a href="../.." class="md-nav__link ">
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span class="md-ellipsis">
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
Home
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
</span>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
</a>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
|
|
463
|
+
<span class="md-nav__icon md-icon"></span>
|
|
464
|
+
</label>
|
|
465
|
+
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
|
|
469
|
+
<label class="md-nav__title" for="__nav_1">
|
|
470
|
+
<span class="md-nav__icon md-icon"></span>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
Home
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
</label>
|
|
477
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
<li class="md-nav__item">
|
|
488
|
+
<a href="../../concepts/" class="md-nav__link">
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
<span class="md-ellipsis">
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
Concepts
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</span>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
</a>
|
|
504
|
+
</li>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</ul>
|
|
510
|
+
</nav>
|
|
511
|
+
|
|
512
|
+
</li>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<div class="md-nav__link md-nav__container">
|
|
555
|
+
<a href="../" class="md-nav__link ">
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<span class="md-ellipsis">
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
Getting Started
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</span>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
</a>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
|
574
|
+
<span class="md-nav__icon md-icon"></span>
|
|
575
|
+
</label>
|
|
576
|
+
|
|
577
|
+
</div>
|
|
578
|
+
|
|
579
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
|
|
580
|
+
<label class="md-nav__title" for="__nav_2">
|
|
581
|
+
<span class="md-nav__icon md-icon"></span>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
Getting Started
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
</label>
|
|
588
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<li class="md-nav__item md-nav__item--active">
|
|
601
|
+
|
|
602
|
+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
<span class="md-ellipsis">
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
Installation
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
</span>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
<span class="md-nav__icon md-icon"></span>
|
|
624
|
+
</label>
|
|
625
|
+
|
|
626
|
+
<a href="./" class="md-nav__link md-nav__link--active">
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
<span class="md-ellipsis">
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
Installation
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
</span>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
</a>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<label class="md-nav__title" for="__toc">
|
|
655
|
+
<span class="md-nav__icon md-icon"></span>
|
|
656
|
+
On this page
|
|
657
|
+
</label>
|
|
658
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
659
|
+
|
|
660
|
+
<li class="md-nav__item">
|
|
661
|
+
<a href="#requirements" class="md-nav__link">
|
|
662
|
+
<span class="md-ellipsis">
|
|
663
|
+
|
|
664
|
+
Requirements
|
|
665
|
+
|
|
666
|
+
</span>
|
|
667
|
+
</a>
|
|
668
|
+
|
|
669
|
+
</li>
|
|
670
|
+
|
|
671
|
+
<li class="md-nav__item">
|
|
672
|
+
<a href="#install-via-bundler" class="md-nav__link">
|
|
673
|
+
<span class="md-ellipsis">
|
|
674
|
+
|
|
675
|
+
Install via Bundler
|
|
676
|
+
|
|
677
|
+
</span>
|
|
678
|
+
</a>
|
|
679
|
+
|
|
680
|
+
</li>
|
|
681
|
+
|
|
682
|
+
<li class="md-nav__item">
|
|
683
|
+
<a href="#install-via-rubygems" class="md-nav__link">
|
|
684
|
+
<span class="md-ellipsis">
|
|
685
|
+
|
|
686
|
+
Install via RubyGems
|
|
687
|
+
|
|
688
|
+
</span>
|
|
689
|
+
</a>
|
|
690
|
+
|
|
691
|
+
</li>
|
|
692
|
+
|
|
693
|
+
<li class="md-nav__item">
|
|
694
|
+
<a href="#dependencies" class="md-nav__link">
|
|
695
|
+
<span class="md-ellipsis">
|
|
696
|
+
|
|
697
|
+
Dependencies
|
|
698
|
+
|
|
699
|
+
</span>
|
|
700
|
+
</a>
|
|
701
|
+
|
|
702
|
+
<nav class="md-nav" aria-label="Dependencies">
|
|
703
|
+
<ul class="md-nav__list">
|
|
704
|
+
|
|
705
|
+
<li class="md-nav__item">
|
|
706
|
+
<a href="#optional-dependencies" class="md-nav__link">
|
|
707
|
+
<span class="md-ellipsis">
|
|
708
|
+
|
|
709
|
+
Optional Dependencies
|
|
710
|
+
|
|
711
|
+
</span>
|
|
712
|
+
</a>
|
|
713
|
+
|
|
714
|
+
</li>
|
|
715
|
+
|
|
716
|
+
</ul>
|
|
717
|
+
</nav>
|
|
718
|
+
|
|
719
|
+
</li>
|
|
720
|
+
|
|
721
|
+
<li class="md-nav__item">
|
|
722
|
+
<a href="#verify-installation" class="md-nav__link">
|
|
723
|
+
<span class="md-ellipsis">
|
|
724
|
+
|
|
725
|
+
Verify Installation
|
|
726
|
+
|
|
727
|
+
</span>
|
|
728
|
+
</a>
|
|
729
|
+
|
|
730
|
+
</li>
|
|
731
|
+
|
|
732
|
+
<li class="md-nav__item">
|
|
733
|
+
<a href="#rails-installation" class="md-nav__link">
|
|
734
|
+
<span class="md-ellipsis">
|
|
735
|
+
|
|
736
|
+
Rails Installation
|
|
737
|
+
|
|
738
|
+
</span>
|
|
739
|
+
</a>
|
|
740
|
+
|
|
741
|
+
</li>
|
|
742
|
+
|
|
743
|
+
<li class="md-nav__item">
|
|
744
|
+
<a href="#environment-setup" class="md-nav__link">
|
|
745
|
+
<span class="md-ellipsis">
|
|
746
|
+
|
|
747
|
+
Environment Setup
|
|
748
|
+
|
|
749
|
+
</span>
|
|
750
|
+
</a>
|
|
751
|
+
|
|
752
|
+
</li>
|
|
753
|
+
|
|
754
|
+
<li class="md-nav__item">
|
|
755
|
+
<a href="#troubleshooting" class="md-nav__link">
|
|
756
|
+
<span class="md-ellipsis">
|
|
757
|
+
|
|
758
|
+
Troubleshooting
|
|
759
|
+
|
|
760
|
+
</span>
|
|
761
|
+
</a>
|
|
762
|
+
|
|
763
|
+
<nav class="md-nav" aria-label="Troubleshooting">
|
|
764
|
+
<ul class="md-nav__list">
|
|
765
|
+
|
|
766
|
+
<li class="md-nav__item">
|
|
767
|
+
<a href="#gem-installation-fails" class="md-nav__link">
|
|
768
|
+
<span class="md-ellipsis">
|
|
769
|
+
|
|
770
|
+
Gem Installation Fails
|
|
771
|
+
|
|
772
|
+
</span>
|
|
773
|
+
</a>
|
|
774
|
+
|
|
775
|
+
</li>
|
|
776
|
+
|
|
777
|
+
<li class="md-nav__item">
|
|
778
|
+
<a href="#missing-dependencies" class="md-nav__link">
|
|
779
|
+
<span class="md-ellipsis">
|
|
780
|
+
|
|
781
|
+
Missing Dependencies
|
|
782
|
+
|
|
783
|
+
</span>
|
|
784
|
+
</a>
|
|
785
|
+
|
|
786
|
+
</li>
|
|
787
|
+
|
|
788
|
+
<li class="md-nav__item">
|
|
789
|
+
<a href="#api-key-issues" class="md-nav__link">
|
|
790
|
+
<span class="md-ellipsis">
|
|
791
|
+
|
|
792
|
+
API Key Issues
|
|
793
|
+
|
|
794
|
+
</span>
|
|
795
|
+
</a>
|
|
796
|
+
|
|
797
|
+
</li>
|
|
798
|
+
|
|
799
|
+
</ul>
|
|
800
|
+
</nav>
|
|
801
|
+
|
|
802
|
+
</li>
|
|
803
|
+
|
|
804
|
+
<li class="md-nav__item">
|
|
805
|
+
<a href="#next-steps" class="md-nav__link">
|
|
806
|
+
<span class="md-ellipsis">
|
|
807
|
+
|
|
808
|
+
Next Steps
|
|
809
|
+
|
|
810
|
+
</span>
|
|
811
|
+
</a>
|
|
812
|
+
|
|
813
|
+
</li>
|
|
814
|
+
|
|
815
|
+
</ul>
|
|
816
|
+
|
|
817
|
+
</nav>
|
|
818
|
+
|
|
819
|
+
</li>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
<li class="md-nav__item">
|
|
831
|
+
<a href="../quick-start/" class="md-nav__link">
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
<span class="md-ellipsis">
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
Quick Start
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</span>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
</a>
|
|
847
|
+
</li>
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
<li class="md-nav__item">
|
|
859
|
+
<a href="../configuration/" class="md-nav__link">
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
<span class="md-ellipsis">
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
Configuration
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
</span>
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
</a>
|
|
875
|
+
</li>
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
</ul>
|
|
881
|
+
</nav>
|
|
882
|
+
|
|
883
|
+
</li>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
<div class="md-nav__link md-nav__container">
|
|
925
|
+
<a href="../../architecture/" class="md-nav__link ">
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
<span class="md-ellipsis">
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
Architecture
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
</span>
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
</a>
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
944
|
+
<span class="md-nav__icon md-icon"></span>
|
|
945
|
+
</label>
|
|
946
|
+
|
|
947
|
+
</div>
|
|
948
|
+
|
|
949
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
950
|
+
<label class="md-nav__title" for="__nav_3">
|
|
951
|
+
<span class="md-nav__icon md-icon"></span>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
Architecture
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
</label>
|
|
958
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
<li class="md-nav__item">
|
|
969
|
+
<a href="../../architecture/core-concepts/" class="md-nav__link">
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
<span class="md-ellipsis">
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
Core Concepts
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
</span>
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
</a>
|
|
985
|
+
</li>
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<li class="md-nav__item">
|
|
997
|
+
<a href="../../architecture/robot-execution/" class="md-nav__link">
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
<span class="md-ellipsis">
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
Robot Execution
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
</span>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
</a>
|
|
1013
|
+
</li>
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
<li class="md-nav__item">
|
|
1025
|
+
<a href="../../architecture/network-orchestration/" class="md-nav__link">
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
<span class="md-ellipsis">
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
Network Orchestration
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
</span>
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
</a>
|
|
1041
|
+
</li>
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
<li class="md-nav__item">
|
|
1053
|
+
<a href="../../architecture/state-management/" class="md-nav__link">
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
<span class="md-ellipsis">
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
State Management
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
</span>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
</a>
|
|
1069
|
+
</li>
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
<li class="md-nav__item">
|
|
1081
|
+
<a href="../../architecture/message-flow/" class="md-nav__link">
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
<span class="md-ellipsis">
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
Message Flow
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
</span>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</a>
|
|
1097
|
+
</li>
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
</ul>
|
|
1103
|
+
</nav>
|
|
1104
|
+
|
|
1105
|
+
</li>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
<div class="md-nav__link md-nav__container">
|
|
1151
|
+
<a href="../../guides/" class="md-nav__link ">
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
<span class="md-ellipsis">
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
Guides
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
</span>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
</a>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
1170
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1171
|
+
</label>
|
|
1172
|
+
|
|
1173
|
+
</div>
|
|
1174
|
+
|
|
1175
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
1176
|
+
<label class="md-nav__title" for="__nav_4">
|
|
1177
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
Guides
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
</label>
|
|
1184
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
<li class="md-nav__item">
|
|
1195
|
+
<a href="../../guides/building-robots/" class="md-nav__link">
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
<span class="md-ellipsis">
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
Building Robots
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
</span>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
</a>
|
|
1211
|
+
</li>
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
<li class="md-nav__item">
|
|
1223
|
+
<a href="../../guides/creating-networks/" class="md-nav__link">
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
<span class="md-ellipsis">
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
Creating Networks
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
</span>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</a>
|
|
1239
|
+
</li>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
<li class="md-nav__item">
|
|
1251
|
+
<a href="../../guides/using-tools/" class="md-nav__link">
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<span class="md-ellipsis">
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
Using Tools
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
</span>
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
</a>
|
|
1267
|
+
</li>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
<li class="md-nav__item">
|
|
1279
|
+
<a href="../../guides/mcp-integration/" class="md-nav__link">
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
<span class="md-ellipsis">
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
MCP Integration
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
</span>
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
</a>
|
|
1295
|
+
</li>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
<li class="md-nav__item">
|
|
1307
|
+
<a href="../../guides/streaming/" class="md-nav__link">
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
<span class="md-ellipsis">
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
Streaming Responses
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
</span>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
</a>
|
|
1323
|
+
</li>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
<li class="md-nav__item">
|
|
1335
|
+
<a href="../../guides/memory/" class="md-nav__link">
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
<span class="md-ellipsis">
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
Memory System
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
</span>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
</a>
|
|
1351
|
+
</li>
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
<li class="md-nav__item">
|
|
1363
|
+
<a href="../../guides/rails-integration/" class="md-nav__link">
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
<span class="md-ellipsis">
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
Rails Integration
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
</span>
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
</a>
|
|
1379
|
+
</li>
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
</ul>
|
|
1385
|
+
</nav>
|
|
1386
|
+
|
|
1387
|
+
</li>
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
<div class="md-nav__link md-nav__container">
|
|
1427
|
+
<a href="../../api/" class="md-nav__link ">
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
<span class="md-ellipsis">
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
API Reference
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
</span>
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
</a>
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
|
|
1446
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1447
|
+
</label>
|
|
1448
|
+
|
|
1449
|
+
</div>
|
|
1450
|
+
|
|
1451
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
1452
|
+
<label class="md-nav__title" for="__nav_5">
|
|
1453
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
API Reference
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
</label>
|
|
1460
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
<div class="md-nav__link md-nav__container">
|
|
1502
|
+
<a href="../../api/core/" class="md-nav__link ">
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
<span class="md-ellipsis">
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
Core Classes
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
</span>
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
</a>
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
|
|
1521
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1522
|
+
</label>
|
|
1523
|
+
|
|
1524
|
+
</div>
|
|
1525
|
+
|
|
1526
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
|
|
1527
|
+
<label class="md-nav__title" for="__nav_5_2">
|
|
1528
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
Core Classes
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
</label>
|
|
1535
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
<li class="md-nav__item">
|
|
1546
|
+
<a href="../../api/core/robot/" class="md-nav__link">
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
<span class="md-ellipsis">
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
Robot
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
</span>
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
</a>
|
|
1562
|
+
</li>
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
<li class="md-nav__item">
|
|
1574
|
+
<a href="../../api/core/network/" class="md-nav__link">
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
<span class="md-ellipsis">
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
Network
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
</span>
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
</a>
|
|
1590
|
+
</li>
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
<li class="md-nav__item">
|
|
1602
|
+
<a href="../../api/core/state/" class="md-nav__link">
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
<span class="md-ellipsis">
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
State
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
</span>
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
</a>
|
|
1618
|
+
</li>
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
<li class="md-nav__item">
|
|
1630
|
+
<a href="../../api/core/tool/" class="md-nav__link">
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
<span class="md-ellipsis">
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
Tool
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
</span>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
</a>
|
|
1646
|
+
</li>
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
<li class="md-nav__item">
|
|
1658
|
+
<a href="../../api/core/memory/" class="md-nav__link">
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
<span class="md-ellipsis">
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
Memory
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
</span>
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
</a>
|
|
1674
|
+
</li>
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
</ul>
|
|
1680
|
+
</nav>
|
|
1681
|
+
|
|
1682
|
+
</li>
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
<div class="md-nav__link md-nav__container">
|
|
1723
|
+
<a href="../../api/messages/" class="md-nav__link ">
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
<span class="md-ellipsis">
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
Messages
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
</span>
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
</a>
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
|
1742
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1743
|
+
</label>
|
|
1744
|
+
|
|
1745
|
+
</div>
|
|
1746
|
+
|
|
1747
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
|
1748
|
+
<label class="md-nav__title" for="__nav_5_3">
|
|
1749
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
Messages
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
</label>
|
|
1756
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
<li class="md-nav__item">
|
|
1767
|
+
<a href="../../api/messages/user-message/" class="md-nav__link">
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
<span class="md-ellipsis">
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
UserMessage
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
</span>
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
</a>
|
|
1783
|
+
</li>
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
<li class="md-nav__item">
|
|
1795
|
+
<a href="../../api/messages/text-message/" class="md-nav__link">
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
<span class="md-ellipsis">
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
TextMessage
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
</span>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
</a>
|
|
1811
|
+
</li>
|
|
1812
|
+
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
<li class="md-nav__item">
|
|
1823
|
+
<a href="../../api/messages/tool-call-message/" class="md-nav__link">
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
<span class="md-ellipsis">
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
ToolCallMessage
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
</span>
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
</a>
|
|
1839
|
+
</li>
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
<li class="md-nav__item">
|
|
1851
|
+
<a href="../../api/messages/tool-result-message/" class="md-nav__link">
|
|
1852
|
+
|
|
1853
|
+
|
|
1854
|
+
|
|
1855
|
+
<span class="md-ellipsis">
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
ToolResultMessage
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
</span>
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
</a>
|
|
1867
|
+
</li>
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
</ul>
|
|
1873
|
+
</nav>
|
|
1874
|
+
|
|
1875
|
+
</li>
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
<div class="md-nav__link md-nav__container">
|
|
1914
|
+
<a href="../../api/mcp/" class="md-nav__link ">
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
<span class="md-ellipsis">
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
MCP
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
</span>
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
</a>
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
<label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
|
|
1933
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1934
|
+
</label>
|
|
1935
|
+
|
|
1936
|
+
</div>
|
|
1937
|
+
|
|
1938
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
|
|
1939
|
+
<label class="md-nav__title" for="__nav_5_4">
|
|
1940
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
MCP
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
</label>
|
|
1947
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
<li class="md-nav__item">
|
|
1958
|
+
<a href="../../api/mcp/client/" class="md-nav__link">
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
|
|
1962
|
+
<span class="md-ellipsis">
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
Client
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
</span>
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
</a>
|
|
1974
|
+
</li>
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
<li class="md-nav__item">
|
|
1986
|
+
<a href="../../api/mcp/server/" class="md-nav__link">
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
<span class="md-ellipsis">
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
Server
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
</span>
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
</a>
|
|
2002
|
+
</li>
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
<li class="md-nav__item">
|
|
2014
|
+
<a href="../../api/mcp/transports/" class="md-nav__link">
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
<span class="md-ellipsis">
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
Transports
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
</span>
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
</a>
|
|
2030
|
+
</li>
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
</ul>
|
|
2036
|
+
</nav>
|
|
2037
|
+
|
|
2038
|
+
</li>
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
<div class="md-nav__link md-nav__container">
|
|
2075
|
+
<a href="../../api/streaming/" class="md-nav__link ">
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
<span class="md-ellipsis">
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
Streaming
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
</span>
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
</a>
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
<label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
|
|
2094
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2095
|
+
</label>
|
|
2096
|
+
|
|
2097
|
+
</div>
|
|
2098
|
+
|
|
2099
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
|
|
2100
|
+
<label class="md-nav__title" for="__nav_5_5">
|
|
2101
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
Streaming
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
</label>
|
|
2108
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
<li class="md-nav__item">
|
|
2119
|
+
<a href="../../api/streaming/context/" class="md-nav__link">
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
<span class="md-ellipsis">
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
Context
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
</span>
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
</a>
|
|
2135
|
+
</li>
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
<li class="md-nav__item">
|
|
2147
|
+
<a href="../../api/streaming/events/" class="md-nav__link">
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
<span class="md-ellipsis">
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
Events
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
</span>
|
|
2159
|
+
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
</a>
|
|
2163
|
+
</li>
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
</ul>
|
|
2169
|
+
</nav>
|
|
2170
|
+
|
|
2171
|
+
</li>
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
</ul>
|
|
2177
|
+
</nav>
|
|
2178
|
+
|
|
2179
|
+
</li>
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
|
|
2217
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
<div class="md-nav__link md-nav__container">
|
|
2221
|
+
<a href="../../examples/" class="md-nav__link ">
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
|
|
2225
|
+
<span class="md-ellipsis">
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
Examples
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
</span>
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
|
|
2236
|
+
</a>
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
2240
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2241
|
+
</label>
|
|
2242
|
+
|
|
2243
|
+
</div>
|
|
2244
|
+
|
|
2245
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
2246
|
+
<label class="md-nav__title" for="__nav_6">
|
|
2247
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
Examples
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
</label>
|
|
2254
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
<li class="md-nav__item">
|
|
2265
|
+
<a href="../../examples/basic-chat/" class="md-nav__link">
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
<span class="md-ellipsis">
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
Basic Chat
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
|
|
2276
|
+
</span>
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
</a>
|
|
2281
|
+
</li>
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
<li class="md-nav__item">
|
|
2293
|
+
<a href="../../examples/multi-robot-network/" class="md-nav__link">
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
|
|
2297
|
+
<span class="md-ellipsis">
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
Multi-Robot Network
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
</span>
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
</a>
|
|
2309
|
+
</li>
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
<li class="md-nav__item">
|
|
2321
|
+
<a href="../../examples/tool-usage/" class="md-nav__link">
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
<span class="md-ellipsis">
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
Tool Usage
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
</span>
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
</a>
|
|
2337
|
+
</li>
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
<li class="md-nav__item">
|
|
2349
|
+
<a href="../../examples/mcp-server/" class="md-nav__link">
|
|
2350
|
+
|
|
2351
|
+
|
|
2352
|
+
|
|
2353
|
+
<span class="md-ellipsis">
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
MCP Server
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
|
|
2360
|
+
</span>
|
|
2361
|
+
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
</a>
|
|
2365
|
+
</li>
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
<li class="md-nav__item">
|
|
2377
|
+
<a href="../../examples/rails-application/" class="md-nav__link">
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
<span class="md-ellipsis">
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
Rails Application
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
</span>
|
|
2389
|
+
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
</a>
|
|
2393
|
+
</li>
|
|
2394
|
+
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
</ul>
|
|
2399
|
+
</nav>
|
|
2400
|
+
|
|
2401
|
+
</li>
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
</ul>
|
|
2406
|
+
</nav>
|
|
2407
|
+
</div>
|
|
2408
|
+
</div>
|
|
2409
|
+
</div>
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
2414
|
+
<div class="md-sidebar__scrollwrap">
|
|
2415
|
+
<div class="md-sidebar__inner">
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
|
|
2427
|
+
<label class="md-nav__title" for="__toc">
|
|
2428
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2429
|
+
On this page
|
|
2430
|
+
</label>
|
|
2431
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
2432
|
+
|
|
2433
|
+
<li class="md-nav__item">
|
|
2434
|
+
<a href="#requirements" class="md-nav__link">
|
|
2435
|
+
<span class="md-ellipsis">
|
|
2436
|
+
|
|
2437
|
+
Requirements
|
|
2438
|
+
|
|
2439
|
+
</span>
|
|
2440
|
+
</a>
|
|
2441
|
+
|
|
2442
|
+
</li>
|
|
2443
|
+
|
|
2444
|
+
<li class="md-nav__item">
|
|
2445
|
+
<a href="#install-via-bundler" class="md-nav__link">
|
|
2446
|
+
<span class="md-ellipsis">
|
|
2447
|
+
|
|
2448
|
+
Install via Bundler
|
|
2449
|
+
|
|
2450
|
+
</span>
|
|
2451
|
+
</a>
|
|
2452
|
+
|
|
2453
|
+
</li>
|
|
2454
|
+
|
|
2455
|
+
<li class="md-nav__item">
|
|
2456
|
+
<a href="#install-via-rubygems" class="md-nav__link">
|
|
2457
|
+
<span class="md-ellipsis">
|
|
2458
|
+
|
|
2459
|
+
Install via RubyGems
|
|
2460
|
+
|
|
2461
|
+
</span>
|
|
2462
|
+
</a>
|
|
2463
|
+
|
|
2464
|
+
</li>
|
|
2465
|
+
|
|
2466
|
+
<li class="md-nav__item">
|
|
2467
|
+
<a href="#dependencies" class="md-nav__link">
|
|
2468
|
+
<span class="md-ellipsis">
|
|
2469
|
+
|
|
2470
|
+
Dependencies
|
|
2471
|
+
|
|
2472
|
+
</span>
|
|
2473
|
+
</a>
|
|
2474
|
+
|
|
2475
|
+
<nav class="md-nav" aria-label="Dependencies">
|
|
2476
|
+
<ul class="md-nav__list">
|
|
2477
|
+
|
|
2478
|
+
<li class="md-nav__item">
|
|
2479
|
+
<a href="#optional-dependencies" class="md-nav__link">
|
|
2480
|
+
<span class="md-ellipsis">
|
|
2481
|
+
|
|
2482
|
+
Optional Dependencies
|
|
2483
|
+
|
|
2484
|
+
</span>
|
|
2485
|
+
</a>
|
|
2486
|
+
|
|
2487
|
+
</li>
|
|
2488
|
+
|
|
2489
|
+
</ul>
|
|
2490
|
+
</nav>
|
|
2491
|
+
|
|
2492
|
+
</li>
|
|
2493
|
+
|
|
2494
|
+
<li class="md-nav__item">
|
|
2495
|
+
<a href="#verify-installation" class="md-nav__link">
|
|
2496
|
+
<span class="md-ellipsis">
|
|
2497
|
+
|
|
2498
|
+
Verify Installation
|
|
2499
|
+
|
|
2500
|
+
</span>
|
|
2501
|
+
</a>
|
|
2502
|
+
|
|
2503
|
+
</li>
|
|
2504
|
+
|
|
2505
|
+
<li class="md-nav__item">
|
|
2506
|
+
<a href="#rails-installation" class="md-nav__link">
|
|
2507
|
+
<span class="md-ellipsis">
|
|
2508
|
+
|
|
2509
|
+
Rails Installation
|
|
2510
|
+
|
|
2511
|
+
</span>
|
|
2512
|
+
</a>
|
|
2513
|
+
|
|
2514
|
+
</li>
|
|
2515
|
+
|
|
2516
|
+
<li class="md-nav__item">
|
|
2517
|
+
<a href="#environment-setup" class="md-nav__link">
|
|
2518
|
+
<span class="md-ellipsis">
|
|
2519
|
+
|
|
2520
|
+
Environment Setup
|
|
2521
|
+
|
|
2522
|
+
</span>
|
|
2523
|
+
</a>
|
|
2524
|
+
|
|
2525
|
+
</li>
|
|
2526
|
+
|
|
2527
|
+
<li class="md-nav__item">
|
|
2528
|
+
<a href="#troubleshooting" class="md-nav__link">
|
|
2529
|
+
<span class="md-ellipsis">
|
|
2530
|
+
|
|
2531
|
+
Troubleshooting
|
|
2532
|
+
|
|
2533
|
+
</span>
|
|
2534
|
+
</a>
|
|
2535
|
+
|
|
2536
|
+
<nav class="md-nav" aria-label="Troubleshooting">
|
|
2537
|
+
<ul class="md-nav__list">
|
|
2538
|
+
|
|
2539
|
+
<li class="md-nav__item">
|
|
2540
|
+
<a href="#gem-installation-fails" class="md-nav__link">
|
|
2541
|
+
<span class="md-ellipsis">
|
|
2542
|
+
|
|
2543
|
+
Gem Installation Fails
|
|
2544
|
+
|
|
2545
|
+
</span>
|
|
2546
|
+
</a>
|
|
2547
|
+
|
|
2548
|
+
</li>
|
|
2549
|
+
|
|
2550
|
+
<li class="md-nav__item">
|
|
2551
|
+
<a href="#missing-dependencies" class="md-nav__link">
|
|
2552
|
+
<span class="md-ellipsis">
|
|
2553
|
+
|
|
2554
|
+
Missing Dependencies
|
|
2555
|
+
|
|
2556
|
+
</span>
|
|
2557
|
+
</a>
|
|
2558
|
+
|
|
2559
|
+
</li>
|
|
2560
|
+
|
|
2561
|
+
<li class="md-nav__item">
|
|
2562
|
+
<a href="#api-key-issues" class="md-nav__link">
|
|
2563
|
+
<span class="md-ellipsis">
|
|
2564
|
+
|
|
2565
|
+
API Key Issues
|
|
2566
|
+
|
|
2567
|
+
</span>
|
|
2568
|
+
</a>
|
|
2569
|
+
|
|
2570
|
+
</li>
|
|
2571
|
+
|
|
2572
|
+
</ul>
|
|
2573
|
+
</nav>
|
|
2574
|
+
|
|
2575
|
+
</li>
|
|
2576
|
+
|
|
2577
|
+
<li class="md-nav__item">
|
|
2578
|
+
<a href="#next-steps" class="md-nav__link">
|
|
2579
|
+
<span class="md-ellipsis">
|
|
2580
|
+
|
|
2581
|
+
Next Steps
|
|
2582
|
+
|
|
2583
|
+
</span>
|
|
2584
|
+
</a>
|
|
2585
|
+
|
|
2586
|
+
</li>
|
|
2587
|
+
|
|
2588
|
+
</ul>
|
|
2589
|
+
|
|
2590
|
+
</nav>
|
|
2591
|
+
</div>
|
|
2592
|
+
</div>
|
|
2593
|
+
</div>
|
|
2594
|
+
|
|
2595
|
+
|
|
2596
|
+
|
|
2597
|
+
<div class="md-content" data-md-component="content">
|
|
2598
|
+
|
|
2599
|
+
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
|
|
2604
|
+
|
|
2605
|
+
<article class="md-content__inner md-typeset">
|
|
2606
|
+
|
|
2607
|
+
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
|
|
2611
|
+
<a href="https://github.com/madbomber/robot_lab/edit/main/docs/getting-started/installation.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
2612
|
+
|
|
2613
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
|
|
2614
|
+
</a>
|
|
2615
|
+
|
|
2616
|
+
|
|
2617
|
+
|
|
2618
|
+
|
|
2619
|
+
|
|
2620
|
+
<a href="https://github.com/madbomber/robot_lab/raw/main/docs/getting-started/installation.md" title="View source of this page" class="md-content__button md-icon">
|
|
2621
|
+
|
|
2622
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
|
|
2623
|
+
</a>
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
|
|
2627
|
+
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h1>
|
|
2628
|
+
<p>This guide covers installing RobotLab in your Ruby project.</p>
|
|
2629
|
+
<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">¶</a></h2>
|
|
2630
|
+
<ul>
|
|
2631
|
+
<li><strong>Ruby</strong>: 3.2 or higher</li>
|
|
2632
|
+
<li><strong>Bundler</strong>: 2.0 or higher (recommended)</li>
|
|
2633
|
+
</ul>
|
|
2634
|
+
<h2 id="install-via-bundler">Install via Bundler<a class="headerlink" href="#install-via-bundler" title="Permanent link">¶</a></h2>
|
|
2635
|
+
<p>Add RobotLab to your <code>Gemfile</code>:</p>
|
|
2636
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">gem</span><span class="w"> </span><span class="s2">"robot_lab"</span>
|
|
2637
|
+
</span></code></pre></div>
|
|
2638
|
+
<p>Then install:</p>
|
|
2639
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>bundle<span class="w"> </span>install
|
|
2640
|
+
</span></code></pre></div>
|
|
2641
|
+
<h2 id="install-via-rubygems">Install via RubyGems<a class="headerlink" href="#install-via-rubygems" title="Permanent link">¶</a></h2>
|
|
2642
|
+
<p>Or install directly:</p>
|
|
2643
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>gem<span class="w"> </span>install<span class="w"> </span>robot_lab
|
|
2644
|
+
</span></code></pre></div>
|
|
2645
|
+
<h2 id="dependencies">Dependencies<a class="headerlink" href="#dependencies" title="Permanent link">¶</a></h2>
|
|
2646
|
+
<p>RobotLab automatically installs these core dependencies:</p>
|
|
2647
|
+
<table>
|
|
2648
|
+
<thead>
|
|
2649
|
+
<tr>
|
|
2650
|
+
<th>Gem</th>
|
|
2651
|
+
<th>Purpose</th>
|
|
2652
|
+
</tr>
|
|
2653
|
+
</thead>
|
|
2654
|
+
<tbody>
|
|
2655
|
+
<tr>
|
|
2656
|
+
<td><code>ruby_llm</code> (~> 1.12)</td>
|
|
2657
|
+
<td>LLM provider integrations (Anthropic, OpenAI, Gemini, etc.)</td>
|
|
2658
|
+
</tr>
|
|
2659
|
+
<tr>
|
|
2660
|
+
<td><code>prompt_manager</code> (~> 1.0)</td>
|
|
2661
|
+
<td>Template-based prompt management with YAML front matter</td>
|
|
2662
|
+
</tr>
|
|
2663
|
+
<tr>
|
|
2664
|
+
<td><code>simple_flow</code> (~> 0.3)</td>
|
|
2665
|
+
<td>Pipeline workflow execution for networks</td>
|
|
2666
|
+
</tr>
|
|
2667
|
+
<tr>
|
|
2668
|
+
<td><code>myway_config</code> (~> 0.1)</td>
|
|
2669
|
+
<td>Layered configuration (defaults, env vars, config files)</td>
|
|
2670
|
+
</tr>
|
|
2671
|
+
<tr>
|
|
2672
|
+
<td><code>ruby_llm-mcp</code></td>
|
|
2673
|
+
<td>Model Context Protocol client for external tool servers</td>
|
|
2674
|
+
</tr>
|
|
2675
|
+
<tr>
|
|
2676
|
+
<td><code>ruby_llm-schema</code></td>
|
|
2677
|
+
<td>Schema validation for structured outputs</td>
|
|
2678
|
+
</tr>
|
|
2679
|
+
<tr>
|
|
2680
|
+
<td><code>ruby_llm-semantic_cache</code></td>
|
|
2681
|
+
<td>Semantic caching for LLM responses</td>
|
|
2682
|
+
</tr>
|
|
2683
|
+
<tr>
|
|
2684
|
+
<td><code>zeitwerk</code> (~> 2.6)</td>
|
|
2685
|
+
<td>Autoloading and eager loading</td>
|
|
2686
|
+
</tr>
|
|
2687
|
+
<tr>
|
|
2688
|
+
<td><code>async</code> (~> 2.0)</td>
|
|
2689
|
+
<td>Fiber-based concurrency</td>
|
|
2690
|
+
</tr>
|
|
2691
|
+
</tbody>
|
|
2692
|
+
</table>
|
|
2693
|
+
<h3 id="optional-dependencies">Optional Dependencies<a class="headerlink" href="#optional-dependencies" title="Permanent link">¶</a></h3>
|
|
2694
|
+
<p>For specific features, you may need additional gems:</p>
|
|
2695
|
+
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">MCP WebSocket Transport</label><label for="__tabbed_1_2">MCP HTTP Transport</label><label for="__tabbed_1_3">Rails Integration</label></div>
|
|
2696
|
+
<div class="tabbed-content">
|
|
2697
|
+
<div class="tabbed-block">
|
|
2698
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">gem</span><span class="w"> </span><span class="s2">"async-websocket"</span>
|
|
2699
|
+
</span></code></pre></div>
|
|
2700
|
+
</div>
|
|
2701
|
+
<div class="tabbed-block">
|
|
2702
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">gem</span><span class="w"> </span><span class="s2">"async-http"</span>
|
|
2703
|
+
</span></code></pre></div>
|
|
2704
|
+
</div>
|
|
2705
|
+
<div class="tabbed-block">
|
|
2706
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Rails is detected automatically</span>
|
|
2707
|
+
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="n">gem</span><span class="w"> </span><span class="s2">"rails"</span><span class="p">,</span><span class="w"> </span><span class="s2">">= 7.0"</span>
|
|
2708
|
+
</span></code></pre></div>
|
|
2709
|
+
</div>
|
|
2710
|
+
</div>
|
|
2711
|
+
</div>
|
|
2712
|
+
<h2 id="verify-installation">Verify Installation<a class="headerlink" href="#verify-installation" title="Permanent link">¶</a></h2>
|
|
2713
|
+
<p>Create a test file to verify everything works:</p>
|
|
2714
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># test_robot_lab.rb</span>
|
|
2715
|
+
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="nb">require</span><span class="w"> </span><span class="s2">"robot_lab"</span>
|
|
2716
|
+
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
|
|
2717
|
+
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="nb">puts</span><span class="w"> </span><span class="s2">"RobotLab version: </span><span class="si">#{</span><span class="no">RobotLab</span><span class="o">::</span><span class="no">VERSION</span><span class="si">}</span><span class="s2">"</span>
|
|
2718
|
+
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="nb">puts</span><span class="w"> </span><span class="s2">"Installation successful!"</span>
|
|
2719
|
+
</span></code></pre></div>
|
|
2720
|
+
<p>Run it:</p>
|
|
2721
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>ruby<span class="w"> </span>test_robot_lab.rb
|
|
2722
|
+
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="c1"># => RobotLab version: 0.1.0</span>
|
|
2723
|
+
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="c1"># => Installation successful!</span>
|
|
2724
|
+
</span></code></pre></div>
|
|
2725
|
+
<h2 id="rails-installation">Rails Installation<a class="headerlink" href="#rails-installation" title="Permanent link">¶</a></h2>
|
|
2726
|
+
<p>For Rails applications, use the install generator:</p>
|
|
2727
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>rails<span class="w"> </span>generate<span class="w"> </span>robot_lab:install
|
|
2728
|
+
</span></code></pre></div>
|
|
2729
|
+
<p>This creates:</p>
|
|
2730
|
+
<ul>
|
|
2731
|
+
<li><code>config/initializers/robot_lab.rb</code> - Configuration file</li>
|
|
2732
|
+
<li><code>db/migrate/*_create_robot_lab_tables.rb</code> - Database migrations</li>
|
|
2733
|
+
<li><code>app/models/robot_lab_thread.rb</code> - Thread model</li>
|
|
2734
|
+
<li><code>app/models/robot_lab_result.rb</code> - Result model</li>
|
|
2735
|
+
<li><code>app/robots/</code> - Directory for robot definitions</li>
|
|
2736
|
+
<li><code>app/tools/</code> - Directory for tool definitions</li>
|
|
2737
|
+
</ul>
|
|
2738
|
+
<p>Then run migrations:</p>
|
|
2739
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>rails<span class="w"> </span>db:migrate
|
|
2740
|
+
</span></code></pre></div>
|
|
2741
|
+
<h2 id="environment-setup">Environment Setup<a class="headerlink" href="#environment-setup" title="Permanent link">¶</a></h2>
|
|
2742
|
+
<p>RobotLab uses a layered configuration system (see <a href="../configuration/">Configuration</a> for full details). The simplest way to get started is with environment variables:</p>
|
|
2743
|
+
<div class="tabbed-set tabbed-alternate" data-tabs="2:3"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><input id="__tabbed_2_3" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">Anthropic (Recommended)</label><label for="__tabbed_2_2">OpenAI</label><label for="__tabbed_2_3">Google Gemini</label></div>
|
|
2744
|
+
<div class="tabbed-content">
|
|
2745
|
+
<div class="tabbed-block">
|
|
2746
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ROBOT_LAB_RUBY_LLM__ANTHROPIC_API_KEY</span><span class="o">=</span><span class="s2">"sk-ant-..."</span>
|
|
2747
|
+
</span></code></pre></div>
|
|
2748
|
+
</div>
|
|
2749
|
+
<div class="tabbed-block">
|
|
2750
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ROBOT_LAB_RUBY_LLM__OPENAI_API_KEY</span><span class="o">=</span><span class="s2">"sk-..."</span>
|
|
2751
|
+
</span></code></pre></div>
|
|
2752
|
+
</div>
|
|
2753
|
+
<div class="tabbed-block">
|
|
2754
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ROBOT_LAB_RUBY_LLM__GEMINI_API_KEY</span><span class="o">=</span><span class="s2">"..."</span>
|
|
2755
|
+
</span></code></pre></div>
|
|
2756
|
+
</div>
|
|
2757
|
+
</div>
|
|
2758
|
+
</div>
|
|
2759
|
+
<div class="admonition tip">
|
|
2760
|
+
<p class="admonition-title">Using dotenv</p>
|
|
2761
|
+
<p>For development, consider using the <a href="https://github.com/bkeepers/dotenv">dotenv</a> gem to manage environment variables:</p>
|
|
2762
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="c1"># Gemfile</span>
|
|
2763
|
+
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="n">gem</span><span class="w"> </span><span class="s2">"dotenv"</span><span class="p">,</span><span class="w"> </span><span class="ss">groups</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="ss">:development</span><span class="p">,</span><span class="w"> </span><span class="ss">:test</span><span class="o">]</span>
|
|
2764
|
+
</span></code></pre></div>
|
|
2765
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="c1"># .env</span>
|
|
2766
|
+
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="nv">ROBOT_LAB_RUBY_LLM__ANTHROPIC_API_KEY</span><span class="o">=</span>sk-ant-...
|
|
2767
|
+
</span></code></pre></div>
|
|
2768
|
+
</div>
|
|
2769
|
+
<div class="admonition info">
|
|
2770
|
+
<p class="admonition-title">Direct provider env vars</p>
|
|
2771
|
+
<p>RubyLLM also reads provider-specific environment variables directly (e.g., <code>ANTHROPIC_API_KEY</code>). If you already have those set, they will be picked up automatically. The <code>ROBOT_LAB_RUBY_LLM__*</code> prefix gives you explicit control through RobotLab's config layer.</p>
|
|
2772
|
+
</div>
|
|
2773
|
+
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">¶</a></h2>
|
|
2774
|
+
<h3 id="gem-installation-fails">Gem Installation Fails<a class="headerlink" href="#gem-installation-fails" title="Permanent link">¶</a></h3>
|
|
2775
|
+
<p>If you encounter SSL or network errors:</p>
|
|
2776
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="c1"># Update RubyGems</span>
|
|
2777
|
+
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>gem<span class="w"> </span>update<span class="w"> </span>--system
|
|
2778
|
+
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a>
|
|
2779
|
+
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="c1"># Try installing with verbose output</span>
|
|
2780
|
+
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a>gem<span class="w"> </span>install<span class="w"> </span>robot_lab<span class="w"> </span>--verbose
|
|
2781
|
+
</span></code></pre></div>
|
|
2782
|
+
<h3 id="missing-dependencies">Missing Dependencies<a class="headerlink" href="#missing-dependencies" title="Permanent link">¶</a></h3>
|
|
2783
|
+
<p>If you see "LoadError" for optional gems:</p>
|
|
2784
|
+
<div class="language-bash highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="c1"># Install the specific gem mentioned in the error</span>
|
|
2785
|
+
</span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>bundle<span class="w"> </span>add<span class="w"> </span>async-websocket
|
|
2786
|
+
</span></code></pre></div>
|
|
2787
|
+
<h3 id="api-key-issues">API Key Issues<a class="headerlink" href="#api-key-issues" title="Permanent link">¶</a></h3>
|
|
2788
|
+
<p>If you see authentication errors:</p>
|
|
2789
|
+
<ol>
|
|
2790
|
+
<li>Verify your API key is set: <code>echo $ROBOT_LAB_RUBY_LLM__ANTHROPIC_API_KEY</code></li>
|
|
2791
|
+
<li>Check the key is valid in your provider's console</li>
|
|
2792
|
+
<li>Ensure you're using the correct environment variable name</li>
|
|
2793
|
+
</ol>
|
|
2794
|
+
<h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">¶</a></h2>
|
|
2795
|
+
<p>Now that RobotLab is installed:</p>
|
|
2796
|
+
<ul>
|
|
2797
|
+
<li><a href="../quick-start/"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg></span> Quick Start</a> - Build your first robot</li>
|
|
2798
|
+
<li><a href="../configuration/"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg></span> Configuration</a> - Configure defaults</li>
|
|
2799
|
+
</ul>
|
|
2800
|
+
|
|
2801
|
+
|
|
2802
|
+
|
|
2803
|
+
|
|
2804
|
+
|
|
2805
|
+
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
|
|
2809
|
+
|
|
2810
|
+
|
|
2811
|
+
|
|
2812
|
+
|
|
2813
|
+
<form class="md-feedback" name="feedback" hidden>
|
|
2814
|
+
<fieldset>
|
|
2815
|
+
<legend class="md-feedback__title">
|
|
2816
|
+
Was this page helpful?
|
|
2817
|
+
</legend>
|
|
2818
|
+
<div class="md-feedback__inner">
|
|
2819
|
+
<div class="md-feedback__list">
|
|
2820
|
+
|
|
2821
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
|
|
2822
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg>
|
|
2823
|
+
</button>
|
|
2824
|
+
|
|
2825
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
|
|
2826
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg>
|
|
2827
|
+
</button>
|
|
2828
|
+
|
|
2829
|
+
</div>
|
|
2830
|
+
<div class="md-feedback__note">
|
|
2831
|
+
|
|
2832
|
+
<div data-md-value="1" hidden>
|
|
2833
|
+
|
|
2834
|
+
|
|
2835
|
+
|
|
2836
|
+
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
|
|
2840
|
+
|
|
2841
|
+
|
|
2842
|
+
Thanks for your feedback!
|
|
2843
|
+
</div>
|
|
2844
|
+
|
|
2845
|
+
<div data-md-value="0" hidden>
|
|
2846
|
+
|
|
2847
|
+
|
|
2848
|
+
|
|
2849
|
+
|
|
2850
|
+
|
|
2851
|
+
|
|
2852
|
+
|
|
2853
|
+
|
|
2854
|
+
|
|
2855
|
+
Thanks for your feedback! Help us improve by creating an issue.
|
|
2856
|
+
</div>
|
|
2857
|
+
|
|
2858
|
+
</div>
|
|
2859
|
+
</div>
|
|
2860
|
+
</fieldset>
|
|
2861
|
+
</form>
|
|
2862
|
+
|
|
2863
|
+
|
|
2864
|
+
|
|
2865
|
+
</article>
|
|
2866
|
+
</div>
|
|
2867
|
+
|
|
2868
|
+
|
|
2869
|
+
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
|
|
2870
|
+
|
|
2871
|
+
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
2872
|
+
</div>
|
|
2873
|
+
|
|
2874
|
+
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
2875
|
+
|
|
2876
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
|
2877
|
+
Back to top
|
|
2878
|
+
</button>
|
|
2879
|
+
|
|
2880
|
+
</main>
|
|
2881
|
+
|
|
2882
|
+
<footer class="md-footer">
|
|
2883
|
+
|
|
2884
|
+
|
|
2885
|
+
|
|
2886
|
+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
2887
|
+
|
|
2888
|
+
|
|
2889
|
+
<a href="../" class="md-footer__link md-footer__link--prev" aria-label="Previous: Getting Started">
|
|
2890
|
+
<div class="md-footer__button md-icon">
|
|
2891
|
+
|
|
2892
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
2893
|
+
</div>
|
|
2894
|
+
<div class="md-footer__title">
|
|
2895
|
+
<span class="md-footer__direction">
|
|
2896
|
+
Previous
|
|
2897
|
+
</span>
|
|
2898
|
+
<div class="md-ellipsis">
|
|
2899
|
+
Getting Started
|
|
2900
|
+
</div>
|
|
2901
|
+
</div>
|
|
2902
|
+
</a>
|
|
2903
|
+
|
|
2904
|
+
|
|
2905
|
+
|
|
2906
|
+
<a href="../quick-start/" class="md-footer__link md-footer__link--next" aria-label="Next: Quick Start">
|
|
2907
|
+
<div class="md-footer__title">
|
|
2908
|
+
<span class="md-footer__direction">
|
|
2909
|
+
Next
|
|
2910
|
+
</span>
|
|
2911
|
+
<div class="md-ellipsis">
|
|
2912
|
+
Quick Start
|
|
2913
|
+
</div>
|
|
2914
|
+
</div>
|
|
2915
|
+
<div class="md-footer__button md-icon">
|
|
2916
|
+
|
|
2917
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
|
2918
|
+
</div>
|
|
2919
|
+
</a>
|
|
2920
|
+
|
|
2921
|
+
</nav>
|
|
2922
|
+
|
|
2923
|
+
|
|
2924
|
+
<div class="md-footer-meta md-typeset">
|
|
2925
|
+
<div class="md-footer-meta__inner md-grid">
|
|
2926
|
+
<div class="md-copyright">
|
|
2927
|
+
|
|
2928
|
+
<div class="md-copyright__highlight">
|
|
2929
|
+
Copyright © 2025 Dewayne VanHoozer
|
|
2930
|
+
</div>
|
|
2931
|
+
|
|
2932
|
+
|
|
2933
|
+
Made with
|
|
2934
|
+
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
2935
|
+
Material for MkDocs
|
|
2936
|
+
</a>
|
|
2937
|
+
|
|
2938
|
+
</div>
|
|
2939
|
+
|
|
2940
|
+
|
|
2941
|
+
<div class="md-social">
|
|
2942
|
+
|
|
2943
|
+
|
|
2944
|
+
|
|
2945
|
+
|
|
2946
|
+
|
|
2947
|
+
<a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
|
|
2948
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
2949
|
+
</a>
|
|
2950
|
+
|
|
2951
|
+
|
|
2952
|
+
|
|
2953
|
+
|
|
2954
|
+
|
|
2955
|
+
<a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
|
|
2956
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M116.7 33.8c4.5-6.1 11.7-9.8 19.3-9.8h240c7.6 0 14.8 3.6 19.3 9.8l112 152c6.8 9.2 6.1 21.9-1.5 30.4l-232 256c-4.5 5-11 7.9-17.8 7.9s-13.2-2.9-17.8-7.9l-232-256c-7.7-8.5-8.3-21.2-1.5-30.4zm38.5 39.8c-3.3 2.5-4.2 7-2.1 10.5l57.4 95.7L63.3 192c-4.1.3-7.3 3.8-7.3 8s3.2 7.6 7.3 8l192 16h1.3l192-16c4.1-.3 7.3-3.8 7.3-8s-3.2-7.6-7.3-8l-147.2-12.3 57.4-95.6c2.1-3.5 1.2-8.1-2.1-10.5s-7.9-2-10.7 1l-90 97.6-90.1-97.6c-2.8-3-7.4-3.4-10.7-1"/></svg>
|
|
2957
|
+
</a>
|
|
2958
|
+
|
|
2959
|
+
</div>
|
|
2960
|
+
|
|
2961
|
+
</div>
|
|
2962
|
+
</div>
|
|
2963
|
+
</footer>
|
|
2964
|
+
|
|
2965
|
+
</div>
|
|
2966
|
+
<div class="md-dialog" data-md-component="dialog">
|
|
2967
|
+
<div class="md-dialog__inner md-typeset"></div>
|
|
2968
|
+
</div>
|
|
2969
|
+
|
|
2970
|
+
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
|
|
2974
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.path", "navigation.indexes", "navigation.top", "navigation.footer", "toc.follow", "search.suggest", "search.highlight", "search.share", "header.autohide", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.tooltips", "content.action.edit", "content.action.view"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
|
2975
|
+
|
|
2976
|
+
|
|
2977
|
+
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
2978
|
+
|
|
2979
|
+
|
|
2980
|
+
</body>
|
|
2981
|
+
</html>
|