Bug fixes and improved compatibility.

Author: Michael Stoops

README.md

@@ -4,9 +4,6 @@ Raspberry Pi Pico Setup provides a script for installing the Pico SDK and toolch
 
 # How-To
 
-<<<<<<< HEAD
-Download and run `pico_setup.sh`.
-=======
 Download and run `pico_setup.sh`:
 ```shell
 wget https://raw.githubusercontent.com/raspberrypi/pico-setup/master/pico_setup.sh
@@ -16,30 +13,24 @@ chmod +x pico_setup
 The script uses sudo, so you may need to enter your password.
 
 After the script is complete, reboot to ensure that all changes take effect, such as the UART settings and environment variables.
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 
 If you want the testing script and documentation, you can clone the git repo too.
 
 # Support
 
+This script works on most Debian-derived Linux distros and macOS, running on common Raspberry Pi, PC, and Mac hardware. This ***DOESN'T*** mean that all of the pico tools work properly on these platforms. It just means that this script runs and passes its own tests.
+
 Operating systems:
 * Raspberry Pi OS (32-bit)
 * Debian 10 (Buster)
 * Ubuntu 20.10 (Groovy)
 * macOS 11 (Big Sur)
+* Ubuntu 20.04 on Windows Subsystem for Linux on Windows Server 2019 Base
+* Debian GNU/Linux 1.3.0.0 on Windows Subsystem for Linux on Windows Server 2019 Base
 
-Hardware:
-<<<<<<< HEAD
-* Raspberry Pi 2/3/4/400
-* PC (x86_64)
-* Mac (both Intel and Apple Silicon)
-
-Other versions may work, but haven't been tested. Use at your own risk.
-
-# Testing
+This script does not support Windows natively, only Windows Subsystem for Linux.
 
-See [test/README.md](test/README.md)
-=======
+Hardware:
 * Raspberry Pi 2/3/4/400/CM3/CM4
 * PC (x86_64)
 * Mac (both Intel and Apple Silicon)
@@ -49,4 +40,3 @@ Other OSes and hardware may work, but haven't been tested. Use at your own risk.
 # Testing
 
 See [test/README.md](test/README.md).
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.

pico_setup.sh

@@ -20,7 +20,6 @@
 # Download and install Visual Studio Code and required extensions
 
 
-
 # Exit on error
 set -e
 # Show all commands
@@ -112,7 +111,7 @@ phase_0() {
 install_toolchain_linux() {
     # Install toolchain for Linux
 
-    DEPS="git cmake gcc-arm-none-eabi build-essential gdb-multiarch automake autoconf build-essential texinfo libtool libftdi-dev libusb-1.0-0-dev"
+    DEPS="python3 git cmake gcc-arm-none-eabi build-essential gdb-multiarch automake autoconf build-essential texinfo libtool libftdi-dev libusb-1.0-0-dev"
     if debian || ubuntu; then
         DEPS="${DEPS} pkg-config libstdc++-arm-none-eabi-newlib"
     fi
@@ -172,9 +171,10 @@ clone_repo() {
     fi
 }
 
-set_envs() {
-    # Permanently sets environment variables by adding them to the current user's profile script
-    # arguments should be in the form of FOO=foo BAR=bar
+set_env() {
+    # Permanently sets an environment variable by adding it to the current user's profile script
+    # $1 should be in the form of FOO=foo
+    EXPR="${1}"
 
     # detect appropriate file for setting env vars
     if echo "${SHELL}" | grep -q zsh; then
@@ -186,25 +186,23 @@ set_envs() {
     fi
 
     # ensure that appends go to a new line
-    if [ -f ${FILE} ]; then
-        if tail -n 1 ${FILE} | grep -q "^$"; then
+    if [ -f "${FILE}" ]; then
+        if tail -n 1 "${FILE}" | grep -q "^$"; then
             echo "${FILE} exists and has trailing newline."
         else
             echo "${FILE} exists but has no trailing newline. Adding newline."
-            echo >> ${FILE}
+            echo >> "${FILE}"
         fi
     fi
 
-    for EXPR in ${*}; do
-        # set for now
-        export "${EXPR}"
-        
-        # set for later
-        if ! grep -q "^export ${EXPR}$" ${FILE}; then
-            echo "Setting env variable ${EXPR} in ${FILE}"
-            echo "export ${EXPR}" >> ${FILE}
-        fi
-    done
+    # set for now
+    export "${EXPR}"
+    
+    # set for later
+    if ! grep -q "^export ${EXPR}$" "${FILE}"; then
+        echo "Setting env variable ${EXPR} in ${FILE}"
+        echo "export \"${EXPR}\"" >> "${FILE}"
+    fi
 }
 
 setup_sdk() {
@@ -216,7 +214,7 @@ setup_sdk() {
     # Set env var PICO_SDK_PATH
     REPO_UPPER=$(echo ${REPO_NAME} | tr "[:lower:]" "[:upper:]")
     REPO_UPPER=$(echo ${REPO_UPPER} | tr "-" "_")
-    set_envs "${REPO_UPPER}_PATH=$DEST"
+    set_env "${REPO_UPPER}_PATH=$DEST"
 }
 
 enable_uart() {

test/README.md

@@ -32,11 +32,18 @@ If all of the dependencies (APT repo, etc) are in good shape, this should work t
 Write fresh SD card with Raspberry Pi Imager.
 
 ### Raspberry Pi OS Lite (32-bit) on Raspberry Pi 4B
-Should be the same as the full OS. Currently, this will install Visual Studio Code, but that may change.
+Should be the same as the full OS, but doesn't install Visual Studio Code because there's no XWindows.
 
 Write fresh SD card with Raspberry Pi Imager.
 
 ### Ubuntu Desktop 20.10 (64-bit) on Raspberry Pi 4B
+Not yet tested.
+
+Less common. Should work a lot like Raspberry Pi OS, but with a couple different package dependencies.
+
+Write fresh SD card with Raspberry Pi Imager.
+
+### Ubuntu Server 20.10 (32-bit) on Raspberry Pi 4B
 Less common. Should work a lot like Raspberry Pi OS, but with a couple different package dependencies.
 
 Write fresh SD card with Raspberry Pi Imager.
@@ -89,25 +96,29 @@ passwd admin
 ### Windows Server 2016 Base on x86_64
 Not yet tested. See https://aws.amazon.com/marketplace/server/procurement?productId=13c2dbc9-57fc-4958-922e-a1ba7e223b0d.
 
-### Ubuntu 20.04 on WSL2 on Windows Server 2019 Base on x86_64
-Not yet tested. https://aws.amazon.com/marketplace/server/procurement?productId=ef297a90-3ad0-4674-83b4-7f0ec07c39bb.
-
-t3.large
+### Ubuntu 20.04 on WSL1 on Windows Server 2019 Base on x86_64
+Can be rented on [EC2](https://aws.amazon.com/marketplace/server/procurement?productId=ef297a90-3ad0-4674-83b4-7f0ec07c39bb) for pennies/hour. Recommend t3.large. Default user is `ec2-user`. Connect with Microsoft Remote Desktop.
 
-https://docs.microsoft.com/en-us/windows/wsl/install-on-server
+Install WSL according to https://docs.microsoft.com/en-us/windows/wsl/install-on-server. Install Ubuntu for WSL
 
-Download Linux archive
-
-Find archive and extract all
-Run the program. 
+In the Linux shell:
+```shell
+wget https://raw.githubusercontent.com/raspberrypi/pico-setup/master/pico_setup.sh
+chmod +x pico_setup.sh
+./pico_setup.sh
+```
 
+### Debian GNU/Linux 1.3.0.0 on WSL1 on Windows Server 2019 Base on x86_64
+Similar instructions as Ubuntu, but using the Debian WSL package and you'll have to explicitly install wget:
+```shell
+sudo apt update
+sudo apt install -y wget
+```
 
-### Debian 10 (Buster) on WSL2 on Windows Server 2016 Base on x86_64
-Not yet tested.
+Currently fails due to lack of python3.
 
 ## Scenarios
 Test some scenarios:
 * Shells: bash, zsh. It should be enough to switch shells and rerun the installer and test. You don't have to wipe the SD card/disk.
 * .profile or .zprofile doesn't end in newline
-* PWD containing space
-* Raspberry Pi OS Lite (32-bit) shouldn't install VS Code
+* PWD containing space. The script seems to handle it but a OpenOCD submodule, jimctl, doesn't.

test/test

@@ -8,8 +8,6 @@ set -ex
 
 WORKING_DIR="$(pwd)/pico"
 
-<<<<<<< HEAD
-=======
 linux() {
     # Returns true iff this is running on Linux
     uname | grep -q "^Linux$"
@@ -28,15 +26,12 @@ ubuntu() {
     return ${?}
 }
 
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 mac() {
     # Returns true iff this is running on macOS and presumably Apple hardware
     uname | grep -q "^Darwin$"
     return ${?}
 }
 
-<<<<<<< HEAD
-=======
 raspberry_pi() {
     # Returns true iff this is running on a Raspberry Pi computer, regardless of the OS
     if [ -f /proc/cpuinfo ]; then
@@ -47,7 +42,6 @@ raspberry_pi() {
 }
 
 
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 fail() {
     # Outputs a failure message and exits with the error code output by the previous call.
     # All args are echoed as a failure message.
@@ -82,8 +76,6 @@ test_pico_sdk() {
     test "${PICO_SDK_PATH}" = "${WORKING_DIR}/pico-sdk" || fail
 }
 
-<<<<<<< HEAD
-=======
 test_uart() {
     # test that the UART is configured. Only works on Raspberry Pi OS on Raspberry Pi hardware.
     dpkg-query -s minicom || fail
@@ -92,7 +84,6 @@ test_uart() {
     grep -q "console=serial0" /boot/cmdline.txt && fail
 }
 
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 test_pico_examples() {
     test_git_repo pico-examples
 
@@ -143,16 +134,10 @@ test_vscode_linux() {
 }
 
 test_vscode_mac() {
-<<<<<<< HEAD
-    echo "This script can't tell whether Visual Studio Code is installed on macOS"
-}
-
-=======
     echo "Not yet implemented: testing Visual Studio Code on macOS"
 }
 
 
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 # execute tests
 if mac; then
     test_toolchain_mac
@@ -162,13 +147,10 @@ fi
 
 test_pico_sdk
 
-<<<<<<< HEAD
-=======
 if raspbian && raspberry_pi; then
     test_uart
 fi
 
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 test_pico_examples
 test_pico_extras
 test_pico_playground
@@ -178,13 +160,9 @@ test_picotool
 if mac; then
     test_vscode_mac
 else
-<<<<<<< HEAD
-    test_vscode_mac
-=======
     if dpkg-query -s xserver-xorg >> /dev/null && ! (debian || ubuntu); then
         test_vscode_linux
     fi
->>>>>>> 4f2c6f4... Major rewrite. Added support for macOS, Debian, Ubuntu. Added test/validation script.
 fi
 
 echo "Tests passed! 😁"