mirror of
https://github.com/xtacocorex/CHIP_IO
synced 2025-07-20 04:43:21 +00:00
added overlaymanager.md
This commit is contained in:
@ -9,6 +9,7 @@ Import the GPIO module as follows
|
|||||||
Enable/Disable the Debug
|
Enable/Disable the Debug
|
||||||
|
|
||||||
* Parameters
|
* Parameters
|
||||||
|
|
||||||
None
|
None
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
|
@ -6,3 +6,4 @@
|
|||||||
* [CHIP_IO.SERVO](./servo.md)
|
* [CHIP_IO.SERVO](./servo.md)
|
||||||
* [CHIP_IO.LRADC](./lradc.md)
|
* [CHIP_IO.LRADC](./lradc.md)
|
||||||
* [CHIP_IO.Utilities](./utilities.md)
|
* [CHIP_IO.Utilities](./utilities.md)
|
||||||
|
* [CHIP_IO.OverlayManager](./overlaymanager.md)
|
||||||
|
@ -9,6 +9,7 @@ Import the LRADC module as follows
|
|||||||
Enable/Disable the Debug
|
Enable/Disable the Debug
|
||||||
|
|
||||||
* Parameters
|
* Parameters
|
||||||
|
|
||||||
None
|
None
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
|
76
docs/overlaymanager.md
Normal file
76
docs/overlaymanager.md
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
## CHIP_IO.OverlayManager
|
||||||
|
Import the OverlayManager module as follows
|
||||||
|
|
||||||
|
```python
|
||||||
|
import CHIP_IO.OverlayManager as OM
|
||||||
|
```
|
||||||
|
|
||||||
|
### toggle_debug()
|
||||||
|
Enable/Disable the Debug
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
OM.toggle_debug()
|
||||||
|
```
|
||||||
|
|
||||||
|
### get_spi_loaded()
|
||||||
|
Check to see if the SPI DTBO is loaded
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
|
||||||
|
boolean
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
is_spi_loaded = OM.get_spi_loaded()
|
||||||
|
```
|
||||||
|
|
||||||
|
### get_pwm_loaded()
|
||||||
|
Check to see if the PWM0 DTBO is loaded
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
|
||||||
|
boolean
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
is_pwm_loaded = OM.get_pwm_loaded()
|
||||||
|
```
|
||||||
|
|
||||||
|
### get_custom_loaded()
|
||||||
|
Check to see if the Custom DTBO is loaded
|
||||||
|
|
||||||
|
* Parameters
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
|
||||||
|
boolean
|
||||||
|
|
||||||
|
* Examples
|
||||||
|
|
||||||
|
```python
|
||||||
|
is_custom_loaded = OM.get_custom_loaded()
|
||||||
|
```
|
||||||
|
|
||||||
|
[home](./index.md)
|
@ -9,6 +9,7 @@ Import the PWM module as follows
|
|||||||
Enable/Disable the Debug
|
Enable/Disable the Debug
|
||||||
|
|
||||||
* Parameters
|
* Parameters
|
||||||
|
|
||||||
None
|
None
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
|
@ -9,6 +9,7 @@ Import the SERVO module as follows
|
|||||||
Enable/Disable the Debug
|
Enable/Disable the Debug
|
||||||
|
|
||||||
* Parameters
|
* Parameters
|
||||||
|
|
||||||
None
|
None
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
|
@ -9,6 +9,7 @@ Import the SOFTPWM module as follows
|
|||||||
Enable/Disable the Debug
|
Enable/Disable the Debug
|
||||||
|
|
||||||
* Parameters
|
* Parameters
|
||||||
|
|
||||||
None
|
None
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
|
@ -9,6 +9,11 @@ Import the Utilities module as follows
|
|||||||
Enable/Disable the Debug
|
Enable/Disable the Debug
|
||||||
|
|
||||||
* Parameters
|
* Parameters
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
|
||||||
None
|
None
|
||||||
|
|
||||||
* Examples
|
* Examples
|
||||||
@ -17,4 +22,6 @@ Enable/Disable the Debug
|
|||||||
UT.toggle_debug()
|
UT.toggle_debug()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[home](./index.md)
|
[home](./index.md)
|
||||||
|
Reference in New Issue
Block a user