vector-sdk-docs/getstarted.html at master · Victor-Internal-Archive/vector-sdk-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
404
405


<!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>Getting Started With the Vector SDK &mdash; 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="The API" href="api.html" />
    <link rel="prev" title="Downloads" href="downloads.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>
<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"><a class="reference internal" href="advanced-tips.html">Advanced Tips</a></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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="getstarted.html#">Getting Started With the Vector SDK</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getstarted.html#anki-developer-forums">Anki Developer Forums</a></li>
<li class="toctree-l2"><a class="reference internal" href="getstarted.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="getstarted.html#starting-up-the-sdk">Starting Up the SDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="getstarted.html#example-program">Example Program</a><ul>
<li class="toctree-l3"><a class="reference internal" href="getstarted.html#first-steps-hello-world">First Steps - “Hello, World!”</a><ul>
<li class="toctree-l4"><a class="reference internal" href="getstarted.html#the-program">The Program</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</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> &raquo;</li>

      <li>Getting Started With the Vector SDK</li>


      <li class="wy-breadcrumbs-aside">


            <a href="_sources/getstarted.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="getting-started-with-the-vector-sdk">
<h1>Getting Started With the Vector SDK<a class="headerlink" href="getstarted.html#getting-started-with-the-vector-sdk" title="Permalink to this headline">¶</a></h1>
<p>To make sure you get the best experience possible out of the SDK, please ensure you have followed the steps in the <a class="reference internal" href="initial.html"><span class="doc">Initial Setup</span></a>.</p>
<div class="section" id="anki-developer-forums">
<h2>Anki Developer Forums<a class="headerlink" href="getstarted.html#anki-developer-forums" title="Permalink to this headline">¶</a></h2>
<p>Please visit our <a class="reference external" href="https://forums.anki.com/">Anki Developer Forums</a> where you can:</p>
<ul class="simple">
<li><p>Get assistance with your code</p></li>
<li><p>Hear about upcoming SDK additions</p></li>
<li><p>Share your work</p></li>
<li><p>Join discussion about the SDK</p></li>
<li><p>Be a part of the Vector SDK Community!</p></li>
</ul>
</div>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="getstarted.html#prerequisites" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>You have completed the Installation steps, found here: <a class="reference internal" href="initial.html#initial"><span class="std std-ref">Initial Setup</span></a></p></li>
<li><p>You have downloaded and extracted the example programs, found here: <a class="reference internal" href="downloads.html"><span class="doc">Downloads</span></a></p></li>
<li><p>The Vector companion app is <em>not</em> currently connected to Vector.</p></li>
<li><p>Vector is connected to the same network as your computer.</p></li>
<li><p>You can see Vector’s eyes on his screen.</p></li>
</ul>
</div>
<div class="section" id="starting-up-the-sdk">
<h2>Starting Up the SDK<a class="headerlink" href="getstarted.html#starting-up-the-sdk" title="Permalink to this headline">¶</a></h2>
<p>On the computer, open Terminal (macOS/Linux) or Command Prompt (Windows) and type <code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">anki_vector_sdk_examples</span></code>, where <em>anki_vector_sdk_examples</em> is the directory you extracted the examples into, and press <strong>Enter</strong>.</p>
</div>
<div class="section" id="example-program">
<h2>Example Program<a class="headerlink" href="getstarted.html#example-program" title="Permalink to this headline">¶</a></h2>
<div class="section" id="first-steps-hello-world">
<h3>First Steps - “Hello, World!”<a class="headerlink" href="getstarted.html#first-steps-hello-world" title="Permalink to this headline">¶</a></h3>
<p>Let’s test your new setup by running a very simple program. This program instructs Vector to say “Hello, World!” - a perfect way to introduce him and you to the world of programming.</p>
<div class="section" id="the-program">
<h4>The Program<a class="headerlink" href="getstarted.html#the-program" title="Permalink to this headline">¶</a></h4>
<ol class="arabic">
<li><p>Run the program using the same Terminal (macOS/Linux) / Command Prompt (Windows) window mentioned above. First, change to the <code class="docutils literal notranslate"><span class="pre">tutorials</span></code> sub-directory:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">tutorials</span>
</pre></div>
</div>
</li>
</ol>
<p>Then, run the program.</p>
<blockquote>
<div><ol class="loweralpha">
<li><p>For macOS and Ubuntu 18.04 systems, type the following and press <strong>Enter</strong>:</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>
</pre></div>
</div>
</li>
</ol>
<p>The same can also be achieved with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="mi">01</span><span class="n">_hello_world</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<ol class="loweralpha" start="2">
<li><p>For Windows systems, type the following and press <strong>Enter</strong>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">py</span> <span class="mi">01</span><span class="n">_hello_world</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
</li>
<li><p>For Ubuntu 16.04 systems, type the following and press <strong>Enter</strong>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span><span class="o">.</span><span class="mi">6</span> <span class="mi">01</span><span class="n">_hello_world</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
</li>
</ol>
</div></blockquote>
<ol class="arabic simple" start="2">
<li><p>If done correctly, Vector will say “Hello, World!”</p></li>
</ol>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If Vector does not perform as expected, look at the first Terminal window and make sure no error messages appeared. If you continue to have issues, please seek help in the Forums.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you have more than one Vector configured on your device, you can pass the serial number of the Vector you want to use at the command line:
<code class="docutils literal notranslate"><span class="pre">./01_hello_world.py</span> <span class="pre">--serial</span> <span class="pre">{robot_serial_number}</span></code></p>
</div>
<p>You are now all set up to run Python programs on Vector.</p>
<p>Now that you have run your own Vector program, take a look at the rest of the Vector SDK and at the many other example programs to get more ideas.</p>
<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>


           </div>

          </div>
          <footer>

    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

        <a href="api.html" class="btn btn-neutral float-right" title="The API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


        <a href="downloads.html" class="btn btn-neutral float-left" title="Downloads" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

    </div>


  <hr/>

  <div role="contentinfo">
    <p>
        &copy; 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>