compAIR/compLIB
compAIR/compLIB
Archived
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Konstantin Lampalzer 2021-01-23 13:37:07 +01:00
parent f72550146d
commit a7f5dd13c4
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
23 changed files with 541 additions and 189 deletions
Download patch file Download diff file Expand all files Collapse all files

10
_sources/lib/Api.rst.txt
View file

@ -1,29 +1,29 @@
.. _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
---------------------

8
_sources/lib/Battery.rst.txt
View file

@ -1,20 +1,20 @@
.. _lib_battery:
Battery
########
********
Class Documentation
********************
====================
.. autoclass:: compLib.Battery.Battery
:members:
Examples
*********
=========
Printing percentage
====================
--------------------
.. code-block:: python

8
_sources/lib/Buzzer.rst.txt
View file

@ -1,19 +1,19 @@
.. _lib_buzzer:
Buzzer
#######
*******
Class Documentation
********************
====================
.. autoclass:: compLib.Buzzer.Buzzer
:members:
Examples
*********
=========
Turning buzzer on and off
==========================
--------------------------
.. code-block:: python

2
_sources/lib/IRSensor.rst.txt
View file

@ -1,7 +1,7 @@
.. _lib_irsensor:
Infrared Sensor
================
****************
.. autoclass:: compLib.IRSensor.IRSensor
:members:

22
_sources/lib/Logging.rst.txt Normal file
View file

@ -0,0 +1,22 @@
.. _lib_logging:
Logging
*******
Class Documentation
====================
.. autoclass:: compLib.LogstashLogging.Logging
:members:
Examples
=========
Turn up the logging
--------------------
.. code-block:: python
from compLib.LogstashLogging import Logging
Logging.set_debug()

8
_sources/lib/Motor.rst.txt
View file

@ -1,19 +1,19 @@
.. _lib_motor:
Motor
######
******
Class Documentation
********************
====================
.. autoclass:: compLib.Motor.Motor
:members:
Examples
*********
=========
Driving straight (maybe)
=========================
-------------------------
.. code-block:: python

2
_sources/lib/Servo.rst.txt
View file

@ -1,7 +1,7 @@
.. _lib_servo:
Servo
=====
******
.. autoclass:: compLib.Servo.Servo
:members:

8
_sources/lib/Vision.rst.txt
View file

@ -1,7 +1,7 @@
.. _lib_vision:
Vision
=====
*******
This module provides an interface for grabbing an rtmp stream and using the images to do some processing in opencv.
@ -13,7 +13,7 @@ How do I use this module?
4. You can view the http stream of your processed images in a web browser
Opencv Stream
*************
==============
Because of the rtmp stream needing to buffer some frames and waiting for P-Frames, importing this module might take up
to 5 Seconds.
@ -22,10 +22,10 @@ to 5 Seconds.
:members:
Examples
*********
=========
Using the Vision Module
---------------------
-------------------------
.. code-block:: python