├── .gitignore
├── LICENSE
├── README.md
└── docs
├── .nojekyll
├── _static
├── basic.css
├── css
│ ├── badge_only.css
│ ├── custom.css
│ ├── fonts
│ │ ├── Roboto-Slab-Bold.woff
│ │ ├── Roboto-Slab-Bold.woff2
│ │ ├── Roboto-Slab-Regular.woff
│ │ ├── Roboto-Slab-Regular.woff2
│ │ ├── fontawesome-webfont.eot
│ │ ├── fontawesome-webfont.svg
│ │ ├── fontawesome-webfont.ttf
│ │ ├── fontawesome-webfont.woff
│ │ ├── fontawesome-webfont.woff2
│ │ ├── lato-bold-italic.woff
│ │ ├── lato-bold-italic.woff2
│ │ ├── lato-bold.woff
│ │ ├── lato-bold.woff2
│ │ ├── lato-normal-italic.woff
│ │ ├── lato-normal-italic.woff2
│ │ ├── lato-normal.woff
│ │ └── lato-normal.woff2
│ └── theme.css
├── doctools.js
├── documentation_options.js
├── file.png
├── jquery-3.5.1.js
├── jquery.js
├── js
│ ├── badge_only.js
│ ├── html5shiv-printshiv.min.js
│ ├── html5shiv.min.js
│ └── theme.js
├── language_data.js
├── minus.png
├── plus.png
├── pygments.css
├── searchtools.js
├── style.css
├── underscore-1.12.0.js
└── underscore.js
├── class_bt_vcp.html
├── class_device.html
├── class_image.html
├── class_motor.html
├── class_motorpair.html
├── class_pin.html
├── class_port.html
├── class_usb_vcp.html
├── genindex.html
├── index.html
├── license.html
├── mod_battery.html
├── mod_bluetooth.html
├── mod_button.html
├── mod_display.html
├── mod_motion.html
├── mod_port.html
├── mod_sound.html
├── mod_supervision.html
├── objects.inv
├── pkg_hub.html
├── py-modindex.html
├── search.html
└── searchindex.js
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 The LEGO Group
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # MINDSTORMS® Robot Inventor hub API
2 |
3 | This repository contains the MicroPython documentation for the LEGO® MINDSTORMS Inventor Hub (set 51515). MicroPython is a small and efficient Python implementation that can run on the LEGO MINDSTORMS Inventor Hub.
4 |
5 | The LEGO Group has extended MicroPython with the hub package, which provides access to LEGO motors, sensors, and devices built into the hub.
6 |
7 | The documentation can be found here:
8 |
9 | Several standard MicroPython modules are also available on the hub. You can find documentation for those modules in the official [MicroPython](http://docs.micropython.org/en/v1.12/) documentation.
10 |
--------------------------------------------------------------------------------
/docs/.nojekyll:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/.nojekyll
--------------------------------------------------------------------------------
/docs/_static/basic.css:
--------------------------------------------------------------------------------
1 | /*
2 | * basic.css
3 | * ~~~~~~~~~
4 | *
5 | * Sphinx stylesheet -- basic theme.
6 | *
7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
8 | * :license: BSD, see LICENSE for details.
9 | *
10 | */
11 |
12 | /* -- main layout ----------------------------------------------------------- */
13 |
14 | div.clearer {
15 | clear: both;
16 | }
17 |
18 | div.section::after {
19 | display: block;
20 | content: '';
21 | clear: left;
22 | }
23 |
24 | /* -- relbar ---------------------------------------------------------------- */
25 |
26 | div.related {
27 | width: 100%;
28 | font-size: 90%;
29 | }
30 |
31 | div.related h3 {
32 | display: none;
33 | }
34 |
35 | div.related ul {
36 | margin: 0;
37 | padding: 0 0 0 10px;
38 | list-style: none;
39 | }
40 |
41 | div.related li {
42 | display: inline;
43 | }
44 |
45 | div.related li.right {
46 | float: right;
47 | margin-right: 5px;
48 | }
49 |
50 | /* -- sidebar --------------------------------------------------------------- */
51 |
52 | div.sphinxsidebarwrapper {
53 | padding: 10px 5px 0 10px;
54 | }
55 |
56 | div.sphinxsidebar {
57 | float: left;
58 | width: 230px;
59 | margin-left: -100%;
60 | font-size: 90%;
61 | word-wrap: break-word;
62 | overflow-wrap : break-word;
63 | }
64 |
65 | div.sphinxsidebar ul {
66 | list-style: none;
67 | }
68 |
69 | div.sphinxsidebar ul ul,
70 | div.sphinxsidebar ul.want-points {
71 | margin-left: 20px;
72 | list-style: square;
73 | }
74 |
75 | div.sphinxsidebar ul ul {
76 | margin-top: 0;
77 | margin-bottom: 0;
78 | }
79 |
80 | div.sphinxsidebar form {
81 | margin-top: 10px;
82 | }
83 |
84 | div.sphinxsidebar input {
85 | border: 1px solid #98dbcc;
86 | font-family: sans-serif;
87 | font-size: 1em;
88 | }
89 |
90 | div.sphinxsidebar #searchbox form.search {
91 | overflow: hidden;
92 | }
93 |
94 | div.sphinxsidebar #searchbox input[type="text"] {
95 | float: left;
96 | width: 80%;
97 | padding: 0.25em;
98 | box-sizing: border-box;
99 | }
100 |
101 | div.sphinxsidebar #searchbox input[type="submit"] {
102 | float: left;
103 | width: 20%;
104 | border-left: none;
105 | padding: 0.25em;
106 | box-sizing: border-box;
107 | }
108 |
109 |
110 | img {
111 | border: 0;
112 | max-width: 100%;
113 | }
114 |
115 | /* -- search page ----------------------------------------------------------- */
116 |
117 | ul.search {
118 | margin: 10px 0 0 20px;
119 | padding: 0;
120 | }
121 |
122 | ul.search li {
123 | padding: 5px 0 5px 20px;
124 | background-image: url(file.png);
125 | background-repeat: no-repeat;
126 | background-position: 0 7px;
127 | }
128 |
129 | ul.search li a {
130 | font-weight: bold;
131 | }
132 |
133 | ul.search li div.context {
134 | color: #888;
135 | margin: 2px 0 0 30px;
136 | text-align: left;
137 | }
138 |
139 | ul.keywordmatches li.goodmatch a {
140 | font-weight: bold;
141 | }
142 |
143 | /* -- index page ------------------------------------------------------------ */
144 |
145 | table.contentstable {
146 | width: 90%;
147 | margin-left: auto;
148 | margin-right: auto;
149 | }
150 |
151 | table.contentstable p.biglink {
152 | line-height: 150%;
153 | }
154 |
155 | a.biglink {
156 | font-size: 1.3em;
157 | }
158 |
159 | span.linkdescr {
160 | font-style: italic;
161 | padding-top: 5px;
162 | font-size: 90%;
163 | }
164 |
165 | /* -- general index --------------------------------------------------------- */
166 |
167 | table.indextable {
168 | width: 100%;
169 | }
170 |
171 | table.indextable td {
172 | text-align: left;
173 | vertical-align: top;
174 | }
175 |
176 | table.indextable ul {
177 | margin-top: 0;
178 | margin-bottom: 0;
179 | list-style-type: none;
180 | }
181 |
182 | table.indextable > tbody > tr > td > ul {
183 | padding-left: 0em;
184 | }
185 |
186 | table.indextable tr.pcap {
187 | height: 10px;
188 | }
189 |
190 | table.indextable tr.cap {
191 | margin-top: 10px;
192 | background-color: #f2f2f2;
193 | }
194 |
195 | img.toggler {
196 | margin-right: 3px;
197 | margin-top: 3px;
198 | cursor: pointer;
199 | }
200 |
201 | div.modindex-jumpbox {
202 | border-top: 1px solid #ddd;
203 | border-bottom: 1px solid #ddd;
204 | margin: 1em 0 1em 0;
205 | padding: 0.4em;
206 | }
207 |
208 | div.genindex-jumpbox {
209 | border-top: 1px solid #ddd;
210 | border-bottom: 1px solid #ddd;
211 | margin: 1em 0 1em 0;
212 | padding: 0.4em;
213 | }
214 |
215 | /* -- domain module index --------------------------------------------------- */
216 |
217 | table.modindextable td {
218 | padding: 2px;
219 | border-collapse: collapse;
220 | }
221 |
222 | /* -- general body styles --------------------------------------------------- */
223 |
224 | div.body {
225 | min-width: 450px;
226 | max-width: 800px;
227 | }
228 |
229 | div.body p, div.body dd, div.body li, div.body blockquote {
230 | -moz-hyphens: auto;
231 | -ms-hyphens: auto;
232 | -webkit-hyphens: auto;
233 | hyphens: auto;
234 | }
235 |
236 | a.headerlink {
237 | visibility: hidden;
238 | }
239 |
240 | a.brackets:before,
241 | span.brackets > a:before{
242 | content: "[";
243 | }
244 |
245 | a.brackets:after,
246 | span.brackets > a:after {
247 | content: "]";
248 | }
249 |
250 | h1:hover > a.headerlink,
251 | h2:hover > a.headerlink,
252 | h3:hover > a.headerlink,
253 | h4:hover > a.headerlink,
254 | h5:hover > a.headerlink,
255 | h6:hover > a.headerlink,
256 | dt:hover > a.headerlink,
257 | caption:hover > a.headerlink,
258 | p.caption:hover > a.headerlink,
259 | div.code-block-caption:hover > a.headerlink {
260 | visibility: visible;
261 | }
262 |
263 | div.body p.caption {
264 | text-align: inherit;
265 | }
266 |
267 | div.body td {
268 | text-align: left;
269 | }
270 |
271 | .first {
272 | margin-top: 0 !important;
273 | }
274 |
275 | p.rubric {
276 | margin-top: 30px;
277 | font-weight: bold;
278 | }
279 |
280 | img.align-left, .figure.align-left, object.align-left {
281 | clear: left;
282 | float: left;
283 | margin-right: 1em;
284 | }
285 |
286 | img.align-right, .figure.align-right, object.align-right {
287 | clear: right;
288 | float: right;
289 | margin-left: 1em;
290 | }
291 |
292 | img.align-center, .figure.align-center, object.align-center {
293 | display: block;
294 | margin-left: auto;
295 | margin-right: auto;
296 | }
297 |
298 | img.align-default, .figure.align-default {
299 | display: block;
300 | margin-left: auto;
301 | margin-right: auto;
302 | }
303 |
304 | .align-left {
305 | text-align: left;
306 | }
307 |
308 | .align-center {
309 | text-align: center;
310 | }
311 |
312 | .align-default {
313 | text-align: center;
314 | }
315 |
316 | .align-right {
317 | text-align: right;
318 | }
319 |
320 | /* -- sidebars -------------------------------------------------------------- */
321 |
322 | div.sidebar {
323 | margin: 0 0 0.5em 1em;
324 | border: 1px solid #ddb;
325 | padding: 7px;
326 | background-color: #ffe;
327 | width: 40%;
328 | float: right;
329 | clear: right;
330 | overflow-x: auto;
331 | }
332 |
333 | p.sidebar-title {
334 | font-weight: bold;
335 | }
336 |
337 | div.admonition, div.topic, blockquote {
338 | clear: left;
339 | }
340 |
341 | /* -- topics ---------------------------------------------------------------- */
342 |
343 | div.topic {
344 | border: 1px solid #ccc;
345 | padding: 7px;
346 | margin: 10px 0 10px 0;
347 | }
348 |
349 | p.topic-title {
350 | font-size: 1.1em;
351 | font-weight: bold;
352 | margin-top: 10px;
353 | }
354 |
355 | /* -- admonitions ----------------------------------------------------------- */
356 |
357 | div.admonition {
358 | margin-top: 10px;
359 | margin-bottom: 10px;
360 | padding: 7px;
361 | }
362 |
363 | div.admonition dt {
364 | font-weight: bold;
365 | }
366 |
367 | p.admonition-title {
368 | margin: 0px 10px 5px 0px;
369 | font-weight: bold;
370 | }
371 |
372 | div.body p.centered {
373 | text-align: center;
374 | margin-top: 25px;
375 | }
376 |
377 | /* -- content of sidebars/topics/admonitions -------------------------------- */
378 |
379 | div.sidebar > :last-child,
380 | div.topic > :last-child,
381 | div.admonition > :last-child {
382 | margin-bottom: 0;
383 | }
384 |
385 | div.sidebar::after,
386 | div.topic::after,
387 | div.admonition::after,
388 | blockquote::after {
389 | display: block;
390 | content: '';
391 | clear: both;
392 | }
393 |
394 | /* -- tables ---------------------------------------------------------------- */
395 |
396 | table.docutils {
397 | margin-top: 10px;
398 | margin-bottom: 10px;
399 | border: 0;
400 | border-collapse: collapse;
401 | }
402 |
403 | table.align-center {
404 | margin-left: auto;
405 | margin-right: auto;
406 | }
407 |
408 | table.align-default {
409 | margin-left: auto;
410 | margin-right: auto;
411 | }
412 |
413 | table caption span.caption-number {
414 | font-style: italic;
415 | }
416 |
417 | table caption span.caption-text {
418 | }
419 |
420 | table.docutils td, table.docutils th {
421 | padding: 1px 8px 1px 5px;
422 | border-top: 0;
423 | border-left: 0;
424 | border-right: 0;
425 | border-bottom: 1px solid #aaa;
426 | }
427 |
428 | table.footnote td, table.footnote th {
429 | border: 0 !important;
430 | }
431 |
432 | th {
433 | text-align: left;
434 | padding-right: 5px;
435 | }
436 |
437 | table.citation {
438 | border-left: solid 1px gray;
439 | margin-left: 1px;
440 | }
441 |
442 | table.citation td {
443 | border-bottom: none;
444 | }
445 |
446 | th > :first-child,
447 | td > :first-child {
448 | margin-top: 0px;
449 | }
450 |
451 | th > :last-child,
452 | td > :last-child {
453 | margin-bottom: 0px;
454 | }
455 |
456 | /* -- figures --------------------------------------------------------------- */
457 |
458 | div.figure {
459 | margin: 0.5em;
460 | padding: 0.5em;
461 | }
462 |
463 | div.figure p.caption {
464 | padding: 0.3em;
465 | }
466 |
467 | div.figure p.caption span.caption-number {
468 | font-style: italic;
469 | }
470 |
471 | div.figure p.caption span.caption-text {
472 | }
473 |
474 | /* -- field list styles ----------------------------------------------------- */
475 |
476 | table.field-list td, table.field-list th {
477 | border: 0 !important;
478 | }
479 |
480 | .field-list ul {
481 | margin: 0;
482 | padding-left: 1em;
483 | }
484 |
485 | .field-list p {
486 | margin: 0;
487 | }
488 |
489 | .field-name {
490 | -moz-hyphens: manual;
491 | -ms-hyphens: manual;
492 | -webkit-hyphens: manual;
493 | hyphens: manual;
494 | }
495 |
496 | /* -- hlist styles ---------------------------------------------------------- */
497 |
498 | table.hlist {
499 | margin: 1em 0;
500 | }
501 |
502 | table.hlist td {
503 | vertical-align: top;
504 | }
505 |
506 |
507 | /* -- other body styles ----------------------------------------------------- */
508 |
509 | ol.arabic {
510 | list-style: decimal;
511 | }
512 |
513 | ol.loweralpha {
514 | list-style: lower-alpha;
515 | }
516 |
517 | ol.upperalpha {
518 | list-style: upper-alpha;
519 | }
520 |
521 | ol.lowerroman {
522 | list-style: lower-roman;
523 | }
524 |
525 | ol.upperroman {
526 | list-style: upper-roman;
527 | }
528 |
529 | :not(li) > ol > li:first-child > :first-child,
530 | :not(li) > ul > li:first-child > :first-child {
531 | margin-top: 0px;
532 | }
533 |
534 | :not(li) > ol > li:last-child > :last-child,
535 | :not(li) > ul > li:last-child > :last-child {
536 | margin-bottom: 0px;
537 | }
538 |
539 | ol.simple ol p,
540 | ol.simple ul p,
541 | ul.simple ol p,
542 | ul.simple ul p {
543 | margin-top: 0;
544 | }
545 |
546 | ol.simple > li:not(:first-child) > p,
547 | ul.simple > li:not(:first-child) > p {
548 | margin-top: 0;
549 | }
550 |
551 | ol.simple p,
552 | ul.simple p {
553 | margin-bottom: 0;
554 | }
555 |
556 | dl.footnote > dt,
557 | dl.citation > dt {
558 | float: left;
559 | margin-right: 0.5em;
560 | }
561 |
562 | dl.footnote > dd,
563 | dl.citation > dd {
564 | margin-bottom: 0em;
565 | }
566 |
567 | dl.footnote > dd:after,
568 | dl.citation > dd:after {
569 | content: "";
570 | clear: both;
571 | }
572 |
573 | dl.field-list {
574 | display: grid;
575 | grid-template-columns: fit-content(30%) auto;
576 | }
577 |
578 | dl.field-list > dt {
579 | font-weight: bold;
580 | word-break: break-word;
581 | padding-left: 0.5em;
582 | padding-right: 5px;
583 | }
584 |
585 | dl.field-list > dt:after {
586 | content: ":";
587 | }
588 |
589 | dl.field-list > dd {
590 | padding-left: 0.5em;
591 | margin-top: 0em;
592 | margin-left: 0em;
593 | margin-bottom: 0em;
594 | }
595 |
596 | dl {
597 | margin-bottom: 15px;
598 | }
599 |
600 | dd > :first-child {
601 | margin-top: 0px;
602 | }
603 |
604 | dd ul, dd table {
605 | margin-bottom: 10px;
606 | }
607 |
608 | dd {
609 | margin-top: 3px;
610 | margin-bottom: 10px;
611 | margin-left: 30px;
612 | }
613 |
614 | dl > dd:last-child,
615 | dl > dd:last-child > :last-child {
616 | margin-bottom: 0;
617 | }
618 |
619 | dt:target, span.highlighted {
620 | background-color: #fbe54e;
621 | }
622 |
623 | rect.highlighted {
624 | fill: #fbe54e;
625 | }
626 |
627 | dl.glossary dt {
628 | font-weight: bold;
629 | font-size: 1.1em;
630 | }
631 |
632 | .optional {
633 | font-size: 1.3em;
634 | }
635 |
636 | .sig-paren {
637 | font-size: larger;
638 | }
639 |
640 | .versionmodified {
641 | font-style: italic;
642 | }
643 |
644 | .system-message {
645 | background-color: #fda;
646 | padding: 5px;
647 | border: 3px solid red;
648 | }
649 |
650 | .footnote:target {
651 | background-color: #ffa;
652 | }
653 |
654 | .line-block {
655 | display: block;
656 | margin-top: 1em;
657 | margin-bottom: 1em;
658 | }
659 |
660 | .line-block .line-block {
661 | margin-top: 0;
662 | margin-bottom: 0;
663 | margin-left: 1.5em;
664 | }
665 |
666 | .guilabel, .menuselection {
667 | font-family: sans-serif;
668 | }
669 |
670 | .accelerator {
671 | text-decoration: underline;
672 | }
673 |
674 | .classifier {
675 | font-style: oblique;
676 | }
677 |
678 | .classifier:before {
679 | font-style: normal;
680 | margin: 0.5em;
681 | content: ":";
682 | }
683 |
684 | abbr, acronym {
685 | border-bottom: dotted 1px;
686 | cursor: help;
687 | }
688 |
689 | /* -- code displays --------------------------------------------------------- */
690 |
691 | pre {
692 | overflow: auto;
693 | overflow-y: hidden; /* fixes display issues on Chrome browsers */
694 | }
695 |
696 | pre, div[class*="highlight-"] {
697 | clear: both;
698 | }
699 |
700 | span.pre {
701 | -moz-hyphens: none;
702 | -ms-hyphens: none;
703 | -webkit-hyphens: none;
704 | hyphens: none;
705 | }
706 |
707 | div[class*="highlight-"] {
708 | margin: 1em 0;
709 | }
710 |
711 | td.linenos pre {
712 | border: 0;
713 | background-color: transparent;
714 | color: #aaa;
715 | }
716 |
717 | table.highlighttable {
718 | display: block;
719 | }
720 |
721 | table.highlighttable tbody {
722 | display: block;
723 | }
724 |
725 | table.highlighttable tr {
726 | display: flex;
727 | }
728 |
729 | table.highlighttable td {
730 | margin: 0;
731 | padding: 0;
732 | }
733 |
734 | table.highlighttable td.linenos {
735 | padding-right: 0.5em;
736 | }
737 |
738 | table.highlighttable td.code {
739 | flex: 1;
740 | overflow: hidden;
741 | }
742 |
743 | .highlight .hll {
744 | display: block;
745 | }
746 |
747 | div.highlight pre,
748 | table.highlighttable pre {
749 | margin: 0;
750 | }
751 |
752 | div.code-block-caption + div {
753 | margin-top: 0;
754 | }
755 |
756 | div.code-block-caption {
757 | margin-top: 1em;
758 | padding: 2px 5px;
759 | font-size: small;
760 | }
761 |
762 | div.code-block-caption code {
763 | background-color: transparent;
764 | }
765 |
766 | table.highlighttable td.linenos,
767 | span.linenos,
768 | div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
769 | user-select: none;
770 | }
771 |
772 | div.code-block-caption span.caption-number {
773 | padding: 0.1em 0.3em;
774 | font-style: italic;
775 | }
776 |
777 | div.code-block-caption span.caption-text {
778 | }
779 |
780 | div.literal-block-wrapper {
781 | margin: 1em 0;
782 | }
783 |
784 | code.descname {
785 | background-color: transparent;
786 | font-weight: bold;
787 | font-size: 1.2em;
788 | }
789 |
790 | code.descclassname {
791 | background-color: transparent;
792 | }
793 |
794 | code.xref, a code {
795 | background-color: transparent;
796 | font-weight: bold;
797 | }
798 |
799 | h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
800 | background-color: transparent;
801 | }
802 |
803 | .viewcode-link {
804 | float: right;
805 | }
806 |
807 | .viewcode-back {
808 | float: right;
809 | font-family: sans-serif;
810 | }
811 |
812 | div.viewcode-block:target {
813 | margin: -1px -10px;
814 | padding: 0 10px;
815 | }
816 |
817 | /* -- math display ---------------------------------------------------------- */
818 |
819 | img.math {
820 | vertical-align: middle;
821 | }
822 |
823 | div.body div.math p {
824 | text-align: center;
825 | }
826 |
827 | span.eqno {
828 | float: right;
829 | }
830 |
831 | span.eqno a.headerlink {
832 | position: absolute;
833 | z-index: 1;
834 | }
835 |
836 | div.math:hover a.headerlink {
837 | visibility: visible;
838 | }
839 |
840 | /* -- printout stylesheet --------------------------------------------------- */
841 |
842 | @media print {
843 | div.document,
844 | div.documentwrapper,
845 | div.bodywrapper {
846 | margin: 0 !important;
847 | width: 100%;
848 | }
849 |
850 | div.sphinxsidebar,
851 | div.related,
852 | div.footer,
853 | #top-link {
854 | display: none;
855 | }
856 | }
--------------------------------------------------------------------------------
/docs/_static/css/badge_only.css:
--------------------------------------------------------------------------------
1 | .fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
--------------------------------------------------------------------------------
/docs/_static/css/custom.css:
--------------------------------------------------------------------------------
1 | @import url(//db.onlinewebfonts.com/c/917a69d24b88e2d4d2ca803c0605bd59?family=CeraPRO-Regular);
2 | @font-face {
3 | font-family: "CeraPRO-Regular";
4 | src: url("//db.onlinewebfonts.com/t/917a69d24b88e2d4d2ca803c0605bd59.eot");
5 | src: url("//db.onlinewebfonts.com/t/917a69d24b88e2d4d2ca803c0605bd59.eot?#iefix") format("embedded-opentype"),
6 | url("//db.onlinewebfonts.com/t/917a69d24b88e2d4d2ca803c0605bd59.woff2") format("woff2"),
7 | url("//db.onlinewebfonts.com/t/917a69d24b88e2d4d2ca803c0605bd59.woff") format("woff"),
8 | url("//db.onlinewebfonts.com/t/917a69d24b88e2d4d2ca803c0605bd59.ttf") format("truetype"),
9 | url("//db.onlinewebfonts.com/t/917a69d24b88e2d4d2ca803c0605bd59.svg#CeraPRO-Regular") format("svg");
10 | }
11 | body{
12 |
13 | font-family: "CeraPRO-Regular", "CeraPRO-Regular", woff2;
14 | }
--------------------------------------------------------------------------------
/docs/_static/css/fonts/Roboto-Slab-Bold.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/Roboto-Slab-Bold.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/Roboto-Slab-Bold.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/Roboto-Slab-Bold.woff2
--------------------------------------------------------------------------------
/docs/_static/css/fonts/Roboto-Slab-Regular.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/Roboto-Slab-Regular.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/Roboto-Slab-Regular.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/Roboto-Slab-Regular.woff2
--------------------------------------------------------------------------------
/docs/_static/css/fonts/fontawesome-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/fontawesome-webfont.eot
--------------------------------------------------------------------------------
/docs/_static/css/fonts/fontawesome-webfont.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/fontawesome-webfont.ttf
--------------------------------------------------------------------------------
/docs/_static/css/fonts/fontawesome-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/fontawesome-webfont.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/fontawesome-webfont.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/fontawesome-webfont.woff2
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-bold-italic.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-bold-italic.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-bold-italic.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-bold-italic.woff2
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-bold.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-bold.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-bold.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-bold.woff2
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-normal-italic.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-normal-italic.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-normal-italic.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-normal-italic.woff2
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-normal.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-normal.woff
--------------------------------------------------------------------------------
/docs/_static/css/fonts/lato-normal.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/css/fonts/lato-normal.woff2
--------------------------------------------------------------------------------
/docs/_static/doctools.js:
--------------------------------------------------------------------------------
1 | /*
2 | * doctools.js
3 | * ~~~~~~~~~~~
4 | *
5 | * Sphinx JavaScript utilities for all documentation.
6 | *
7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
8 | * :license: BSD, see LICENSE for details.
9 | *
10 | */
11 |
12 | /**
13 | * select a different prefix for underscore
14 | */
15 | $u = _.noConflict();
16 |
17 | /**
18 | * make the code below compatible with browsers without
19 | * an installed firebug like debugger
20 | if (!window.console || !console.firebug) {
21 | var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
22 | "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
23 | "profile", "profileEnd"];
24 | window.console = {};
25 | for (var i = 0; i < names.length; ++i)
26 | window.console[names[i]] = function() {};
27 | }
28 | */
29 |
30 | /**
31 | * small helper function to urldecode strings
32 | *
33 | * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
34 | */
35 | jQuery.urldecode = function(x) {
36 | if (!x) {
37 | return x
38 | }
39 | return decodeURIComponent(x.replace(/\+/g, ' '));
40 | };
41 |
42 | /**
43 | * small helper function to urlencode strings
44 | */
45 | jQuery.urlencode = encodeURIComponent;
46 |
47 | /**
48 | * This function returns the parsed url parameters of the
49 | * current request. Multiple values per key are supported,
50 | * it will always return arrays of strings for the value parts.
51 | */
52 | jQuery.getQueryParameters = function(s) {
53 | if (typeof s === 'undefined')
54 | s = document.location.search;
55 | var parts = s.substr(s.indexOf('?') + 1).split('&');
56 | var result = {};
57 | for (var i = 0; i < parts.length; i++) {
58 | var tmp = parts[i].split('=', 2);
59 | var key = jQuery.urldecode(tmp[0]);
60 | var value = jQuery.urldecode(tmp[1]);
61 | if (key in result)
62 | result[key].push(value);
63 | else
64 | result[key] = [value];
65 | }
66 | return result;
67 | };
68 |
69 | /**
70 | * highlight a given string on a jquery object by wrapping it in
71 | * span elements with the given class name.
72 | */
73 | jQuery.fn.highlightText = function(text, className) {
74 | function highlight(node, addItems) {
75 | if (node.nodeType === 3) {
76 | var val = node.nodeValue;
77 | var pos = val.toLowerCase().indexOf(text);
78 | if (pos >= 0 &&
79 | !jQuery(node.parentNode).hasClass(className) &&
80 | !jQuery(node.parentNode).hasClass("nohighlight")) {
81 | var span;
82 | var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
83 | if (isInSVG) {
84 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
85 | } else {
86 | span = document.createElement("span");
87 | span.className = className;
88 | }
89 | span.appendChild(document.createTextNode(val.substr(pos, text.length)));
90 | node.parentNode.insertBefore(span, node.parentNode.insertBefore(
91 | document.createTextNode(val.substr(pos + text.length)),
92 | node.nextSibling));
93 | node.nodeValue = val.substr(0, pos);
94 | if (isInSVG) {
95 | var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
96 | var bbox = node.parentElement.getBBox();
97 | rect.x.baseVal.value = bbox.x;
98 | rect.y.baseVal.value = bbox.y;
99 | rect.width.baseVal.value = bbox.width;
100 | rect.height.baseVal.value = bbox.height;
101 | rect.setAttribute('class', className);
102 | addItems.push({
103 | "parent": node.parentNode,
104 | "target": rect});
105 | }
106 | }
107 | }
108 | else if (!jQuery(node).is("button, select, textarea")) {
109 | jQuery.each(node.childNodes, function() {
110 | highlight(this, addItems);
111 | });
112 | }
113 | }
114 | var addItems = [];
115 | var result = this.each(function() {
116 | highlight(this, addItems);
117 | });
118 | for (var i = 0; i < addItems.length; ++i) {
119 | jQuery(addItems[i].parent).before(addItems[i].target);
120 | }
121 | return result;
122 | };
123 |
124 | /*
125 | * backward compatibility for jQuery.browser
126 | * This will be supported until firefox bug is fixed.
127 | */
128 | if (!jQuery.browser) {
129 | jQuery.uaMatch = function(ua) {
130 | ua = ua.toLowerCase();
131 |
132 | var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
133 | /(webkit)[ \/]([\w.]+)/.exec(ua) ||
134 | /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
135 | /(msie) ([\w.]+)/.exec(ua) ||
136 | ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
137 | [];
138 |
139 | return {
140 | browser: match[ 1 ] || "",
141 | version: match[ 2 ] || "0"
142 | };
143 | };
144 | jQuery.browser = {};
145 | jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
146 | }
147 |
148 | /**
149 | * Small JavaScript module for the documentation.
150 | */
151 | var Documentation = {
152 |
153 | init : function() {
154 | this.fixFirefoxAnchorBug();
155 | this.highlightSearchWords();
156 | this.initIndexTable();
157 | if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
158 | this.initOnKeyListeners();
159 | }
160 | },
161 |
162 | /**
163 | * i18n support
164 | */
165 | TRANSLATIONS : {},
166 | PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
167 | LOCALE : 'unknown',
168 |
169 | // gettext and ngettext don't access this so that the functions
170 | // can safely bound to a different name (_ = Documentation.gettext)
171 | gettext : function(string) {
172 | var translated = Documentation.TRANSLATIONS[string];
173 | if (typeof translated === 'undefined')
174 | return string;
175 | return (typeof translated === 'string') ? translated : translated[0];
176 | },
177 |
178 | ngettext : function(singular, plural, n) {
179 | var translated = Documentation.TRANSLATIONS[singular];
180 | if (typeof translated === 'undefined')
181 | return (n == 1) ? singular : plural;
182 | return translated[Documentation.PLURALEXPR(n)];
183 | },
184 |
185 | addTranslations : function(catalog) {
186 | for (var key in catalog.messages)
187 | this.TRANSLATIONS[key] = catalog.messages[key];
188 | this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
189 | this.LOCALE = catalog.locale;
190 | },
191 |
192 | /**
193 | * add context elements like header anchor links
194 | */
195 | addContextElements : function() {
196 | $('div[id] > :header:first').each(function() {
197 | $('').
198 | attr('href', '#' + this.id).
199 | attr('title', _('Permalink to this headline')).
200 | appendTo(this);
201 | });
202 | $('dt[id]').each(function() {
203 | $('').
204 | attr('href', '#' + this.id).
205 | attr('title', _('Permalink to this definition')).
206 | appendTo(this);
207 | });
208 | },
209 |
210 | /**
211 | * workaround a firefox stupidity
212 | * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
213 | */
214 | fixFirefoxAnchorBug : function() {
215 | if (document.location.hash && $.browser.mozilla)
216 | window.setTimeout(function() {
217 | document.location.href += '';
218 | }, 10);
219 | },
220 |
221 | /**
222 | * highlight the search words provided in the url in the text
223 | */
224 | highlightSearchWords : function() {
225 | var params = $.getQueryParameters();
226 | var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
227 | if (terms.length) {
228 | var body = $('div.body');
229 | if (!body.length) {
230 | body = $('body');
231 | }
232 | window.setTimeout(function() {
233 | $.each(terms, function() {
234 | body.highlightText(this.toLowerCase(), 'highlighted');
235 | });
236 | }, 10);
237 | $('
' + _('Hide Search Matches') + '
')
239 | .appendTo($('#searchbox'));
240 | }
241 | },
242 |
243 | /**
244 | * init the domain index toggle buttons
245 | */
246 | initIndexTable : function() {
247 | var togglers = $('img.toggler').click(function() {
248 | var src = $(this).attr('src');
249 | var idnum = $(this).attr('id').substr(7);
250 | $('tr.cg-' + idnum).toggle();
251 | if (src.substr(-9) === 'minus.png')
252 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
253 | else
254 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
255 | }).css('display', '');
256 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
257 | togglers.click();
258 | }
259 | },
260 |
261 | /**
262 | * helper function to hide the search marks again
263 | */
264 | hideSearchWords : function() {
265 | $('#searchbox .highlight-link').fadeOut(300);
266 | $('span.highlighted').removeClass('highlighted');
267 | },
268 |
269 | /**
270 | * make the url absolute
271 | */
272 | makeURL : function(relativeURL) {
273 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
274 | },
275 |
276 | /**
277 | * get the current relative url
278 | */
279 | getCurrentURL : function() {
280 | var path = document.location.pathname;
281 | var parts = path.split(/\//);
282 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
283 | if (this === '..')
284 | parts.pop();
285 | });
286 | var url = parts.join('/');
287 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
288 | },
289 |
290 | initOnKeyListeners: function() {
291 | $(document).keydown(function(event) {
292 | var activeElementType = document.activeElement.tagName;
293 | // don't navigate when in search box, textarea, dropdown or button
294 | if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
295 | && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
296 | && !event.shiftKey) {
297 | switch (event.keyCode) {
298 | case 37: // left
299 | var prevHref = $('link[rel="prev"]').prop('href');
300 | if (prevHref) {
301 | window.location.href = prevHref;
302 | return false;
303 | }
304 | case 39: // right
305 | var nextHref = $('link[rel="next"]').prop('href');
306 | if (nextHref) {
307 | window.location.href = nextHref;
308 | return false;
309 | }
310 | }
311 | }
312 | });
313 | }
314 | };
315 |
316 | // quick alias for translations
317 | _ = Documentation.gettext;
318 |
319 | $(document).ready(function() {
320 | Documentation.init();
321 | });
322 |
--------------------------------------------------------------------------------
/docs/_static/documentation_options.js:
--------------------------------------------------------------------------------
1 | var DOCUMENTATION_OPTIONS = {
2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3 | VERSION: '',
4 | LANGUAGE: 'None',
5 | COLLAPSE_INDEX: false,
6 | BUILDER: 'html',
7 | FILE_SUFFIX: '.html',
8 | LINK_SUFFIX: '.html',
9 | HAS_SOURCE: true,
10 | SOURCELINK_SUFFIX: '.txt',
11 | NAVIGATION_WITH_KEYS: false
12 | };
--------------------------------------------------------------------------------
/docs/_static/file.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/file.png
--------------------------------------------------------------------------------
/docs/_static/js/badge_only.js:
--------------------------------------------------------------------------------
1 | !function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
--------------------------------------------------------------------------------
/docs/_static/js/html5shiv-printshiv.min.js:
--------------------------------------------------------------------------------
1 | /**
2 | * @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
3 | */
4 | !function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML=" ",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);
--------------------------------------------------------------------------------
/docs/_static/js/html5shiv.min.js:
--------------------------------------------------------------------------------
1 | /**
2 | * @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
3 | */
4 | !function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML=" ",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
--------------------------------------------------------------------------------
/docs/_static/js/theme.js:
--------------------------------------------------------------------------------
1 | !function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap(""),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(' '),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}t.length>0&&($(".wy-menu-vertical .current").removeClass("current"),t.addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l1").parent().addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l2").addClass("current"),t.closest("li.toctree-l3").addClass("current"),t.closest("li.toctree-l4").addClass("current"),t.closest("li.toctree-l5").addClass("current"),t[0].scrollIntoView())}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0
63 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
64 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
65 | var s_v = "^(" + C + ")?" + v; // vowel in stem
66 |
67 | this.stemWord = function (w) {
68 | var stem;
69 | var suffix;
70 | var firstch;
71 | var origword = w;
72 |
73 | if (w.length < 3)
74 | return w;
75 |
76 | var re;
77 | var re2;
78 | var re3;
79 | var re4;
80 |
81 | firstch = w.substr(0,1);
82 | if (firstch == "y")
83 | w = firstch.toUpperCase() + w.substr(1);
84 |
85 | // Step 1a
86 | re = /^(.+?)(ss|i)es$/;
87 | re2 = /^(.+?)([^s])s$/;
88 |
89 | if (re.test(w))
90 | w = w.replace(re,"$1$2");
91 | else if (re2.test(w))
92 | w = w.replace(re2,"$1$2");
93 |
94 | // Step 1b
95 | re = /^(.+?)eed$/;
96 | re2 = /^(.+?)(ed|ing)$/;
97 | if (re.test(w)) {
98 | var fp = re.exec(w);
99 | re = new RegExp(mgr0);
100 | if (re.test(fp[1])) {
101 | re = /.$/;
102 | w = w.replace(re,"");
103 | }
104 | }
105 | else if (re2.test(w)) {
106 | var fp = re2.exec(w);
107 | stem = fp[1];
108 | re2 = new RegExp(s_v);
109 | if (re2.test(stem)) {
110 | w = stem;
111 | re2 = /(at|bl|iz)$/;
112 | re3 = new RegExp("([^aeiouylsz])\\1$");
113 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
114 | if (re2.test(w))
115 | w = w + "e";
116 | else if (re3.test(w)) {
117 | re = /.$/;
118 | w = w.replace(re,"");
119 | }
120 | else if (re4.test(w))
121 | w = w + "e";
122 | }
123 | }
124 |
125 | // Step 1c
126 | re = /^(.+?)y$/;
127 | if (re.test(w)) {
128 | var fp = re.exec(w);
129 | stem = fp[1];
130 | re = new RegExp(s_v);
131 | if (re.test(stem))
132 | w = stem + "i";
133 | }
134 |
135 | // Step 2
136 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
137 | if (re.test(w)) {
138 | var fp = re.exec(w);
139 | stem = fp[1];
140 | suffix = fp[2];
141 | re = new RegExp(mgr0);
142 | if (re.test(stem))
143 | w = stem + step2list[suffix];
144 | }
145 |
146 | // Step 3
147 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
148 | if (re.test(w)) {
149 | var fp = re.exec(w);
150 | stem = fp[1];
151 | suffix = fp[2];
152 | re = new RegExp(mgr0);
153 | if (re.test(stem))
154 | w = stem + step3list[suffix];
155 | }
156 |
157 | // Step 4
158 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
159 | re2 = /^(.+?)(s|t)(ion)$/;
160 | if (re.test(w)) {
161 | var fp = re.exec(w);
162 | stem = fp[1];
163 | re = new RegExp(mgr1);
164 | if (re.test(stem))
165 | w = stem;
166 | }
167 | else if (re2.test(w)) {
168 | var fp = re2.exec(w);
169 | stem = fp[1] + fp[2];
170 | re2 = new RegExp(mgr1);
171 | if (re2.test(stem))
172 | w = stem;
173 | }
174 |
175 | // Step 5
176 | re = /^(.+?)e$/;
177 | if (re.test(w)) {
178 | var fp = re.exec(w);
179 | stem = fp[1];
180 | re = new RegExp(mgr1);
181 | re2 = new RegExp(meq1);
182 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
183 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
184 | w = stem;
185 | }
186 | re = /ll$/;
187 | re2 = new RegExp(mgr1);
188 | if (re.test(w) && re2.test(w)) {
189 | re = /.$/;
190 | w = w.replace(re,"");
191 | }
192 |
193 | // and turn initial Y back to y
194 | if (firstch == "y")
195 | w = firstch.toLowerCase() + w.substr(1);
196 | return w;
197 | }
198 | }
199 |
200 |
201 |
202 |
203 | var splitChars = (function() {
204 | var result = {};
205 | var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
206 | 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
207 | 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
208 | 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
209 | 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
210 | 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
211 | 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
212 | 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
213 | 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
214 | 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
215 | var i, j, start, end;
216 | for (i = 0; i < singles.length; i++) {
217 | result[singles[i]] = true;
218 | }
219 | var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
220 | [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
221 | [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
222 | [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
223 | [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
224 | [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
225 | [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
226 | [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
227 | [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
228 | [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
229 | [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
230 | [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
231 | [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
232 | [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
233 | [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
234 | [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
235 | [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
236 | [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
237 | [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
238 | [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
239 | [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
240 | [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
241 | [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
242 | [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
243 | [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
244 | [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
245 | [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
246 | [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
247 | [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
248 | [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
249 | [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
250 | [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
251 | [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
252 | [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
253 | [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
254 | [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
255 | [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
256 | [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
257 | [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
258 | [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
259 | [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
260 | [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
261 | [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
262 | [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
263 | [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
264 | [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
265 | [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
266 | [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
267 | [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
268 | for (i = 0; i < ranges.length; i++) {
269 | start = ranges[i][0];
270 | end = ranges[i][1];
271 | for (j = start; j <= end; j++) {
272 | result[j] = true;
273 | }
274 | }
275 | return result;
276 | })();
277 |
278 | function splitQuery(query) {
279 | var result = [];
280 | var start = -1;
281 | for (var i = 0; i < query.length; i++) {
282 | if (splitChars[query.charCodeAt(i)]) {
283 | if (start !== -1) {
284 | result.push(query.slice(start, i));
285 | start = -1;
286 | }
287 | } else if (start === -1) {
288 | start = i;
289 | }
290 | }
291 | if (start !== -1) {
292 | result.push(query.slice(start));
293 | }
294 | return result;
295 | }
296 |
297 |
298 |
--------------------------------------------------------------------------------
/docs/_static/minus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/minus.png
--------------------------------------------------------------------------------
/docs/_static/plus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/plus.png
--------------------------------------------------------------------------------
/docs/_static/pygments.css:
--------------------------------------------------------------------------------
1 | pre { line-height: 125%; }
2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
6 | .highlight .hll { background-color: #ffffcc }
7 | .highlight { background: #f8f8f8; }
8 | .highlight .c { color: #408080; font-style: italic } /* Comment */
9 | .highlight .err { border: 1px solid #FF0000 } /* Error */
10 | .highlight .k { color: #008000; font-weight: bold } /* Keyword */
11 | .highlight .o { color: #666666 } /* Operator */
12 | .highlight .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
13 | .highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
14 | .highlight .cp { color: #BC7A00 } /* Comment.Preproc */
15 | .highlight .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
16 | .highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
17 | .highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
18 | .highlight .gd { color: #A00000 } /* Generic.Deleted */
19 | .highlight .ge { font-style: italic } /* Generic.Emph */
20 | .highlight .gr { color: #FF0000 } /* Generic.Error */
21 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
22 | .highlight .gi { color: #00A000 } /* Generic.Inserted */
23 | .highlight .go { color: #888888 } /* Generic.Output */
24 | .highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
25 | .highlight .gs { font-weight: bold } /* Generic.Strong */
26 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
27 | .highlight .gt { color: #0044DD } /* Generic.Traceback */
28 | .highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
29 | .highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
30 | .highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
31 | .highlight .kp { color: #008000 } /* Keyword.Pseudo */
32 | .highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
33 | .highlight .kt { color: #B00040 } /* Keyword.Type */
34 | .highlight .m { color: #666666 } /* Literal.Number */
35 | .highlight .s { color: #BA2121 } /* Literal.String */
36 | .highlight .na { color: #7D9029 } /* Name.Attribute */
37 | .highlight .nb { color: #008000 } /* Name.Builtin */
38 | .highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
39 | .highlight .no { color: #880000 } /* Name.Constant */
40 | .highlight .nd { color: #AA22FF } /* Name.Decorator */
41 | .highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
42 | .highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
43 | .highlight .nf { color: #0000FF } /* Name.Function */
44 | .highlight .nl { color: #A0A000 } /* Name.Label */
45 | .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
46 | .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
47 | .highlight .nv { color: #19177C } /* Name.Variable */
48 | .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
49 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */
50 | .highlight .mb { color: #666666 } /* Literal.Number.Bin */
51 | .highlight .mf { color: #666666 } /* Literal.Number.Float */
52 | .highlight .mh { color: #666666 } /* Literal.Number.Hex */
53 | .highlight .mi { color: #666666 } /* Literal.Number.Integer */
54 | .highlight .mo { color: #666666 } /* Literal.Number.Oct */
55 | .highlight .sa { color: #BA2121 } /* Literal.String.Affix */
56 | .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
57 | .highlight .sc { color: #BA2121 } /* Literal.String.Char */
58 | .highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
59 | .highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
60 | .highlight .s2 { color: #BA2121 } /* Literal.String.Double */
61 | .highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
62 | .highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
63 | .highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
64 | .highlight .sx { color: #008000 } /* Literal.String.Other */
65 | .highlight .sr { color: #BB6688 } /* Literal.String.Regex */
66 | .highlight .s1 { color: #BA2121 } /* Literal.String.Single */
67 | .highlight .ss { color: #19177C } /* Literal.String.Symbol */
68 | .highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
69 | .highlight .fm { color: #0000FF } /* Name.Function.Magic */
70 | .highlight .vc { color: #19177C } /* Name.Variable.Class */
71 | .highlight .vg { color: #19177C } /* Name.Variable.Global */
72 | .highlight .vi { color: #19177C } /* Name.Variable.Instance */
73 | .highlight .vm { color: #19177C } /* Name.Variable.Magic */
74 | .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
--------------------------------------------------------------------------------
/docs/_static/searchtools.js:
--------------------------------------------------------------------------------
1 | /*
2 | * searchtools.js
3 | * ~~~~~~~~~~~~~~~~
4 | *
5 | * Sphinx JavaScript utilities for the full-text search.
6 | *
7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
8 | * :license: BSD, see LICENSE for details.
9 | *
10 | */
11 |
12 | if (!Scorer) {
13 | /**
14 | * Simple result scoring code.
15 | */
16 | var Scorer = {
17 | // Implement the following function to further tweak the score for each result
18 | // The function takes a result array [filename, title, anchor, descr, score]
19 | // and returns the new score.
20 | /*
21 | score: function(result) {
22 | return result[4];
23 | },
24 | */
25 |
26 | // query matches the full name of an object
27 | objNameMatch: 11,
28 | // or matches in the last dotted part of the object name
29 | objPartialMatch: 6,
30 | // Additive scores depending on the priority of the object
31 | objPrio: {0: 15, // used to be importantResults
32 | 1: 5, // used to be objectResults
33 | 2: -5}, // used to be unimportantResults
34 | // Used when the priority is not in the mapping.
35 | objPrioDefault: 0,
36 |
37 | // query found in title
38 | title: 15,
39 | partialTitle: 7,
40 | // query found in terms
41 | term: 5,
42 | partialTerm: 2
43 | };
44 | }
45 |
46 | if (!splitQuery) {
47 | function splitQuery(query) {
48 | return query.split(/\s+/);
49 | }
50 | }
51 |
52 | /**
53 | * Search Module
54 | */
55 | var Search = {
56 |
57 | _index : null,
58 | _queued_query : null,
59 | _pulse_status : -1,
60 |
61 | htmlToText : function(htmlString) {
62 | var virtualDocument = document.implementation.createHTMLDocument('virtual');
63 | var htmlElement = $(htmlString, virtualDocument);
64 | htmlElement.find('.headerlink').remove();
65 | docContent = htmlElement.find('[role=main]')[0];
66 | if(docContent === undefined) {
67 | console.warn("Content block not found. Sphinx search tries to obtain it " +
68 | "via '[role=main]'. Could you check your theme or template.");
69 | return "";
70 | }
71 | return docContent.textContent || docContent.innerText;
72 | },
73 |
74 | init : function() {
75 | var params = $.getQueryParameters();
76 | if (params.q) {
77 | var query = params.q[0];
78 | $('input[name="q"]')[0].value = query;
79 | this.performSearch(query);
80 | }
81 | },
82 |
83 | loadIndex : function(url) {
84 | $.ajax({type: "GET", url: url, data: null,
85 | dataType: "script", cache: true,
86 | complete: function(jqxhr, textstatus) {
87 | if (textstatus != "success") {
88 | document.getElementById("searchindexloader").src = url;
89 | }
90 | }});
91 | },
92 |
93 | setIndex : function(index) {
94 | var q;
95 | this._index = index;
96 | if ((q = this._queued_query) !== null) {
97 | this._queued_query = null;
98 | Search.query(q);
99 | }
100 | },
101 |
102 | hasIndex : function() {
103 | return this._index !== null;
104 | },
105 |
106 | deferQuery : function(query) {
107 | this._queued_query = query;
108 | },
109 |
110 | stopPulse : function() {
111 | this._pulse_status = 0;
112 | },
113 |
114 | startPulse : function() {
115 | if (this._pulse_status >= 0)
116 | return;
117 | function pulse() {
118 | var i;
119 | Search._pulse_status = (Search._pulse_status + 1) % 4;
120 | var dotString = '';
121 | for (i = 0; i < Search._pulse_status; i++)
122 | dotString += '.';
123 | Search.dots.text(dotString);
124 | if (Search._pulse_status > -1)
125 | window.setTimeout(pulse, 500);
126 | }
127 | pulse();
128 | },
129 |
130 | /**
131 | * perform a search for something (or wait until index is loaded)
132 | */
133 | performSearch : function(query) {
134 | // create the required interface elements
135 | this.out = $('#search-results');
136 | this.title = $('' + _('Searching') + ' ').appendTo(this.out);
137 | this.dots = $(' ').appendTo(this.title);
138 | this.status = $('
').appendTo(this.out);
139 | this.output = $('').appendTo(this.out);
140 |
141 | $('#search-progress').text(_('Preparing search...'));
142 | this.startPulse();
143 |
144 | // index already loaded, the browser was quick!
145 | if (this.hasIndex())
146 | this.query(query);
147 | else
148 | this.deferQuery(query);
149 | },
150 |
151 | /**
152 | * execute search (requires search index to be loaded)
153 | */
154 | query : function(query) {
155 | var i;
156 |
157 | // stem the searchterms and add them to the correct list
158 | var stemmer = new Stemmer();
159 | var searchterms = [];
160 | var excluded = [];
161 | var hlterms = [];
162 | var tmp = splitQuery(query);
163 | var objectterms = [];
164 | for (i = 0; i < tmp.length; i++) {
165 | if (tmp[i] !== "") {
166 | objectterms.push(tmp[i].toLowerCase());
167 | }
168 |
169 | if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
170 | // skip this "word"
171 | continue;
172 | }
173 | // stem the word
174 | var word = stemmer.stemWord(tmp[i].toLowerCase());
175 | // prevent stemmer from cutting word smaller than two chars
176 | if(word.length < 3 && tmp[i].length >= 3) {
177 | word = tmp[i];
178 | }
179 | var toAppend;
180 | // select the correct list
181 | if (word[0] == '-') {
182 | toAppend = excluded;
183 | word = word.substr(1);
184 | }
185 | else {
186 | toAppend = searchterms;
187 | hlterms.push(tmp[i].toLowerCase());
188 | }
189 | // only add if not already in the list
190 | if (!$u.contains(toAppend, word))
191 | toAppend.push(word);
192 | }
193 | var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
194 |
195 | // console.debug('SEARCH: searching for:');
196 | // console.info('required: ', searchterms);
197 | // console.info('excluded: ', excluded);
198 |
199 | // prepare search
200 | var terms = this._index.terms;
201 | var titleterms = this._index.titleterms;
202 |
203 | // array of [filename, title, anchor, descr, score]
204 | var results = [];
205 | $('#search-progress').empty();
206 |
207 | // lookup as object
208 | for (i = 0; i < objectterms.length; i++) {
209 | var others = [].concat(objectterms.slice(0, i),
210 | objectterms.slice(i+1, objectterms.length));
211 | results = results.concat(this.performObjectSearch(objectterms[i], others));
212 | }
213 |
214 | // lookup as search terms in fulltext
215 | results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
216 |
217 | // let the scorer override scores with a custom scoring function
218 | if (Scorer.score) {
219 | for (i = 0; i < results.length; i++)
220 | results[i][4] = Scorer.score(results[i]);
221 | }
222 |
223 | // now sort the results by score (in opposite order of appearance, since the
224 | // display function below uses pop() to retrieve items) and then
225 | // alphabetically
226 | results.sort(function(a, b) {
227 | var left = a[4];
228 | var right = b[4];
229 | if (left > right) {
230 | return 1;
231 | } else if (left < right) {
232 | return -1;
233 | } else {
234 | // same score: sort alphabetically
235 | left = a[1].toLowerCase();
236 | right = b[1].toLowerCase();
237 | return (left > right) ? -1 : ((left < right) ? 1 : 0);
238 | }
239 | });
240 |
241 | // for debugging
242 | //Search.lastresults = results.slice(); // a copy
243 | //console.info('search results:', Search.lastresults);
244 |
245 | // print the results
246 | var resultCount = results.length;
247 | function displayNextItem() {
248 | // results left, load the summary and display it
249 | if (results.length) {
250 | var item = results.pop();
251 | var listItem = $(' ');
252 | var requestUrl = "";
253 | var linkUrl = "";
254 | if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
255 | // dirhtml builder
256 | var dirname = item[0] + '/';
257 | if (dirname.match(/\/index\/$/)) {
258 | dirname = dirname.substring(0, dirname.length-6);
259 | } else if (dirname == 'index/') {
260 | dirname = '';
261 | }
262 | requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
263 | linkUrl = requestUrl;
264 |
265 | } else {
266 | // normal html builders
267 | requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
268 | linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
269 | }
270 | listItem.append($(' ').attr('href',
271 | linkUrl +
272 | highlightstring + item[2]).html(item[1]));
273 | if (item[3]) {
274 | listItem.append($(' (' + item[3] + ') '));
275 | Search.output.append(listItem);
276 | setTimeout(function() {
277 | displayNextItem();
278 | }, 5);
279 | } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
280 | $.ajax({url: requestUrl,
281 | dataType: "text",
282 | complete: function(jqxhr, textstatus) {
283 | var data = jqxhr.responseText;
284 | if (data !== '' && data !== undefined) {
285 | listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
286 | }
287 | Search.output.append(listItem);
288 | setTimeout(function() {
289 | displayNextItem();
290 | }, 5);
291 | }});
292 | } else {
293 | // no source available, just display title
294 | Search.output.append(listItem);
295 | setTimeout(function() {
296 | displayNextItem();
297 | }, 5);
298 | }
299 | }
300 | // search finished, update title and status message
301 | else {
302 | Search.stopPulse();
303 | Search.title.text(_('Search Results'));
304 | if (!resultCount)
305 | Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
306 | else
307 | Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
308 | Search.status.fadeIn(500);
309 | }
310 | }
311 | displayNextItem();
312 | },
313 |
314 | /**
315 | * search for object names
316 | */
317 | performObjectSearch : function(object, otherterms) {
318 | var filenames = this._index.filenames;
319 | var docnames = this._index.docnames;
320 | var objects = this._index.objects;
321 | var objnames = this._index.objnames;
322 | var titles = this._index.titles;
323 |
324 | var i;
325 | var results = [];
326 |
327 | for (var prefix in objects) {
328 | for (var name in objects[prefix]) {
329 | var fullname = (prefix ? prefix + '.' : '') + name;
330 | var fullnameLower = fullname.toLowerCase()
331 | if (fullnameLower.indexOf(object) > -1) {
332 | var score = 0;
333 | var parts = fullnameLower.split('.');
334 | // check for different match types: exact matches of full name or
335 | // "last name" (i.e. last dotted part)
336 | if (fullnameLower == object || parts[parts.length - 1] == object) {
337 | score += Scorer.objNameMatch;
338 | // matches in last name
339 | } else if (parts[parts.length - 1].indexOf(object) > -1) {
340 | score += Scorer.objPartialMatch;
341 | }
342 | var match = objects[prefix][name];
343 | var objname = objnames[match[1]][2];
344 | var title = titles[match[0]];
345 | // If more than one term searched for, we require other words to be
346 | // found in the name/title/description
347 | if (otherterms.length > 0) {
348 | var haystack = (prefix + ' ' + name + ' ' +
349 | objname + ' ' + title).toLowerCase();
350 | var allfound = true;
351 | for (i = 0; i < otherterms.length; i++) {
352 | if (haystack.indexOf(otherterms[i]) == -1) {
353 | allfound = false;
354 | break;
355 | }
356 | }
357 | if (!allfound) {
358 | continue;
359 | }
360 | }
361 | var descr = objname + _(', in ') + title;
362 |
363 | var anchor = match[3];
364 | if (anchor === '')
365 | anchor = fullname;
366 | else if (anchor == '-')
367 | anchor = objnames[match[1]][1] + '-' + fullname;
368 | // add custom score for some objects according to scorer
369 | if (Scorer.objPrio.hasOwnProperty(match[2])) {
370 | score += Scorer.objPrio[match[2]];
371 | } else {
372 | score += Scorer.objPrioDefault;
373 | }
374 | results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
375 | }
376 | }
377 | }
378 |
379 | return results;
380 | },
381 |
382 | /**
383 | * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
384 | */
385 | escapeRegExp : function(string) {
386 | return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
387 | },
388 |
389 | /**
390 | * search for full-text terms in the index
391 | */
392 | performTermsSearch : function(searchterms, excluded, terms, titleterms) {
393 | var docnames = this._index.docnames;
394 | var filenames = this._index.filenames;
395 | var titles = this._index.titles;
396 |
397 | var i, j, file;
398 | var fileMap = {};
399 | var scoreMap = {};
400 | var results = [];
401 |
402 | // perform the search on the required terms
403 | for (i = 0; i < searchterms.length; i++) {
404 | var word = searchterms[i];
405 | var files = [];
406 | var _o = [
407 | {files: terms[word], score: Scorer.term},
408 | {files: titleterms[word], score: Scorer.title}
409 | ];
410 | // add support for partial matches
411 | if (word.length > 2) {
412 | var word_regex = this.escapeRegExp(word);
413 | for (var w in terms) {
414 | if (w.match(word_regex) && !terms[word]) {
415 | _o.push({files: terms[w], score: Scorer.partialTerm})
416 | }
417 | }
418 | for (var w in titleterms) {
419 | if (w.match(word_regex) && !titleterms[word]) {
420 | _o.push({files: titleterms[w], score: Scorer.partialTitle})
421 | }
422 | }
423 | }
424 |
425 | // no match but word was a required one
426 | if ($u.every(_o, function(o){return o.files === undefined;})) {
427 | break;
428 | }
429 | // found search word in contents
430 | $u.each(_o, function(o) {
431 | var _files = o.files;
432 | if (_files === undefined)
433 | return
434 |
435 | if (_files.length === undefined)
436 | _files = [_files];
437 | files = files.concat(_files);
438 |
439 | // set score for the word in each file to Scorer.term
440 | for (j = 0; j < _files.length; j++) {
441 | file = _files[j];
442 | if (!(file in scoreMap))
443 | scoreMap[file] = {};
444 | scoreMap[file][word] = o.score;
445 | }
446 | });
447 |
448 | // create the mapping
449 | for (j = 0; j < files.length; j++) {
450 | file = files[j];
451 | if (file in fileMap && fileMap[file].indexOf(word) === -1)
452 | fileMap[file].push(word);
453 | else
454 | fileMap[file] = [word];
455 | }
456 | }
457 |
458 | // now check if the files don't contain excluded terms
459 | for (file in fileMap) {
460 | var valid = true;
461 |
462 | // check if all requirements are matched
463 | var filteredTermCount = // as search terms with length < 3 are discarded: ignore
464 | searchterms.filter(function(term){return term.length > 2}).length
465 | if (
466 | fileMap[file].length != searchterms.length &&
467 | fileMap[file].length != filteredTermCount
468 | ) continue;
469 |
470 | // ensure that none of the excluded terms is in the search result
471 | for (i = 0; i < excluded.length; i++) {
472 | if (terms[excluded[i]] == file ||
473 | titleterms[excluded[i]] == file ||
474 | $u.contains(terms[excluded[i]] || [], file) ||
475 | $u.contains(titleterms[excluded[i]] || [], file)) {
476 | valid = false;
477 | break;
478 | }
479 | }
480 |
481 | // if we have still a valid result we can add it to the result list
482 | if (valid) {
483 | // select one (max) score for the file.
484 | // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
485 | var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
486 | results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
487 | }
488 | }
489 | return results;
490 | },
491 |
492 | /**
493 | * helper function to return a node containing the
494 | * search summary for a given text. keywords is a list
495 | * of stemmed words, hlwords is the list of normal, unstemmed
496 | * words. the first one is used to find the occurrence, the
497 | * latter for highlighting it.
498 | */
499 | makeSearchSummary : function(htmlText, keywords, hlwords) {
500 | var text = Search.htmlToText(htmlText);
501 | var textLower = text.toLowerCase();
502 | var start = 0;
503 | $.each(keywords, function() {
504 | var i = textLower.indexOf(this.toLowerCase());
505 | if (i > -1)
506 | start = i;
507 | });
508 | start = Math.max(start - 120, 0);
509 | var excerpt = ((start > 0) ? '...' : '') +
510 | $.trim(text.substr(start, 240)) +
511 | ((start + 240 - text.length) ? '...' : '');
512 | var rv = $('
').text(excerpt);
513 | $.each(hlwords, function() {
514 | rv = rv.highlightText(this, 'highlighted');
515 | });
516 | return rv;
517 | }
518 | };
519 |
520 | $(document).ready(function() {
521 | Search.init();
522 | });
523 |
--------------------------------------------------------------------------------
/docs/_static/style.css:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/_static/style.css
--------------------------------------------------------------------------------
/docs/_static/underscore.js:
--------------------------------------------------------------------------------
1 | !function(n,r){"object"==typeof exports&&"undefined"!=typeof module?module.exports=r():"function"==typeof define&&define.amd?define("underscore",r):(n=n||self,function(){var t=n._,e=n._=r();e.noConflict=function(){return n._=t,e}}())}(this,(function(){
2 | // Underscore.js 1.12.0
3 | // https://underscorejs.org
4 | // (c) 2009-2020 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
5 | // Underscore may be freely distributed under the MIT license.
6 | var n="1.12.0",r="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global||Function("return this")()||{},t=Array.prototype,e=Object.prototype,u="undefined"!=typeof Symbol?Symbol.prototype:null,o=t.push,i=t.slice,a=e.toString,f=e.hasOwnProperty,c="undefined"!=typeof ArrayBuffer,l="undefined"!=typeof DataView,s=Array.isArray,p=Object.keys,v=Object.create,h=c&&ArrayBuffer.isView,y=isNaN,g=isFinite,d=!{toString:null}.propertyIsEnumerable("toString"),b=["valueOf","isPrototypeOf","toString","propertyIsEnumerable","hasOwnProperty","toLocaleString"],m=Math.pow(2,53)-1;function j(n,r){return r=null==r?n.length-1:+r,function(){for(var t=Math.max(arguments.length-r,0),e=Array(t),u=0;u=0&&t<=m}}function $(n){return function(r){return null==r?void 0:r[n]}}var G=$("byteLength"),H=J(G),Q=/\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|Big(I|Ui)nt64)Array\]/;var X=c?function(n){return h?h(n)&&!q(n):H(n)&&Q.test(a.call(n))}:K(!1),Y=$("length");function Z(n,r){r=function(n){for(var r={},t=n.length,e=0;e":">",'"':""","'":"'","`":"`"},Kn=Ln(Cn),Jn=Ln(_n(Cn)),$n=tn.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g},Gn=/(.)^/,Hn={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},Qn=/\\|'|\r|\n|\u2028|\u2029/g;function Xn(n){return"\\"+Hn[n]}var Yn=0;function Zn(n,r,t,e,u){if(!(e instanceof r))return n.apply(t,u);var o=Mn(n.prototype),i=n.apply(o,u);return _(i)?i:o}var nr=j((function(n,r){var t=nr.placeholder,e=function(){for(var u=0,o=r.length,i=Array(o),a=0;a1)er(a,r-1,t,e),u=e.length;else for(var f=0,c=a.length;f0&&(t=r.apply(this,arguments)),n<=1&&(r=null),t}}var cr=nr(fr,2);function lr(n,r,t){r=qn(r,t);for(var e,u=nn(n),o=0,i=u.length;o0?0:u-1;o>=0&&o0?a=o>=0?o:Math.max(o+f,a):f=o>=0?Math.min(o+1,f):o+f+1;else if(t&&o&&f)return e[o=t(e,u)]===u?o:-1;if(u!=u)return(o=r(i.call(e,a,f),C))>=0?o+a:-1;for(o=n>0?a:f-1;o>=0&&o0?0:i-1;for(u||(e=r[o?o[a]:a],a+=n);a>=0&&a=3;return r(n,Fn(t,u,4),e,o)}}var wr=_r(1),Ar=_r(-1);function xr(n,r,t){var e=[];return r=qn(r,t),mr(n,(function(n,t,u){r(n,t,u)&&e.push(n)})),e}function Sr(n,r,t){r=qn(r,t);for(var e=!tr(n)&&nn(n),u=(e||n).length,o=0;o=0}var Er=j((function(n,r,t){var e,u;return D(r)?u=r:(r=Nn(r),e=r.slice(0,-1),r=r[r.length-1]),jr(n,(function(n){var o=u;if(!o){if(e&&e.length&&(n=In(n,e)),null==n)return;o=n[r]}return null==o?o:o.apply(n,t)}))}));function Br(n,r){return jr(n,Rn(r))}function Nr(n,r,t){var e,u,o=-1/0,i=-1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=tr(n)?n:jn(n)).length;ao&&(o=e);else r=qn(r,t),mr(n,(function(n,t,e){((u=r(n,t,e))>i||u===-1/0&&o===-1/0)&&(o=n,i=u)}));return o}function Ir(n,r,t){if(null==r||t)return tr(n)||(n=jn(n)),n[Wn(n.length-1)];var e=tr(n)?En(n):jn(n),u=Y(e);r=Math.max(Math.min(r,u),0);for(var o=u-1,i=0;i1&&(e=Fn(e,r[1])),r=an(n)):(e=Pr,r=er(r,!1,!1),n=Object(n));for(var u=0,o=r.length;u1&&(t=r[1])):(r=jr(er(r,!1,!1),String),e=function(n,t){return!Mr(r,t)}),qr(n,e,t)}));function Wr(n,r,t){return i.call(n,0,Math.max(0,n.length-(null==r||t?1:r)))}function zr(n,r,t){return null==n||n.length<1?null==r||t?void 0:[]:null==r||t?n[0]:Wr(n,n.length-r)}function Lr(n,r,t){return i.call(n,null==r||t?1:r)}var Cr=j((function(n,r){return r=er(r,!0,!0),xr(n,(function(n){return!Mr(r,n)}))})),Kr=j((function(n,r){return Cr(n,r)}));function Jr(n,r,t,e){A(r)||(e=t,t=r,r=!1),null!=t&&(t=qn(t,e));for(var u=[],o=[],i=0,a=Y(n);ir?(e&&(clearTimeout(e),e=null),a=c,i=n.apply(u,o),e||(u=o=null)):e||!1===t.trailing||(e=setTimeout(f,l)),i};return c.cancel=function(){clearTimeout(e),a=0,e=u=o=null},c},debounce:function(n,r,t){var e,u,o=function(r,t){e=null,t&&(u=n.apply(r,t))},i=j((function(i){if(e&&clearTimeout(e),t){var a=!e;e=setTimeout(o,r),a&&(u=n.apply(this,i))}else e=or(o,r,this,i);return u}));return i.cancel=function(){clearTimeout(e),e=null},i},wrap:function(n,r){return nr(r,n)},negate:ar,compose:function(){var n=arguments,r=n.length-1;return function(){for(var t=r,e=n[r].apply(this,arguments);t--;)e=n[t].call(this,e);return e}},after:function(n,r){return function(){if(--n<1)return r.apply(this,arguments)}},before:fr,once:cr,findKey:lr,findIndex:pr,findLastIndex:vr,sortedIndex:hr,indexOf:gr,lastIndexOf:dr,find:br,detect:br,findWhere:function(n,r){return br(n,Dn(r))},each:mr,forEach:mr,map:jr,collect:jr,reduce:wr,foldl:wr,inject:wr,reduceRight:Ar,foldr:Ar,filter:xr,select:xr,reject:function(n,r,t){return xr(n,ar(qn(r)),t)},every:Sr,all:Sr,some:Or,any:Or,contains:Mr,includes:Mr,include:Mr,invoke:Er,pluck:Br,where:function(n,r){return xr(n,Dn(r))},max:Nr,min:function(n,r,t){var e,u,o=1/0,i=1/0;if(null==r||"number"==typeof r&&"object"!=typeof n[0]&&null!=n)for(var a=0,f=(n=tr(n)?n:jn(n)).length;ae||void 0===t)return 1;if(t
4 |
5 |
6 |
7 |
8 |
9 |
10 | Pin — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 | hub-api
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 | Pin
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
Pin
184 |
This class can be used to read and control the two logic pins on pins 5 and 6
185 | of each port. You can access two Pin
objects via each Port
186 | instance if the port has been set to MODE_GPIO
187 | mode.
188 |
189 |
190 | class Pin
191 | Control a general purpose input/output (GPIO) pin.
192 |
193 |
194 | direction
( direction : Optional [ int ] ) → int
195 | Gets and sets the direction of the pin.
196 |
197 | Parameters
198 | direction – Choose 0
to make the pin an input or 1
to make
199 | it an output.
200 |
201 | Returns
202 | The configured direction.
203 |
204 |
205 |
206 |
207 |
208 |
209 | value
( value : Optional [ int ] ) → int
210 | Gets and sets the logic value of the pin.
211 |
212 | Parameters
213 | value – Choose 1
to make the pin high or 0
to make it low.
214 | If the pin is configured as an input, this argument is ignored.
215 |
216 | Returns
217 | Logic value of the pin.
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 |
254 |
255 |
256 |
257 |
258 |
259 |
260 |
261 |
262 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | Hub Documentation — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 | hub-api
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 | Hub Documentation
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
Hub Documentation
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
191 |
This is the MicroPython documentation for the LEGO MINDSTORMS Inventor Hub.
192 | MicroPython is a small and efficient Python implementation that can run on
193 | the LEGO MINDSTORMS Inventor Hub.
194 |
LEGO has extended MicroPython with the hub
package, which provides access
195 | to LEGO motors, sensors, and devices built into the hub.
196 | This page provides the documentation for the hub
module. Use the menu
197 | on the left to view all available modules in this package.
198 |
Several standard MicroPython modules are also available. You can find
199 | documentation for those modules in the official MicroPython documentation.
200 |
201 |
202 |
203 |
204 |
205 |
206 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 |
242 |
243 |
244 |
245 |
246 |
247 |
248 |
249 |
--------------------------------------------------------------------------------
/docs/license.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | Documentation license — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 | hub-api
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 | Documentation license
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
Documentation license
183 |
The MIT License (MIT)
184 |
185 | Copyright (c) 2017-2021 - LEGO System A/S - Aastvej 1, 7190 Billund, DK
186 |
187 | Permission is hereby granted, free of charge, to any person obtaining a copy
188 | of this software and associated documentation files (the “Software”), to deal
189 | in the Software without restriction, including without limitation the rights
190 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
191 | copies of the Software, and to permit persons to whom the Software is
192 | furnished to do so, subject to the following conditions:
193 |
194 | The above copyright notice and this permission notice shall be included in all
195 | copies or substantial portions of the Software.
196 |
197 | THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
198 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
199 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
200 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
201 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
202 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
203 | SOFTWARE.
204 |
205 |
206 |
207 |
208 |
209 |
210 |
211 |
212 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
243 |
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
--------------------------------------------------------------------------------
/docs/mod_button.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | hub.button – Button — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 | hub-api
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 | hub.button
– Button
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
283 |
284 |
285 |
286 |
287 |
288 |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
319 |
320 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
--------------------------------------------------------------------------------
/docs/mod_port.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | hub.port – Port — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 | hub-api
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 | hub.port
– Port
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
187 |
188 |
This module contains instances of the Port
class,
189 | created automatically when the hub boots.
190 |
191 |
Attributes
192 |
193 |
194 | hub.port.
A
195 | Port A on the hub.
196 |
197 |
198 |
199 |
200 | hub.port.
B
201 | Port B on the hub.
202 |
203 |
204 |
205 |
206 | hub.port.
C
207 | Port C on the hub.
208 |
209 |
210 |
211 |
212 | hub.port.
D
213 | Port D on the hub.
214 |
215 |
216 |
217 |
218 | hub.port.
E
219 | Port E on the hub.
220 |
221 |
222 |
223 |
224 | hub.port.
F
225 | Port F on the hub.
226 |
227 |
228 |
229 |
230 |
Constants
231 |
These constants can be used with the Port.callback
method.
232 |
Port events
233 |
234 |
235 | hub.port.
DETACHED
= 0
236 | A device was detached from the port.
237 |
238 |
239 |
240 |
241 | hub.port.
ATTACHED
= 1
242 | A new device is attached to the port.
243 |
244 |
245 |
Port modes
246 |
These constants can be used with the Port.mode
method.
247 |
248 |
249 | hub.port.
MODE_DEFAULT
= 0
250 | The port is Powered Up compatible.
251 |
252 |
253 |
254 |
255 | hub.port.
MODE_FULL_DUPLEX
= 1
256 | The port operates as a raw full duplex logic level serial port.
257 |
258 |
259 |
260 |
261 | hub.port.
MODE_HALF_DUPLEX
= 2
262 | The port operates as a raw half duplex differential level serial port.
263 |
264 |
265 |
266 |
267 | hub.port.
MODE_GPIO
= 3
268 | The port operates as general input and output Pin
.
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
302 |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
--------------------------------------------------------------------------------
/docs/mod_sound.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | hub.sound – Sound — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 | hub-api
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 | hub.sound
– Sound
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
187 |
The sound module lets you control the hub speaker to play sound files and
188 | beeps.
189 |
190 |
191 | hub.sound.
volume
( volume : int ) → None
192 |
193 | hub.sound.
volume
( ) → int
194 | Sets the volume of the speaker.
195 |
196 | Parameters
197 | Volume – Volume between 0 (no sound) and 10 (maximum volume).
198 |
199 | Returns
200 | If no argument is given, this returns the current volume.
201 |
202 |
203 |
204 |
205 |
206 |
207 | hub.sound.
beep
( freq = 1000 , time = 1000 , waveform = 0 ) → None
208 | Starts beeping with a given frequency, duration, and wave form.
209 |
210 | Keyword Arguments
211 |
212 | freq – Frequency of the beep in Hz (100 - 10000).
213 | time – Duration of the beep in milliseconds (0 - 32767).
214 | waveform – Wave form used for the beep.
215 | See constants
for all possible
216 | values.
217 |
218 |
219 |
220 |
221 |
222 |
223 |
224 | hub.sound.
play
( filename : str , rate = 16000 ) → None
225 | Starts playing a sound file.
226 | The sound file must be raw 16 bit data at 16 kHz.
227 |
228 | Parameters
229 | filename – Absolute path to the sound file.
230 |
231 | Keyword Arguments
232 | rate – Playback speed in Hz.
233 |
234 | Raises
235 | OSError ( ENOENT ) – If the file does not exist.
236 |
237 |
238 |
239 |
240 |
241 |
242 | hub.sound.
callback
( self , function : Callable [ [ int ] , None ] ) → None
243 | Sets the callback function that is called when a sound finished playing
244 | or when it is interrupted.
245 | The function must accept one argument, whose value indicates why
246 | the callback was called:
247 |
248 | If the value is 0
, the sound completed successfully.
249 | If the value is 1
, the sound was interrupted.
250 |
251 |
252 | Parameters
253 | function – Callable function that takes one argument. Choose
254 | None
to disable the callback.
255 |
256 |
257 |
258 |
259 |
260 |
Constants
261 |
These values are used by the hub.sound.beep()
function.
262 |
263 |
264 | hub.sound.
SOUND_SIN
= 0
265 | The beep is a smooth sine wave.
266 |
267 |
268 |
269 |
270 | hub.sound.
SOUND_SQUARE
= 1
271 | The beep is a loud and raw square wave.
272 |
273 |
274 |
275 |
276 | hub.sound.
SOUND_TRIANGLE
= 2
277 | The beep has a triangular wave form.
278 |
279 |
280 |
281 |
282 | hub.sound.
SOUND_SAWTOOTH
= 3
283 | The beep has a sawtooth-shaped wave form.
284 |
285 |
286 |
287 |
288 |
289 |
290 |
291 |
292 |
293 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
--------------------------------------------------------------------------------
/docs/mod_supervision.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | hub.supervision – Supervision — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 | hub-api
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 | hub.supervision
– Supervision
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
The supervision module lets you monitor critical states of the hub.
185 |
186 |
187 | hub.supervision.
info
( ) → dict
188 | Gets status information from the subsystem that supervises the hub.
189 | This returns a dictionary of the form:
190 |
191 | {
192 | # Checks if the peak current is too high.
193 | 'peek_current_too_high' : False ,
194 |
195 | # Checks if the current is too high.
196 | 'continous_current_too_high' : False ,
197 |
198 | # The current value in mA.
199 | 'continuous_current' : 60 ,
200 |
201 | # Checks if the hub temperature is too high.
202 | 'temperature_too_high' : False
203 | }
204 |
205 |
206 |
207 |
208 | Returns
209 | Supervision status information.
210 |
211 |
212 |
213 |
214 |
215 |
216 | hub.supervision.
callback
( self , function : Callable [ [ int ] , None ] ) → None
217 | Sets the callback function that is called when an over-current event
218 | occurs.
219 | The function must accept one argument, which indicates the current in mA
220 | that triggered the callback.
221 |
222 | Parameters
223 | function – Callable function that takes one argument. Choose
224 | None
to disable the callback.
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
259 |
260 |
261 |
262 |
263 |
264 |
265 |
266 |
267 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 |
--------------------------------------------------------------------------------
/docs/objects.inv:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/LEGO/MINDSTORMS-Robot-Inventor-hub-API/b3b80172708078a46bfa30b45bedeab4028a0c1b/docs/objects.inv
--------------------------------------------------------------------------------
/docs/py-modindex.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | Python Module Index — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 | hub-api
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 | Python Module Index
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
Python Module Index
183 |
184 |
187 |
188 |
239 |
240 |
241 |
242 |
243 |
244 |
264 |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
277 |
278 |
279 |
280 |
281 |
282 |
283 |
284 |
--------------------------------------------------------------------------------
/docs/search.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | Search — hub-api documentation
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 | hub-api
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 | Search
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 | Please activate JavaScript to enable the search functionality.
185 |
186 |
187 |
188 |
189 |
190 |
191 |
192 |
193 |
194 |
195 |
196 |
197 |
217 |
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
230 |
231 |
232 |
233 |
234 |
235 |
238 |
239 |
240 |
241 |
242 |
243 |
244 |
--------------------------------------------------------------------------------