-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathadvanced-tips.html
More file actions
403 lines (281 loc) · 17.9 KB
/
advanced-tips.html
File metadata and controls
403 lines (281 loc) · 17.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Advanced Tips — Vector SDK 0.7.2 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Downloads" href="downloads.html" />
<link rel="prev" title="Troubleshooting" href="troubleshooting.html" />
<script>
/**
* Developer.anki.com Iframe Integration
*/
(function(window) {
// Only apply if we're embedded
var parent = window.top;
if (parent === window || !parent || !parent.postMessage) {
return;
}
// For styling necessary only when embedded in an iframe.
function addEmbededClass() {
document.body.classList.add("embedded");
}
// Change document base to that of Developer.anki.com so that navigation happens at the top level.
function updateDocumentBase() {
var base = document.createElement('base');
base.target='_parent';
base.href= document.referrer;
var head = document.getElementsByTagName('head')[0];
var firstChild = head.firstChild;
head.insertBefore(base, firstChild);
}
// Signal to Developer.anki.com that we're done loading and ready to receive messages.
// We send page title to Developer.anki.com so that the browser displays it.
function notifyParentWindowOnLoad() {
parent.postMessage({
event: 'load',
docTitle: document.title
}, '*');
}
function initEmbeddedMode() {
addEmbededClass();
updateDocumentBase();
notifyParentWindowOnLoad();
}
if (document.readyState !== 'complete') {
window.addEventListener('load', function(){
initEmbeddedMode();
});
} else {
initEmbeddedMode();
}
// Handle messages from Developer.anki.com.
function receiveMessage(event) {
var eventName = event.data.event;
if(eventName === 'hashchange') {
window.location.hash = event.data.hash;
// Workaround for IOS Safari lack of support for window.location.hash scrolling.
var linkedElement = document.getElementById(event.data.hash.replace('#', ''))
if (linkedElement && linkedElement.scrollIntoView) {
linkedElement.scrollIntoView();
}
}
}
window.addEventListener("message", receiveMessage, false);
})(window);
</script>
<style>
/* Allows scrolling to anchor links on IOS Safari */
.embedded .wy-grid-for-nav {
position: fixed;
top: 0;
right: 0;
bottom: 0;
left: 0;
overflow-y: scroll;
-webkit-overflow-scrolling: touch;
z-index: 1;
}
</style>
<!-- <script async src='https://www.google-analytics.com/analytics.js'></script> -->
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Vector SDK
</a>
<div class="version">
0.7.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Installation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="initial.html">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-macos.html">Installation - macOS / OS X</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Installation - Windows</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Installation - Linux</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="advanced-tips.html#">Advanced Tips</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced-tips.html#moving-vector-between-wifi-networks">Moving Vector between WiFi networks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="advanced-tips.html#automatic-mdns-discovery">1. Automatic: mDNS Discovery</a></li>
<li class="toctree-l3"><a class="reference internal" href="advanced-tips.html#manual-update-configuration">2. Manual: Update Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="advanced-tips.html#using-multiple-vectors">Using multiple Vectors</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-tips.html#set-anki-robot-serial">Set ANKI_ROBOT_SERIAL</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-tips.html#set-anki-robot-host-and-vector-robot-name">Set ANKI_ROBOT_HOST and VECTOR_ROBOT_NAME</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-tips.html#keeping-vector-still-between-sdk-scripts">Keeping Vector Still Between SDK Scripts</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Downloads</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
</ul>
<p class="caption"><span class="caption-text">Get Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getstarted.html">Getting Started With the Vector SDK</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">The API</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Vector SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Advanced Tips</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/advanced-tips.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="advanced-tips">
<span id="id1"></span><h1>Advanced Tips<a class="headerlink" href="advanced-tips.html#advanced-tips" title="Permalink to this headline">¶</a></h1>
<div class="section" id="moving-vector-between-wifi-networks">
<span id="moving-between-wifi"></span><h2>Moving Vector between WiFi networks<a class="headerlink" href="advanced-tips.html#moving-vector-between-wifi-networks" title="Permalink to this headline">¶</a></h2>
<p>When you move Vector from one WiFi network to another (using the Vector App),
or if your Vector’s IP changes, the SDK will need to determine Vector’s new IP address.
There are two ways to accomplish this.</p>
<div class="section" id="automatic-mdns-discovery">
<h3>1. Automatic: mDNS Discovery<a class="headerlink" href="advanced-tips.html#automatic-mdns-discovery" title="Permalink to this headline">¶</a></h3>
<p>The SDK will automatically discover your Vector, even on a new WiFi network,
when you connect as follows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">anki_vector</span>
<span class="k">with</span> <span class="n">anki_vector</span><span class="o">.</span><span class="n">Robot</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"Vector-A1B2"</span><span class="p">)</span> <span class="k">as</span> <span class="n">robot</span><span class="p">:</span>
<span class="c1"># The sdk will try to connect to 'Vector A1B2',</span>
<span class="c1"># even if its IP address has changed.</span>
<span class="k">pass</span>
</pre></div>
</div>
<p>You will need to install the <code class="docutils literal notranslate"><span class="pre">zeroconf</span></code> package to use this feature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="o">--</span><span class="n">user</span> <span class="n">zeroconf</span>
</pre></div>
</div>
</div>
<div class="section" id="manual-update-configuration">
<h3>2. Manual: Update Configuration<a class="headerlink" href="advanced-tips.html#manual-update-configuration" title="Permalink to this headline">¶</a></h3>
<p>Alternatively, you can manually make changes to your SDK setup. To assist in this migration, the <code class="docutils literal notranslate"><span class="pre">anki_vector.configure</span></code>
executable submodule provides a <code class="docutils literal notranslate"><span class="pre">-u</span></code> parameter to quickly reconnect to Vector.</p>
<p>To update your connection, you will need to find the IP address on
Vector’s face, and the serial number of the robot you are updating.
Then from your terminal run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="o">-</span><span class="n">m</span> <span class="n">anki_vector</span><span class="o">.</span><span class="n">configure</span> <span class="o">-</span><span class="n">u</span> <span class="s2">"<your_new_ip>"</span> <span class="o">-</span><span class="n">s</span> <span class="s2">"<your_robot_serial_number>"</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="using-multiple-vectors">
<h2>Using multiple Vectors<a class="headerlink" href="advanced-tips.html#using-multiple-vectors" title="Permalink to this headline">¶</a></h2>
<p>If your device is configured to use more than one robot, you can specify
which robot you want to use by passing its serial number as a parameter
to the Robot constructor:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">anki_vector</span><span class="o">.</span><span class="n">Robot</span><span class="p">(</span><span class="s2">"00e20142"</span><span class="p">)</span> <span class="k">as</span> <span class="n">robot</span><span class="p">:</span>
<span class="n">robot</span><span class="o">.</span><span class="n">anim</span><span class="o">.</span><span class="n">play_animation_trigger</span><span class="p">(</span><span class="s2">"GreetAfterLongTime"</span><span class="p">)</span>
</pre></div>
</div>
<p>Alternatively, you can pass a <code class="docutils literal notranslate"><span class="pre">--serial</span></code> flag on the command
line, and <code class="docutils literal notranslate"><span class="pre">anki_vector.util.parse_command_args</span></code> will parse out
the serial number:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="mi">01</span><span class="n">_hello_world</span><span class="o">.</span><span class="n">py</span> <span class="o">--</span><span class="n">serial</span> <span class="mf">00e20142</span>
</pre></div>
</div>
</div>
<div class="section" id="set-anki-robot-serial">
<h2>Set ANKI_ROBOT_SERIAL<a class="headerlink" href="advanced-tips.html#set-anki-robot-serial" title="Permalink to this headline">¶</a></h2>
<p>In order to avoid entering Vector’s serial number for each program run,
you can create environment variable <code class="docutils literal notranslate"><span class="pre">ANKI_ROBOT_SERIAL</span></code>
and set it to Vector’s serial number:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">ANKI_ROBOT_SERIAL</span><span class="o">=</span><span class="mf">00e20100</span>
</pre></div>
</div>
</div>
<div class="section" id="set-anki-robot-host-and-vector-robot-name">
<h2>Set ANKI_ROBOT_HOST and VECTOR_ROBOT_NAME<a class="headerlink" href="advanced-tips.html#set-anki-robot-host-and-vector-robot-name" title="Permalink to this headline">¶</a></h2>
<p>When running the <code class="docutils literal notranslate"><span class="pre">anki_vector.configure</span></code> executable submodule, you must provide Vector’s ip and name.
To avoid typing these in, you can instead create environment variables
ANKI_ROBOT_HOST and VECTOR_ROBOT_NAME. Then <code class="docutils literal notranslate"><span class="pre">anki_vector.configure</span></code> will automatically pick
up those settings:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">ANKI_ROBOT_HOST</span><span class="o">=</span><span class="s2">"192.168.42.42"</span>
<span class="n">export</span> <span class="n">VECTOR_ROBOT_NAME</span><span class="o">=</span><span class="n">Vector</span><span class="o">-</span><span class="n">A1B2</span>
</pre></div>
</div>
</div>
<div class="section" id="keeping-vector-still-between-sdk-scripts">
<h2>Keeping Vector Still Between SDK Scripts<a class="headerlink" href="advanced-tips.html#keeping-vector-still-between-sdk-scripts" title="Permalink to this headline">¶</a></h2>
<p>Vector can be controlled so that (like Cozmo) he will not move between SDK scripts. There are three options for entering this mode of operation:</p>
<ul class="simple">
<li><p>Control can be reserved from the command prompt: <code class="docutils literal notranslate"><span class="pre">python3</span> <span class="pre">-m</span> <span class="pre">anki_vector.reserve_control</span></code> Vector will remain still between SDK scripts until the script/process is exited.</p></li>
<li><p>There are OS-specific scripts (Mac/Win) in the <code class="docutils literal notranslate"><span class="pre">examples/scripts/</span></code> folder that can be double-clicked to more easily reserve behavior control. The script will open in a new window; closing the window or otherwise stopping the script will release control back to the built-in robot behaviors.</p></li>
<li><p>A single Python file can explicitly reserve control using the <code class="docutils literal notranslate"><span class="pre">ReserveBehaviorControl</span></code> object. Consult the <code class="docutils literal notranslate"><span class="pre">anki_vector.connection</span></code> <a class="reference external" href="https://developer.anki.com/vector/docs/generated/anki_vector.connection.html">documentation</a> for more information.</p></li>
</ul>
<p>While normal robot behaviors are suppressed, Vector may look ‘broken’. Closing the SDK scripts, disconnecting from the
robot, or restarting the robot will all release behavior control.</p>
<hr class="docutils" />
<p><a class="reference external" href="https://www.anki.com/en-us/company/terms-and-conditions">Terms and Conditions</a> and <a class="reference external" href="https://www.anki.com/en-us/company/privacy">Privacy Policy</a></p>
<p><a class="reference external" href="https://developer.anki.com">Click here to return to the Anki Developer website.</a></p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="downloads.html" class="btn btn-neutral float-right" title="Downloads" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="troubleshooting.html" class="btn btn-neutral float-left" title="Troubleshooting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Anki
<span class="lastupdated">
Last updated on Mar, 06, 2020 11:52:06 GMT+01:00.
</span>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>