switch to logger (more POSIX)

.gitignore

@@ -225,3 +225,4 @@ cython_debug/
 # PyPI configuration file
 .pypirc
 
+*.html

README.md

@@ -5,6 +5,7 @@ Scripts and documentation for setting up a Raspberry Pi (Zero W 1 or 2) for use
 # Procedure
 1. [Raspberry Pi Imager procedure to setup ssh and Raspberry Pi Connect](imager.md)
 1. Find out your Pi's ethernet addresss in case you need to find it on `iot-research` again.  Type `ip addr show dev wlan0` and for something like `link/ether 01:23:45:67:89:ab`.  Write this information (the 12 characters and colons) in your notebook.  In T-411-MECH we want you to put this information in a spreadsheet links from the main page:  this allows us connect Pi's to people in case of any issues.
+1. [Solder the GPIO header pins](solder-gpio.md)
 1. [Gadget Mode to setup a serial connection over USB](gadget.md)
 1. [Marcel's script on github to show the IP address on the OLED screen](https://github.com/mkyas/cpsy-display-ip)
 
@@ -20,6 +21,7 @@ Scripts and documentation for setting up a Raspberry Pi (Zero W 1 or 2) for use
 - [Turning your Raspberry Pi Zero into a USB Gadget](https://learn.adafruit.com/turning-your-raspberry-pi-zero-into-a-usb-gadget/serial-gadget)  Official Adafruit guide to gadget mode to allow the USB port to be used as a serial console to connect to it.   We had trouble getting it to work in 2026 due to some changes in Raspberry Pi OS.
 - [Python gpiozero library](https://gpiozero.readthedocs.io/en/stable/) a simple interface for working with GPIO devices
 - [CircuitPython Libraries on Linux and Raspberry Pi](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/installing-circuitpython-on-raspberry-pi) This is one option for GPIO, I2C, SPI, and PWM access in python.
+- [Comparing Rasbperry Pi python interfaces](https://raspberry.tips/en/raspberrypi-tutorials/raspberry-pi-gpio-python)
 
 ## For the Future
 - [Setting up Zeroconf to use local names (.local) to access your Pi](https://learn.adafruit.com/bonjour-zeroconf-networking-for-windows-and-linux): this does not work on iot-research because multicast and MDNS are broken.

Scripts/gadget.sh

@@ -0,0 +1,83 @@
+#!/bin/bash
+# Adapted from
+# "Using OTG mode on Raspberry Pi SBCs"
+# https://pip-assets.raspberrypi.com/categories/685-app-notes-guides-whitepapers/documents/RP-009276-WP/Using-OTG-mode-on-Raspberry-Pi-SBCs
+
+# This script only works if you are running it as root
+if [ $(id -u) -ne 0 ]; then
+    echo "Please run as root or use sudo"
+    exit 1
+fi
+
+
+# Is the dwc2 overlay installed?  Nothing will work if it isn't.
+if lsmod | grep -q "dwc2"; then
+    echo "DWC2 module loaded, setting up OTG gadget serial and ethernet" | logger -t $0 -p info
+    echo "DWC2 module loaded"
+else
+    echo "DWC2 module missing.  Aborting OTG setup." | logger -t $0 -p info
+    echo "DWC2 module missing"
+    systemctl disable serial-getty@ttyGS0.service
+    exit 1
+fi
+
+modprobe libcomposite
+cd /sys/kernel/config/usb_gadget
+if [ -d "MyGadget" ]; then
+    echo "MyGadget already exists.  Aborting OTG setup." | logger -t $0 -p info
+    exit 1
+fi
+
+# Create our new gadget
+mkdir MyGadget
+cd MyGadget
+# Add some boilerplate data that the gadget needs
+echo 0x1d6b > idVendor # Linux Foundation’s USB VID. Replace with your own VID if required
+echo 0x0104 > idProduct # Multifunction Composite Gadget
+echo 0x0100 > bcdDevice # v1.0.0
+echo 0x0200 > bcdUSB # USB2
+mkdir strings/0x409 # 0x409 = English
+# Insert your own manufacturer and gadget name here
+echo "RaspberryPi" > strings/0x409/manufacturer
+echo "MyPiGadget" > strings/0x409/product
+# Make the serial number the same as the Raspberry Pi serial number; you can use whatever is required here
+SERIAL=`cat /proc/cpuinfo | awk '/Serial/ {print $3}' `
+echo $SERIAL > strings/0x409/serialnumber
+# Create a configuration area and populate
+mkdir configs/c.1
+echo 120 > configs/c.1/MaxPower
+mkdir configs/c.1/strings/0x409
+echo "Config 1" > configs/c.1/strings/0x409/configuration
+
+# Create our specific gadget type
+## Mass storage device
+###  Remember to create the storage block device first
+##  cd /root
+### Example: Make a 256 MB file to act as "USB stick"
+##  Only create it once or it will delete the previous content
+##  sudo dd if=/dev/zero of=drive.bin bs=1M count=256
+### Create a VFAT file system on the backing store
+##  sudo mkfs.vfat drive.bin
+##
+# mkdir functions/mass_storage.usb0
+## Set up our backing store
+# echo "/home/pi/drive.bin" > functions/mass_storage.usb0/lun.0/file
+## Link our function to our configuration
+#ln -s functions/mass_storage.0 configs/c.1/
+
+## Serial (CDC ACM)
+mkdir functions/acm.usb0
+ln -s functions/acm.usb0 configs/c.1/
+
+## Ethernet (RNDIS and ECM)
+## Of note, this may cause the IP to show up as 127.0.0.1
+## and wireless to suddenly fail to connect
+mkdir functions/ecm.usb0
+ln -s functions/ecm.usb0 configs/c.1/
+
+## USB Device Controller update
+UDC=`ls /sys/class/udc`
+echo $UDC > UDC
+
+# Enable the gettys
+systemctl enable serial-getty@ttyGS0.service

Scripts/serial-ether-gadget.service

@@ -0,0 +1,7 @@
+[Unit]
+Description=Serial and Ethernet over OTG USB
+After=systemd-user-sessions.service
+[Service]
+ExecStart=/root/rover-pi/Scripts/gadget.sh
+[Install]
+WantedBy=multi-user.target

connect.md

@@ -0,0 +1,10 @@
+# Initial connection to the Raspberry Pi
+Now that you have an image with ssh and Raspberry Pi connect on your SD, you can connect to the pi
+
+
+## Connecting using Raspberry Pi Connect
+1. Login to https://connect.raspberrypi.com if you haven't already
+1. Look at the list of devices, find the one you want, and click on "Connect"
+![connect-devices.png](Graphics/connect-devices.png)
+1. A remote shell window will pop up
+![connect-shell.png](Graphics/connect-shell.png)

gadget.md

@@ -0,0 +1,119 @@
+# Gadget Mode to setup a serial connection over USB
+Prepare Raspberry Pi OS connection over a microUSB serial cable
+
+Based upon Adafruit guide: https://learn.adafruit.com/turning-your-raspberry-pi-zero-into-a-usb-gadget/serial-gadget:
+The author discovered the guide was out of date, consulted the [2025 Raspberry Pi whitepaper on OTG](https://pip-assets.raspberrypi.com/categories/685-app-notes-guides-whitepapers/documents/RP-009276-WP/Using-OTG-mode-on-Raspberry-Pi-SBCs), found additional errors, and was finally able to correct them thanks to this blog https://www.isticktoit.net/?p=1383
+
+## Important :
+- **Using the Gadget Mode will make the usb port unable to connect to a mouse or keyboard!!!** You will need to disable it make them work again.
+- You will want to disable the serial console on RX/TX in `raspi-config` if you are trying to use that serial port for communicating with other devices.
+
+
+## Procedure
+
+Make sure you have your USB cable plugged into the left port **USB** and not the right port marked **PWR**.
+1. Open a connection to the device via ssh or Raspberry Pi Connect
+1. Become root (the superuser)
+```
+sudo su
+```
+1. Enable the DWC version 2 USB peripheral device tree overlay by appending it to the end after the `[all]` category (which is at the end)
+```
+echo "dtoverlay=dwc2" >> /boot/firmware/config.txt
+```
+1. We add the required module `dwc2` for loading at startup
+```
+echo "dwc2" >> /etc/modules
+```
+1. Check that we can load the libcomposite module
+```
+modprobe libcomposite
+```
+1. Put a copy of this repository in root's home directory using git
+```
+apt install -y git
+git clone https://gitea.cs.ru.is/RU-V207/rover-pi.git
+```
+1. Go to Scripts and test if the `gadget.sh` runs without errors and hopefully a Serial port appers in Device Manager or equivalent
+ ```
+cd rover-pi/Scripts/
+./gadget.sh
+```
+1. Install the systemd
+```
+cp serial-ether-gadget.service /lib/systemd/system/.
+```
+1. Enable the service
+```
+systemctl enable serial-ether-gadget.service
+```
+1. Enable the getty (which connects a login terminal to the serial port)
+```
+systemctl enable serial-getty@ttyGS0.service
+```
+1. Reboot and see if the serial port appears
+
+# Connecting to the serial terminal
+You will need a serial terminal program (which used to be very very common) in order to communicate over your serial port
+
+## Windows
+- Putty:  https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html
+- MobaXterm: https://mobaxterm.mobatek.net/
+
+## Linux
+If using a Linux VM, you will need to pass the Pi USB connection there. 
+This is similar to the procedure for accessing an Arduino.
+1.  Start the Linux VM if you haven't already
+1. Menu: Devices > USB
+1. Look for "Silicon Labs CP210x USB to UART Bridge" and click on it.
+1. check if port /dev/ttyUSB0 is found. The Pi will most often be accessible over this port.
+    ```
+    ls -l /dev/ttyU*
+    ```
+1. The user must be in the dialout group to access it.  Use the Linux command: `uid` -to check if you are in the group. If not in the dialout group, use:
+    ```
+    sudo usermod -a -G dialout <username>
+	```
+1. You will use the GNU `screen` application in Linux to access the Pi.  You can install it with:
+    ```
+    sudo apt install screen
+	```
+1. You should now gain access to the Pi with:
+	```
+  ` sudo screen /dev/ttyUSB0 115200
+    ```
+1. Press enter and you will be prompted to log in to the Pi with default credentials. User: pi - PW: raspberry
+
+# Disabling the OTG mode to use a keyboard and mouse again
+
+**WARNING: Untested**
+1. Comment out the dwg2 line in `/boot/firmware/config.txt` using a `#` in front of the line
+   ```
+   [all]
+   #dtoverlay=dwg2
+   ```
+1. Comment out the dwg2 line in `/etc/modules` using a `#` in front of the line
+   ```
+   #dwg2
+   ```
+1. Disable the gadget service
+    ```
+	systemctl disable serial-ether-gadget.service
+	```
+1. Disable the getty
+    ```
+	systemctl disable serial-getty@ttyGS0.service
+	```
+
+# Connecting over the USB ethernet to ssh into your Pi
+
+I have not tested this procedure because the serial console and normal network connection is sufficient for me --foley
+
+https://www.raspberrypi.com/news/usb-gadget-mode-in-raspberry-pi-os-ssh-over-usb/
+
+
+# Untested
+ Here are items that bear investigating but haven't been tested yet
+ 
+ - [Modify Imager manifest to install otg](https://github.com/raspberrypi/rpi-imager/tree/main/doc/local_json)
+ 

imager.md

@@ -23,7 +23,7 @@ We don't have many monitors and keyboards in V207 for students to use, so we wil
 ![imager-ssh_nokey.png](Graphics/imager-ssh_nokey.png)
 1. Once you have uploaded your `id_edcsa.pub` file it should look like this. 
 ![imager-ssh_key.png](Graphics/imager-ssh_key.png)
-1. Since we don't have enough monitors, we will need another way to setup the initial connection.  The officially supported option is Raspberry Pi Connect.  You will need to:
+1. Since we don't have a monitor, keyboard, and mouse available, we will need another way to setup the initial connection.  The officially supported option is Raspberry Pi Connect.  You will need to enable it then:
     1. Register for an account first at https://connect.raspberrypi.com
 	2. Confirm your account with email
 	2. Login with that account
@@ -42,12 +42,5 @@ We don't have many monitors and keyboards in V207 for students to use, so we wil
 1. Now you get to watch the writing then verifying.
 ![imager-writeimage-progress.png](Graphics/imager-writeimage-progress.png)
 ![imager-writeimage-verifying.png](Graphics/imager-writeimage-verifying.png)
-1. The process is complete!
+1. The process is complete!  Now you can [connect to your pi](connect.md)
 ![imager-complete.png](Graphics/imager-complete.png)
-
-## Connecting using Raspberry Pi Connect
-1. Login to https://connect.raspberrypi.com if you haven't already
-1. Look at the list of devices, find the one you want, and click on "Connect"
-![connect-devices.png](Graphics/connect-devices.png)
-1. A remote shell window will pop up
-![connect-shell.png](Graphics/connect-shell.png)

raspi-config.md

@@ -0,0 +1,10 @@
+# raspi-config options to check
+
+```
+sudo raspi-config
+3 - Interface options
+  P2 enable SSH
+  P4 enable SPI
+  P5 enable I2C
+  P6 enable serial (You may have to update this later and turn it off for certain UART features to work)
+```

solder-gpio.md

@@ -0,0 +1,14 @@
+# Solder the Header pins on the Pi Zero W
+
+You will need header pins to access the GPIO on the Pi.  GPIO is needed in order to connect to the Pi via the MicroUSB cable.  [Details on what the GPIO pins do](https://www.raspberrypi.org/documentation/usage/gpio/)
+
+
+1. Read the helpful guide on soldering: [Soldering is Easy Guide](https://mightyohm.com/files/soldercomic/FullSolderComic_EN.pdf)
+1. No really, read the comic [Soldering is Easy Guide](https://mightyohm.com/files/soldercomic/FullSolderComic_EN.pdf). The teaching staff will make fun of you if you don't read it before you try doing it for real.
+1. Apparently reading is hard because some people still haven't looked at the comic.  Go to [Adafruit's guide on soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) which includes videos.
+1. Mount the raspberry Pi zero into a Panavise or other mechanism to hold it steady.  If none of those are available, you can use tape to stick it to a piece of cardboard, then stick that to the table.  Be aware the tape will melt or burn if it comes into contact with the soldering iron.
+1. Get the dual row pins: 2x20. The pins are available in the stock room of V207 if they weren't included in your kit.
+1. Drop them in from the top of the PCB and hold them in place. The short ends go into the PCB.  Wrap a piece of electrical tape from one edge of the PCB across the center of the tall pins, to the other edge.  This should temporarily secure them to the PCB.   Flip the board over.  The pins should just be sticking a little bit out the bottom of the board.
+1. Heat and apply solder to the pins on the end (away from the tape).  Check that the solder joints are cool and strong, then remove the tape.  Finish the rest of the soldering.
+1. Inspect the soldering joints under the microscope to make sure that there are not holes or anything else that might result in a flaky connection. If you see "spiky things" sticking out, that means you didn't heat the pin and solder enough.
+1. If any of the connections look questionable, remove the solder on that joint and do it again.   **Unreliable solder joints will cause your system to be flaky which will drive you crazy later in the semester!**