Add code examples
This commit is contained in:
parent
aa33dc36d8
commit
ec0b5562cf
3 changed files with 56 additions and 6 deletions
|
@ -1,7 +1,23 @@
|
|||
.. _lib_battery:
|
||||
|
||||
Battery
|
||||
=======
|
||||
########
|
||||
|
||||
Class Documentation
|
||||
********************
|
||||
|
||||
.. autoclass:: compLIB.Battery.Battery
|
||||
:members:
|
||||
:members:
|
||||
|
||||
|
||||
Examples
|
||||
*********
|
||||
|
||||
Printing percentage
|
||||
====================
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from compLIB.Battery import Battery
|
||||
|
||||
print(Battery.percent())
|
|
@ -1,7 +1,25 @@
|
|||
.. _lib_buzzer:
|
||||
|
||||
Buzzer
|
||||
=======
|
||||
#######
|
||||
|
||||
Class Documentation
|
||||
********************
|
||||
|
||||
.. autoclass:: compLIB.Buzzer.Buzzer
|
||||
:members:
|
||||
:members:
|
||||
|
||||
Examples
|
||||
*********
|
||||
|
||||
Turning buzzer on and off
|
||||
==========================
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import time
|
||||
from compLIB.Buzzer import Buzzer
|
||||
|
||||
Buzzer.set(True)
|
||||
time.sleep(1)
|
||||
Buzzer.set(False)
|
|
@ -1,7 +1,23 @@
|
|||
.. _lib_motor:
|
||||
|
||||
Motor
|
||||
=====
|
||||
######
|
||||
|
||||
Class Documentation
|
||||
********************
|
||||
|
||||
.. autoclass:: compLIB.Motor.Motor
|
||||
:members:
|
||||
:members:
|
||||
|
||||
Examples
|
||||
*********
|
||||
|
||||
Driving straight (maybe)
|
||||
=========================
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from compLIB.Motor import Motor
|
||||
|
||||
for port in range(0, 4):
|
||||
Motor.power(port, 50)
|
Reference in a new issue