Added installation verification to generated page

Author: ksiegall

Examples/installation_verification.py

@@ -0,0 +1,27 @@
+from XRPLib.defaults import *
+from .drive_examples import *
+from .misc_examples import *
+import time
+
+# Installation Verification Program
+def ivp():
+    while not board.is_button_pressed():
+        print(f"Left Reflectance: {reflectance.get_left()}, Right Reflectance: {reflectance.get_right()}")
+        time.sleep(0.1)
+    while board.is_button_pressed():
+        time.sleep(.01)
+    while not board.is_button_pressed():
+        print(f"Ultrasonic Distance: {rangefinder.distance()}")
+        time.sleep(0.1)
+    while board.is_button_pressed():
+        time.sleep(.01)
+    print("Testing Servo")
+    test_servo()
+    print("Testing LEDs")
+    wait_for_button()
+    test_leds()
+    print("Testing Drivetrain:")
+    wait_for_button()
+    test_drive()
+
+ivp()

docs/examples.rst

@@ -1,7 +1,7 @@
-Simple test
+Example Code
 ------------
 
-Ensure your device works with this simple test.
+Feel free to read through, import, and use any of the below sample code:
 
 .. literalinclude:: ../Examples/drive_examples.py
     :caption: Examples/drive_examples.py
@@ -11,10 +11,10 @@ Ensure your device works with this simple test.
     :caption: Examples/sensor_examples.py
     :linenos:
 
-.. literalinclude:: ../Examples/webserver_example.py
-    :caption: Examples/sensor_examples.py
+.. literalinclude:: ../Examples/misc_examples.py
+    :caption: Examples/misc_examples.py
     :linenos:
 
-.. literalinclude:: ../Examples/misc_examples.py
-    :caption: Examples/sensor_examples.py
+.. literalinclude:: ../Examples/webserver_example.py
+    :caption: Examples/webserver_example.py
     :linenos:

docs/index.rst

@@ -19,6 +19,7 @@ Table of Contents
 .. toctree::
     :caption: Examples
 
+    installation_check
     examples
 
 .. toctree::

docs/installation_check copy.rst

@@ -0,0 +1,8 @@
+Simple test
+------------
+
+Ensure your device works with this simple test.
+
+.. literalinclude:: ../Examples/installation_verification.py
+    :caption: Examples/installation_verification.py
+    :linenos:

docs/installation_check.rst.license

@@ -0,0 +1,4 @@
+SPDX-FileCopyrightText: 2023 Kevin Siegall, written for OpenSTEM @ WPI
+SPDX-FileCopyrightText: Copyright (c) 2023 Open STEM Authors for WPI
+
+SPDX-License-Identifier: MIT