Update documentation

This commit is contained in:
Joel 2021-01-17 04:35:51 +01:00
parent 0dbfc5fe6b
commit aa6fb2fc8b
No known key found for this signature in database
GPG key ID: BDDDBECD0808290E
17 changed files with 776 additions and 47 deletions

View file

@ -0,0 +1,67 @@
.. _lib_api:
Api
=====
Seeding
********
.. autoclass:: compLib.Api.Seeding
:members:
Double Elimination
*******************
.. autoclass:: compLib.Api.DoubleElim
:members:
Position
*********
.. autoclass:: compLib.Api.Position
:members:
Examples
*********
Calling Seeding API
---------------------
.. code-block:: python
from compLib.Api import Seeding
park = Seeding.get_park()
print(f"I should move to parking position: {park}")
if park == 0:
print(f"I can't move to this position yet :(")
elif park == 1:
print(f"Moving to position 1!")
# drive to parking position using Motors module...
print(f"Now hopefully at position 1")
# drive back using Motors module...
elif park == 2:
# do something similar to park == 1..
elif park == 3:
# do something similar to park == 1..
success = Seeding.pay_park()
if success:
print(f"We scored some points!")
else:
print(f"We failed :(")
Calling Double Elimination API
----------------------------------
.. code-block:: python
from compLib.Api import DoubleElim
position = DoubleElim.get_position()
print(f"Position of my robot is: x={position.x}, y={position.y} and rotation is: {position.degrees}")
goal = DoubleElim.get_goal()
print(f"Goal is at: x={goal.x}, y={goal.y}")