mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-07-27 19:57:02 +00:00
doc: placeholder lpf2docs
This commit is contained in:
Laurens Valk
+1
-4
@@ -1,4 +1 @@
|
||||
:mod:`robotics` -- Robotics module
|
||||
===========================================
|
||||
|
||||
.. automodule:: robotics
|
||||
.. include:: ../common/robotics.rst
|
||||
|
||||
Executable
+15
@@ -0,0 +1,15 @@
|
||||
|
||||
SRC_DIR = .
|
||||
OUT_DIR = ../images
|
||||
|
||||
SVG := $(wildcard $(SRC_DIR)/*.svg)
|
||||
PNG := $(patsubst $(SRC_DIR)/%.svg,$(OUT_DIR)/%.png,$(SVG))
|
||||
DIR := ${CURDIR}
|
||||
|
||||
all: $(PNG)
|
||||
|
||||
clean:
|
||||
rm -f $(PNG)
|
||||
|
||||
$(OUT_DIR)/%.png: $(SRC_DIR)/%.svg
|
||||
inkscape --file=$(DIR)/$< --export-area-drawing --export-png=$(DIR)/$@
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
@@ -0,0 +1,251 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
version="1.1"
|
||||
id="svg2"
|
||||
width="800"
|
||||
height="521"
|
||||
viewBox="0 0 799.99997 521"
|
||||
sodipodi:docname="overview.svg"
|
||||
inkscape:version="0.92.3 (2405546, 2018-03-11)">
|
||||
<metadata
|
||||
id="metadata8">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title />
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<defs
|
||||
id="defs6" />
|
||||
<sodipodi:namedview
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1"
|
||||
objecttolerance="10"
|
||||
gridtolerance="10"
|
||||
guidetolerance="10"
|
||||
inkscape:pageopacity="0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:window-width="1853"
|
||||
inkscape:window-height="1016"
|
||||
id="namedview4"
|
||||
showgrid="false"
|
||||
inkscape:zoom="2.36"
|
||||
inkscape:cx="170.96633"
|
||||
inkscape:cy="193.22709"
|
||||
inkscape:window-x="67"
|
||||
inkscape:window-y="27"
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:current-layer="svg2" />
|
||||
<image
|
||||
sodipodi:absref="overview.jpg"
|
||||
xlink:href="overview.jpg"
|
||||
y="0"
|
||||
x="0"
|
||||
id="image852"
|
||||
preserveAspectRatio="none"
|
||||
height="521"
|
||||
width="800"
|
||||
style="stroke-width:0.3199999" />
|
||||
<path
|
||||
style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
||||
d="M 514.53044,444.44518 H 581.7056"
|
||||
id="path909"
|
||||
inkscape:connector-curvature="0" />
|
||||
<rect
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect4173"
|
||||
width="239.00459"
|
||||
height="72.354301"
|
||||
x="545.22894"
|
||||
y="406.83414" />
|
||||
<rect
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect4175"
|
||||
width="239.00459"
|
||||
height="4"
|
||||
x="545.22894"
|
||||
y="406.83414" />
|
||||
<text
|
||||
id="text114"
|
||||
y="437.4194"
|
||||
x="559.9931"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
xml:space="preserve"><tspan
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054"
|
||||
y="437.4194"
|
||||
x="559.9931"
|
||||
id="tspan112"
|
||||
sodipodi:role="line">Computer with </tspan><tspan
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054"
|
||||
y="468.5033"
|
||||
x="559.9931"
|
||||
sodipodi:role="line"
|
||||
id="tspan907">Visual Studio Code</tspan></text>
|
||||
<circle
|
||||
r="19.024944"
|
||||
cy="495.53748"
|
||||
cx="-444.85339"
|
||||
id="path118"
|
||||
style="fill:#e7f2fa;fill-opacity:1;stroke:#6ab0de;stroke-width:4;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
||||
transform="rotate(-90)" />
|
||||
<circle
|
||||
transform="scale(1,-1)"
|
||||
r="20.301775"
|
||||
cy="-314.50687"
|
||||
cx="321.67059"
|
||||
id="circle4625"
|
||||
style="opacity:1;fill:none;fill-opacity:1;stroke:#6ab0de;stroke-width:4;stroke-linecap:square;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<rect
|
||||
y="374.04733"
|
||||
x="26.49622"
|
||||
height="42.092525"
|
||||
width="228.95509"
|
||||
id="rect4629"
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<rect
|
||||
y="374.04733"
|
||||
x="26.49622"
|
||||
height="4"
|
||||
width="228.95509"
|
||||
id="rect4631"
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
x="36.466434"
|
||||
y="404.63257"
|
||||
id="text4635"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan4633"
|
||||
x="36.466434"
|
||||
y="404.63257"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054">Download and run</tspan></text>
|
||||
<rect
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect4651"
|
||||
width="300.14154"
|
||||
height="73.236595"
|
||||
x="26.49622"
|
||||
y="374.04733" />
|
||||
<rect
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect4653"
|
||||
width="300.14154"
|
||||
height="4"
|
||||
x="26.49622"
|
||||
y="374.04733" />
|
||||
<text
|
||||
id="text4657"
|
||||
y="404.63257"
|
||||
x="36.466434"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
xml:space="preserve"><tspan
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054"
|
||||
y="404.63257"
|
||||
x="36.466434"
|
||||
id="tspan4655"
|
||||
sodipodi:role="line">MicroSD card with</tspan><tspan
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054"
|
||||
y="435.71646"
|
||||
x="36.466434"
|
||||
sodipodi:role="line"
|
||||
id="tspan915">EV3 MicroPython image</tspan></text>
|
||||
<path
|
||||
style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
||||
d="M 474.94723,55.976055 H 407.77207"
|
||||
id="path917"
|
||||
inkscape:connector-curvature="0" />
|
||||
<circle
|
||||
r="19.024944"
|
||||
cy="58.132839"
|
||||
cx="387.95428"
|
||||
id="circle919"
|
||||
style="fill:none;fill-opacity:1;stroke:#6ab0de;stroke-width:4;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
||||
<rect
|
||||
y="30.709236"
|
||||
x="440.86319"
|
||||
height="42.092525"
|
||||
width="196.33363"
|
||||
id="rect921"
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<rect
|
||||
y="30.709236"
|
||||
x="440.86319"
|
||||
height="4"
|
||||
width="196.33363"
|
||||
id="rect923"
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
x="450.8334"
|
||||
y="61.294502"
|
||||
id="text927"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan925"
|
||||
x="450.8334"
|
||||
y="61.294502"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054">Mini-USB cable</tspan></text>
|
||||
<path
|
||||
style="fill:none;stroke:#838383;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
|
||||
d="m 321.14228,303.04679 3.39982,17.75063"
|
||||
id="path855"
|
||||
inkscape:connector-curvature="0" />
|
||||
<path
|
||||
style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
||||
d="M 320.61117,234.27679 H 160.61327"
|
||||
id="path857"
|
||||
inkscape:connector-curvature="0"
|
||||
sodipodi:nodetypes="cc" />
|
||||
<path
|
||||
inkscape:connector-curvature="0"
|
||||
id="path859"
|
||||
d="M 301.11963,316.65812 H 154.00546 v 59.02544"
|
||||
style="fill:none;stroke:#6ab0de;stroke-width:4;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
|
||||
<circle
|
||||
style="fill:#e7f2fa;fill-opacity:1;stroke:#6ab0de;stroke-width:4;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
|
||||
id="circle913"
|
||||
cx="321.31552"
|
||||
cy="230.23854"
|
||||
r="19.024944" />
|
||||
<rect
|
||||
style="opacity:1;fill:#e7f2fa;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect4611"
|
||||
width="138.70651"
|
||||
height="42.092525"
|
||||
x="27.116055"
|
||||
y="214.3815" />
|
||||
<rect
|
||||
style="opacity:1;fill:#6ab0de;fill-opacity:1;stroke:none;stroke-width:2.13333321;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
|
||||
id="rect4613"
|
||||
width="138.70651"
|
||||
height="4"
|
||||
x="27.116055"
|
||||
y="214.3815" />
|
||||
<text
|
||||
id="text4617"
|
||||
y="244.96677"
|
||||
x="37.086269"
|
||||
style="font-style:normal;font-weight:normal;font-size:24.19441986px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#404140;fill-opacity:1;stroke:none;stroke-width:0.60486054"
|
||||
xml:space="preserve"><tspan
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Roboto Slab';-inkscape-font-specification:'Roboto Slab';fill:#404140;fill-opacity:1;stroke-width:0.60486054"
|
||||
y="244.96677"
|
||||
x="37.086269"
|
||||
id="tspan4615"
|
||||
sodipodi:role="line">EV3 Brick</tspan></text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 11 KiB |
@@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Pybricks documentation build configuration file
|
||||
#
|
||||
import os
|
||||
import sys
|
||||
exec(open(os.path.abspath("../common/conf.py")).read())
|
||||
@@ -0,0 +1,6 @@
|
||||
Line follower
|
||||
=====================
|
||||
|
||||
This is a nonexisting example:
|
||||
|
||||
.. literalinclude:: ../../../examples/ev3/robot_educator/main.py
|
||||
@@ -0,0 +1,4 @@
|
||||
:mod:`hub4` -- Powered Up Train/System Hub
|
||||
==============================================
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
*.png
|
||||
!pybricks-logo-large.png
|
||||
!pybricks-logo-small.png
|
||||
@@ -0,0 +1,44 @@
|
||||
Pybricks for Power Functions 2.0
|
||||
==============================================================
|
||||
|
||||
Intro
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Table of Contents
|
||||
:hidden:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Getting Started
|
||||
:hidden:
|
||||
|
||||
startinstall
|
||||
startrun
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Pybricks Modules
|
||||
:hidden:
|
||||
|
||||
movehub
|
||||
hub4
|
||||
lpf2devices
|
||||
parameters
|
||||
tools
|
||||
robotics
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Engineering Essentials
|
||||
:hidden:
|
||||
|
||||
signaltypes
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Demo Programs
|
||||
:hidden:
|
||||
|
||||
examples/line_follower
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
:mod:`lpf2` -- Power Function 2.0 Motors and Sensors
|
||||
====================================================
|
||||
|
||||
.. automodule:: ev3devices
|
||||
:no-members:
|
||||
|
||||
Motors
|
||||
------
|
||||
|
||||
.. autoclass:: ev3devices.Motor
|
||||
:no-members:
|
||||
|
||||
.. rubric:: Methods for motors without rotation sensors
|
||||
|
||||
.. automethod:: ev3devices.Motor.dc
|
||||
|
||||
.. rubric:: Methods for motors with rotation sensors
|
||||
|
||||
.. automethod:: ev3devices.Motor.angle
|
||||
|
||||
.. automethod:: ev3devices.Motor.reset_angle
|
||||
|
||||
.. automethod:: ev3devices.Motor.speed
|
||||
|
||||
.. automethod:: ev3devices.Motor.stop
|
||||
|
||||
.. automethod:: ev3devices.Motor.run
|
||||
|
||||
.. automethod:: ev3devices.Motor.run_time
|
||||
|
||||
.. automethod:: ev3devices.Motor.run_angle
|
||||
|
||||
.. automethod:: ev3devices.Motor.run_target
|
||||
|
||||
.. rubric:: Advanced methods for motors with rotation sensors
|
||||
|
||||
.. automethod:: ev3devices.Motor.track_target
|
||||
|
||||
.. automethod:: ev3devices.Motor.stalled
|
||||
|
||||
.. automethod:: ev3devices.Motor.run_until_stalled
|
||||
|
||||
.. automethod:: ev3devices.Motor.set_dc_settings
|
||||
|
||||
.. automethod:: ev3devices.Motor.set_run_settings
|
||||
|
||||
.. automethod:: ev3devices.Motor.set_pid_settings
|
||||
|
||||
Sensors
|
||||
-------
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
:mod:`movehub` -- The Move Hub
|
||||
=============================================
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
:mod:`parameters` -- Parameters and Constants
|
||||
=============================================
|
||||
|
||||
.. automodule:: parameters
|
||||
:no-members:
|
||||
|
||||
.. autoclass:: parameters.Port
|
||||
:no-members:
|
||||
|
||||
.. autoclass:: parameters.Direction
|
||||
:no-members:
|
||||
|
||||
.. autoclass:: parameters.Stop
|
||||
:no-members:
|
||||
|
||||
.. autoclass:: parameters.Color
|
||||
:no-members:
|
||||
|
||||
.. autoclass:: parameters.Button
|
||||
:no-members:
|
||||
@@ -0,0 +1 @@
|
||||
.. include:: ../common/robotics.rst
|
||||
@@ -0,0 +1 @@
|
||||
.. include:: ../common/signaltypes.rst
|
||||
@@ -0,0 +1,14 @@
|
||||
Installation
|
||||
===================
|
||||
|
||||
Getting started. See :numref:`fig_overview`.
|
||||
|
||||
.. _fig_overview:
|
||||
|
||||
.. figure:: images/overview.png
|
||||
:width: 90 %
|
||||
:alt: overview
|
||||
:align: center
|
||||
|
||||
Setup overview
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
Creating and running programs
|
||||
=============================
|
||||
|
||||
Running programs.
|
||||
@@ -0,0 +1 @@
|
||||
.. include:: ../common/tools.rst
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 119 KiB |
Reference in New Issue
Block a user