doc: experiment with signal types

This commit is contained in:
Laurens Valk
2018-12-29 13:02:59 +01:00
parent a07aaadd23
commit 0cdf3fdebc
2 changed files with 34 additions and 2 deletions
+18 -2
View File
@@ -48,6 +48,22 @@ class Motor():
"""
pass
def run_time(self, speed):
"""Test docstring."""
def settings(self, torque_limit, stall_speed, stall_time, max_speed, speed_tolerance, angle_tolerance, acceleration_start, acceleration_end, manual_control_time, kp, ki, kd):
"""Test
Arguments:
torque_limit (:term:`percentage`): test
max_speed (:term:`speed`): test
speed_tolerance (:term:`speed`): test
angle_tolerance (:term:`angle`): test
acceleration_start (:term:`acceleration`): test
acceleration_end (:term:`acceleration`): test
stall_speed (:term:`speed`): test
stall_time (:term:`time`): test
manual_control_time (:term:`time`): test
kp (int): test
ki (int): test
kd (int): test
"""
pass
+16
View File
@@ -31,10 +31,15 @@ class Color(Enum):
class Port(Enum):
"""Port on the intelligent brick.
Motor ports:
.. data:: A
.. data:: B
.. data:: C
.. data:: D
Sensor ports:
.. data:: S1
.. data:: S2
.. data:: S3
@@ -151,6 +156,17 @@ class Direction():
class Button(Enum):
"""Buttons on a brick or remote:
.. data:: left_down
.. data:: down
.. data:: right_down
.. data:: left
.. data:: center
.. data:: right
.. data:: left_up
.. data:: up
.. data:: beacon
.. data:: right_up
+-----------+----------+-----------+
| | | |
| left_up |up/beacon | right_up |