doc: brick, sound, display, and experiment with samples

This commit is contained in:
Laurens Valk
2019-01-04 15:05:17 +01:00
parent 3da8785995
commit 2f0d7ec0a2
7 changed files with 94 additions and 70 deletions
+55
View File
@@ -0,0 +1,55 @@
:mod:`brick` -- The EV3 Programmable Brick
==========================================
Buttons
-------
.. autofunction:: brick.buttons
Light
-----
.. autofunction:: brick.light
Sound
-----
.. automethod:: brick.sound.beep
.. automethod:: brick.sound.beeps
.. automethod:: brick.sound.tune
.. automethod:: brick.sound.file
.. automethod:: brick.sound.speak
Display
-------
::
x
-------------->
(0, 0) __________________
| |
| | |
y | | Hello |
| | World |
v | |
|__________________|
(177, 127)
.. automethod:: brick.display.clear
.. automethod:: brick.display.text
.. automethod:: brick.display.image
+30
View File
@@ -0,0 +1,30 @@
:mod:`devices` -- EV3 Motors and Sensors
===========================================
Motors
------
.. autoclass:: devices.Motor
Sensors
-------
Touch Sensor
^^^^^^^^^^^^
.. autoclass:: devices.TouchSensor
Color Sensor
^^^^^^^^^^^^
.. autoclass:: devices.ColorSensor
Infrared Sensor and Beacon
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: devices.InfraredSensor
Ultrasonic Sensor
^^^^^^^^^^^^^^^^^
.. autoclass:: devices.UltrasonicSensor
Gyroscopic Sensor
^^^^^^^^^^^^^^^^^
.. autoclass:: devices.GyroSensor
-37
View File
@@ -1,37 +0,0 @@
:mod:`ev3brick` -- The Programmable Brick
=========================================
Buttons
-------
.. autofunction:: ev3brick.buttons
Light
-----
.. autofunction:: ev3brick.light
Sound
-----
.. automethod:: ev3brick.sound.beep
.. automethod:: ev3brick.sound.beeps
.. automethod:: ev3brick.sound.tune
.. automethod:: ev3brick.sound.file
.. automethod:: ev3brick.sound.speak
Display
-------
TODO: picture with (0,0), +x +y arrows
.. automethod:: ev3brick.display.clear
.. automethod:: ev3brick.display.text
.. automethod:: ev3brick.display.image
-30
View File
@@ -1,30 +0,0 @@
:mod:`ev3devices` -- Motors and Sensors
===========================================
Motors
------
.. autoclass:: ev3devices.Motor
Sensors
-------
Touch Sensor
^^^^^^^^^^^^
.. autoclass:: ev3devices.TouchSensor
Color Sensor
^^^^^^^^^^^^
.. autoclass:: ev3devices.ColorSensor
Infrared Sensor and Beacon
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: ev3devices.InfraredSensor
Ultrasonic Sensor
^^^^^^^^^^^^^^^^^
.. autoclass:: ev3devices.UltrasonicSensor
Gyroscopic Sensor
^^^^^^^^^^^^^^^^^
.. autoclass:: ev3devices.GyroSensor
+2 -2
View File
@@ -18,8 +18,8 @@ Welcome to Pybricks's documentation!
:maxdepth: 1
:caption: Modules:
ev3brick
ev3devices
brick
devices
parameters
tools
-1
View File
@@ -20,7 +20,6 @@ Intro
:no-members:
.. autoclass:: parameters.Pattern
:no-members:
.. autoclass:: parameters.Align
:no-members:
+7
View File
@@ -61,3 +61,10 @@ TODO definition of physical quantity and units and :py:obj:`float` type
frequency: Hz
--------------
TODO definition of physical quantity and units and :py:obj:`float` type
.. _colortuple:
custom color
--------------
TODO definition of physical quantity and units and :py:obj:`float` type