Merge pull request #41 from Open-STEM/v097

v0.9.7 basic changes

Author: AnselChang

README.md

@@ -1,73 +1,13 @@
 # Getting Starting with your XRP Robot
 
-- First steps of tutorial borrowed from [here](https://projects.raspberrypi.org/en/projects/get-started-pico-w/1)
+### Step 1: Plug XRP Robot Controller Board into Computer
 
-# Step 1: Install Micropython on your XRP Robot Controller:
+### Step 2: Navigate to [xrpcode.wpi.edu](https://xrpcode.wpi.edu)
 
+- Follow instructions there to install MicroPython and the libraries onto the board
 
-### Download the latest version of Raspberry Pi Pico W firmware [here](https://rpf.io/pico-w-firmware)
+### Step 3: Navigate to the tutorial linked there to learn how to use the bot!
 
-Connect the small end of your micro USB cable to the Raspberry Pi Pico W.
+$~$
 
-![A Raspberry Pi Pico W connected to the small end of a micro USB cable.](https://projects-static.raspberrypi.org/projects/get-started-pico-w/0b627b5c80e71000b5116ecc35acaa49094aef84/en/images/pico-top-plug.png)
-
-Hold down the BOOTSEL button on your Raspberry Pi Pico W.
-
-![A Raspberry Pi Pico W with the BOOTSEL button highlighted](https://projects-static.raspberrypi.org/projects/get-started-pico-w/0b627b5c80e71000b5116ecc35acaa49094aef84/en/images/bootsel.png)
-
-Connect the other end to your desktop computer, laptop, or Raspberry Pi.
-
-![A Raspberry Pi Pico W connected to a laptop via a micro USB cable.](https://projects-static.raspberrypi.org/projects/get-started-pico-w/0b627b5c80e71000b5116ecc35acaa49094aef84/en/images/plug-in-pico.png)
-
-Your file manager should open up, with Raspberry Pi Pico being show as an externally connected drive. Drag and drop the firmware file you downloaded into the file manager. Your Raspberry Pi Pico should disconnect and the file manager will close.
-
-![Image of the Windows file manager opened, showing Raspberry Pi Pico connected as an external drive](https://projects-static.raspberrypi.org/projects/get-started-pico-w/0b627b5c80e71000b5116ecc35acaa49094aef84/en/images/file_manager.png)
-
-
-# Step 2: Installing dev environment (Mu)
-
-
-### Download the latest version of the Mu editor [here](https://codewith.mu)
-
-Open Mu, and select the RP2040 Option (Or whichever option represents using Micropython for the board you have)
-
-![](https://codewith.mu/img/en/tutorials/mode_selector1-1.png)
-
-## Step 3: Installing the library using mip
-
-Open up a new file in mu.
-
-Copy the following code into that file:
-
-```python
-import network
-import mip
-import time
-
-def install_update_library(wifi_ssid, wifi_password, timeout = 5):
-    
-    wlan = network.WLAN(network.STA_IF)
-    # Configure board to connect to wifi
-    wlan.active(True)
-    wlan.connect(wifi_ssid,wifi_password)
-    start_time = time.time()
-    # Wait until connection is confirmed before attempting install
-    while not wlan.isconnected():
-            print("Connecting to network, may take a second")
-            if time.time() > start_time+timeout:
-                print("Failed to connect to network, please try again")
-                wlan.disconnect()
-                return
-            time.sleep(0.25)
-    # Install up-to-date library files and dependencies
-    mip.install("github:Open-STEM/XRP_MicroPython")
-    # Disconnect and disable wifi, since it is no longer needed
-    wlan.disconnect()
-    wlan.active(False)
-    
-install_update_library("your-ssid","your-password")
-```
-
-Edit the method call at the bottom to include your wifi's details, then hit run.
-
-Check the Serial Monitor to confirm that the libraries were properly installed.
+### That's it! Happy Learning!

XRPLib/version.py

@@ -5,6 +5,8 @@
 import network
 import time
 
+logging.log_file = "webserverLog.txt"
+
 class Webserver:
 
     @classmethod

XRPLib/webserver.py

@@ -7,10 +7,12 @@
 import os
 import sys
 import datetime
+import json
 
 sys.path.insert(0, os.path.abspath(".."))
 
-from XRPLib.version import __version__
+with open("../package.json", "r") as read_file:
+    __version__ = json.load(read_file)["version"]
 
 # -- General configuration ------------------------------------------------
 

docs/conf.py

@@ -24,13 +24,12 @@
       ["XRPExamples/installation_verification.py", "github:Open-STEM/XRP_Micropython/Examples/installation_verification.py"],
       ["XRPExamples/misc_examples.py", "github:Open-STEM/XRP_Micropython/Examples/misc_examples.py"],
       ["XRPExamples/sensor_examples.py", "github:Open-STEM/XRP_Micropython/Examples/sensor_examples.py"],
-      ["XRPExamples/webserver_example.py", "github:Open-STEM/XRP_Micropython/Examples/webserver_example.py"],
-      ["XRPExamples/xrp_test.py", "github:Open-STEM/XRP_Micropython/Examples/xrp_test.py"]
+      ["XRPExamples/webserver_example.py", "github:Open-STEM/XRP_Micropython/Examples/webserver_example.py"]
     ],
     "deps": [
       ["github:pimoroni/phew", "latest"],
       ["collections-defaultdict", "latest"],
       ["os-path", "latest"]
     ],
-    "version": "0.9.6"
+    "version": "0.9.7"
   }