doc: drop features that won't be implemented for first release

Combined with previous comments, this closes #91
This commit is contained in:
Laurens Valk
2019-01-18 17:19:19 +01:00
parent de8d91df4b
commit daa213b003
4 changed files with 3 additions and 79 deletions
-13
View File
@@ -56,16 +56,3 @@ class Speaker():
"""
pass
def speak(self, text, volume=30):
"""Speak a given string of text.
Arguments:
text (str): The text to speak.
volume (:ref:`percentage`): Volume of the sound (*Default*: 100).
::
# Say "Hi!"
brick.sound.speak('Hi!')
"""
pass
+1 -1
View File
@@ -1,6 +1,6 @@
"""LEGO MINDSTORMS EV3 Brick"""
from parameters import Color, Pattern
from parameters import Color
from _speaker import Speaker
from _display import Display
-41
View File
@@ -85,31 +85,6 @@ class Motor():
"""
pass
def reference(self):
"""Get the reference angle and reference speed of the motor.
Returns:
Tuple of motor angle and speed reference at the current time.
:rtype: (:ref:`angle`, :ref:`speed`) or (``None``, ``None``) if no maneuver is active.
"""
pass
def maneuver(self):
"""
Get the time, angle, velocity, and acceleration parameters of the currently active motor maneuver.
See :ref:`maneuvers` for a description of each symbol.
Returns:
(:math:`t_0`, :math:`t_1`, :math:`t_2`, :math:`t_3`),
(:math:`\\theta_0`, :math:`\\theta_1`, :math:`\\theta_2`, :math:`\\theta_3`),
(:math:`\\omega_0`, :math:`\\omega_1`),
(:math:`\\alpha_0`, :math:`\\alpha_2`)
:rtype: Four tuples of :ref:`time`, :ref:`angle`, :ref:`speed`, and :ref:`acceleration`
"""
pass
def stalled(self):
"""Check whether the motor is currently stalled.
@@ -520,19 +495,3 @@ class UltrasonicSensor():
:obj:`bool`: ``True`` if ultrasonic sounds are detected, ``False`` if not.
"""
pass
def send(self, number):
"""Transmit an encoded number using ultrasonic waves.
The number is converted to a binary sequence, which is transmitted by turning the sensor on and off. The message always starts with one pulse as the start of the message, followed by 8 "bits" where the sensor is either on or off during a short interval.
Arguments:
number (int): The number to transmit (0-255)
"""
def receive(self):
"""Wait for a message from another ultrasonic sensor and convert it to a number.
Returns:
:obj:`int`: The received number (0-255)
"""
+2 -24
View File
@@ -149,8 +149,8 @@ class Direction():
"""
clockwise = 1
counterclockwise = -1
clockwise = 0
counterclockwise = 1
class Button(Enum):
@@ -194,28 +194,6 @@ class Button(Enum):
right_up = 9
class Pattern():
"""Standard light patterns."""
solid = [(100, 1000)]
"""The light stays on."""
blink1 = [(100, 500), (0, 500)]
"""The light blinks once per second: It stays on for 500 ms and then stays off for 500 ms."""
blink2 = [(100, 250), (0, 250)]
"""The light blinks twice per second: It stays on for 250 ms and then stays off for 250 ms."""
blink3 = [(100, 167), (0, 167)]
"""The light blinks three times per second: It stays on for 167 ms and then stays off for 167 ms."""
glow = [] # TODO
"""The light gradually turns on and then off again, as if glowing. (TODO)"""
ev3 = [(100, 100), (0, 100), (100, 100), (0, 700)] # TODO: Get the true values
"""The default pattern of a running EV3-G program."""
class Align():
"""Alignment of an image on a screen. TODO: use same logic as buttons??