mirror of
https://github.com/xtacocorex/CHIP_IO
synced 2025-07-20 04:43:21 +00:00
moving the docs to separate files as it will be easier to maintain
This commit is contained in:
20
docs/gpio.md
Normal file
20
docs/gpio.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
## CHIP_IO.GPIO
|
||||||
|
Import the GPIO module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.GPIO as GPIO
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
GPIO.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
[home](./index.md)
|
123
docs/index.md
123
docs/index.md
@ -1,117 +1,8 @@
|
|||||||
## CHIP_IO.GPIO
|
## CHIP_IO API Documentation
|
||||||
Import the GPIO module as follows
|
|
||||||
|
|
||||||
```python
|
|
||||||
import CHIP_IO.GPIO as GPIO
|
|
||||||
```
|
|
||||||
|
|
||||||
### toggle_debug()
|
|
||||||
Enable/Disable the Debug
|
|
||||||
|
|
||||||
* Parameters
|
|
||||||
None
|
|
||||||
|
|
||||||
* Examples
|
|
||||||
|
|
||||||
```python
|
|
||||||
GPIO.toggle_debug()
|
|
||||||
```
|
|
||||||
|
|
||||||
## CHIP_IO.PWM
|
|
||||||
Import the PWM module as follows
|
|
||||||
|
|
||||||
```python
|
|
||||||
import CHIP_IO.PWM as PWM
|
|
||||||
```
|
|
||||||
|
|
||||||
### toggle_debug()
|
|
||||||
Enable/Disable the Debug
|
|
||||||
|
|
||||||
* Parameters
|
|
||||||
None
|
|
||||||
|
|
||||||
* Examples
|
|
||||||
|
|
||||||
```python
|
|
||||||
PWM.toggle_debug()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## CHIP_IO.SOFTPWM
|
|
||||||
Import the SOFTPWM module as follows
|
|
||||||
|
|
||||||
```python
|
|
||||||
import CHIP_IO.SOFTPWM as SPWM
|
|
||||||
```
|
|
||||||
|
|
||||||
### toggle_debug()
|
|
||||||
Enable/Disable the Debug
|
|
||||||
|
|
||||||
* Parameters
|
|
||||||
None
|
|
||||||
|
|
||||||
* Examples
|
|
||||||
|
|
||||||
```python
|
|
||||||
SPWM.toggle_debug()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## CHIP_IO.SERVO
|
|
||||||
Import the SERVO module as follows
|
|
||||||
|
|
||||||
```python
|
|
||||||
import CHIP_IO.SERVO as SERVO
|
|
||||||
```
|
|
||||||
|
|
||||||
### toggle_debug()
|
|
||||||
Enable/Disable the Debug
|
|
||||||
|
|
||||||
* Parameters
|
|
||||||
None
|
|
||||||
|
|
||||||
* Examples
|
|
||||||
|
|
||||||
```python
|
|
||||||
SERVO.toggle_debug()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## CHIP_IO.LRADC
|
|
||||||
Import the LRADC module as follows
|
|
||||||
|
|
||||||
```python
|
|
||||||
import CHIP_IO.LRADC as LRADC
|
|
||||||
```
|
|
||||||
|
|
||||||
### toggle_debug()
|
|
||||||
Enable/Disable the Debug
|
|
||||||
|
|
||||||
* Parameters
|
|
||||||
None
|
|
||||||
|
|
||||||
* Examples
|
|
||||||
|
|
||||||
```python
|
|
||||||
LRADC.toggle_debug()
|
|
||||||
```
|
|
||||||
|
|
||||||
## CHIP_IO.Utilities
|
|
||||||
Import the Utilities module as follows
|
|
||||||
|
|
||||||
```python
|
|
||||||
import CHIP_IO.Utilities as UT
|
|
||||||
```
|
|
||||||
|
|
||||||
### toggle_debug()
|
|
||||||
Enable/Disable the Debug
|
|
||||||
|
|
||||||
* Parameters
|
|
||||||
None
|
|
||||||
|
|
||||||
* Examples
|
|
||||||
|
|
||||||
```python
|
|
||||||
UT.toggle_debug()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
* [CHIP_IO.GPIO](./gpio.md)
|
||||||
|
* [CHIP_IO.PWM](./pwm.md)
|
||||||
|
* [CHIP_IO.SOFTPWM](./softpwm.md)
|
||||||
|
* [CHIP_IO.SERVO](./servo.md)
|
||||||
|
* [CHIP_IO.LRADC](./lradc.md)
|
||||||
|
* [CHIP_IO.Utilities](./utilities.md)
|
||||||
|
20
docs/lradc.md
Normal file
20
docs/lradc.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
## CHIP_IO.LRADC
|
||||||
|
Import the LRADC module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.LRADC as LRADC
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
LRADC.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
[home](./index.md)
|
22
docs/pwm.md
Normal file
22
docs/pwm.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
## CHIP_IO.PWM
|
||||||
|
Import the PWM module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.PWM as PWM
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
PWM.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[home](./index.md)
|
20
docs/servo.md
Normal file
20
docs/servo.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
## CHIP_IO.SERVO
|
||||||
|
Import the SERVO module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.SERVO as SERVO
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
SERVO.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
[home](./index.md)
|
20
docs/softpwm.md
Normal file
20
docs/softpwm.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
## CHIP_IO.SOFTPWM
|
||||||
|
Import the SOFTPWM module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.SOFTPWM as SPWM
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
SPWM.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
[home](./index.md)
|
20
docs/utilities.md
Normal file
20
docs/utilities.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
## CHIP_IO.Utilities
|
||||||
|
Import the Utilities module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.Utilities as UT
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
UT.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
[home](./index.md)
|
Reference in New Issue
Block a user