diff --git a/docs/gpio.md b/docs/gpio.md index d9fa913..64c9dd3 100644 --- a/docs/gpio.md +++ b/docs/gpio.md @@ -9,6 +9,7 @@ Import the GPIO module as follows Enable/Disable the Debug * Parameters + None * Examples diff --git a/docs/index.md b/docs/index.md index 62f013c..9568d4e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,3 +6,4 @@ * [CHIP_IO.SERVO](./servo.md) * [CHIP_IO.LRADC](./lradc.md) * [CHIP_IO.Utilities](./utilities.md) +* [CHIP_IO.OverlayManager](./overlaymanager.md) diff --git a/docs/lradc.md b/docs/lradc.md index bab4d33..c2ed04d 100644 --- a/docs/lradc.md +++ b/docs/lradc.md @@ -9,6 +9,7 @@ Import the LRADC module as follows Enable/Disable the Debug * Parameters + None * Examples diff --git a/docs/overlaymanager.md b/docs/overlaymanager.md new file mode 100644 index 0000000..0b6712e --- /dev/null +++ b/docs/overlaymanager.md @@ -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) diff --git a/docs/pwm.md b/docs/pwm.md index 26a54a7..1bfd97c 100644 --- a/docs/pwm.md +++ b/docs/pwm.md @@ -9,6 +9,7 @@ Import the PWM module as follows Enable/Disable the Debug * Parameters + None * Examples diff --git a/docs/servo.md b/docs/servo.md index 2d2e81c..b486ff6 100644 --- a/docs/servo.md +++ b/docs/servo.md @@ -9,6 +9,7 @@ Import the SERVO module as follows Enable/Disable the Debug * Parameters + None * Examples diff --git a/docs/softpwm.md b/docs/softpwm.md index 66fe8f5..aa9f200 100644 --- a/docs/softpwm.md +++ b/docs/softpwm.md @@ -9,6 +9,7 @@ Import the SOFTPWM module as follows Enable/Disable the Debug * Parameters + None * Examples diff --git a/docs/utilities.md b/docs/utilities.md index 4296215..fe9f02f 100644 --- a/docs/utilities.md +++ b/docs/utilities.md @@ -9,6 +9,11 @@ Import the Utilities module as follows Enable/Disable the Debug * Parameters + + None + +* Returns + None * Examples @@ -17,4 +22,6 @@ Enable/Disable the Debug UT.toggle_debug() ``` + + [home](./index.md)