From 199daf583568a5bd357a99732b79c5c85ce0a11b Mon Sep 17 00:00:00 2001 From: David Bieber Date: Mon, 14 Apr 2025 21:37:35 +0000 Subject: [PATCH 1/4] Update installation and hardware documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Simplified installation instructions for image-based setup - Updated hardware requirements to only include Pi 400, SD card, mic, speaker, and power - Removed the big red button and other non-essential hardware - Added new WiFi hotspot setup instructions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- hardware.md | 97 +++++++++++++++------------------ installation.md | 140 +++++++++++++++++++++--------------------------- 2 files changed, 103 insertions(+), 134 deletions(-) diff --git a/hardware.md b/hardware.md index 68a23e5c..25ad96b4 100644 --- a/hardware.md +++ b/hardware.md @@ -1,94 +1,83 @@ ## Hardware Guide -Here is some sample hardware you can use to build your own Go Note Go. Costs might exclude taxes and shipping. +Here is the required hardware you need to build your own Go Note Go: -### Raspberry Pi 400 +### Required Hardware -Link: https://www.raspberrypi.com/products/raspberry-pi-400-unit/ +#### Raspberry Pi 400 -Details: I use the US keyboard. You can purchase from e.g. [PiShop](https://www.pishop.us/product/raspberry-pi-400-complete-kit/). I recommend ordering the following as a bundle: - - The Raspberry Pi 400 unit ($70) - - Class 10 microSD Card With Raspbian - 16GB - - USB-C Power Supply, 5.1V 3.0A, Black, UL Listed - - Micro-HDMI to HDMI cable for Pi 4, 3ft, Black +Link: https://www.raspberrypi.com/products/raspberry-pi-400-unit/ -Cost: $91 +Details: The Raspberry Pi 400 with US keyboard is recommended. You can purchase from e.g. [PiShop](https://www.pishop.us/product/raspberry-pi-400-complete-kit/). -### USB Mic and Speakers +Cost: ~$70 -Links: -* Microphone: https://www.adafruit.com/product/3367 ($6) -* Adafruit Speaker: https://www.adafruit.com/product/3369 ($13) -* Etsy Speaker: https://www.etsy.com/listing/1056790095/usb-speaker-stick ($30) +#### SD Card -Cost: $19 - $36 - ---- +A Class 10 microSD Card - 16GB or larger is recommended. -## Additional Hardware: Take Go Note Go on the Go +Cost: ~$10-15 -The following parts are optional, but will better allow you to take Go Note Go on the go. +#### USB Microphone -### 10000 mAh battery +Example: https://www.adafruit.com/product/3367 -Link: https://www.amazon.com/gp/product/B07JYYRT7T +Cost: ~$6 -Notes: There are lots of options for the battery. This one works just fine. Could choose one with more storage for longer battery life if desired, but might get clunky. You also don't strictly _need_ a battery. You can also power Go Note Go directly from your car, laptop, or a standard outlet via USB. So if your use case allows Go Note Go to remain plugged in during use, you can forego the battery. +#### USB Speaker -Cost: $19 (currently $14) +Options: +* Adafruit Speaker: https://www.adafruit.com/product/3369 (~$13) +* Etsy Speaker: https://www.etsy.com/listing/1056790095/usb-speaker-stick (~$30) -### Velcro +Cost: $13-30 -Link: https://www.amazon.com/gp/product/B08P3MXLLD +#### Power Source -Notes: I use this Velcro to mount the keyboard to the passenger side of the car, and to mount the battery to the back of the keyboard. When applying the sticky side to a car dashboard, allow to dry overnight. +A USB-C Power Supply, 5.1V 3.0A for the Raspberry Pi 400. -Cost: $7 +Cost: ~$10 -### USB Cables +Total Cost for Required Hardware: ~$109-131 -Links: -* 3 ft USB - USB C cable: https://www.amazon.com/gp/product/B089DM4KDW -* 6 in USB - USB C cable: https://www.amazon.com/gp/product/B012V56D2A - -Cost: $13 ($6.99 for 3 ft and $5.99 for 6 in) +--- -### The Beautiful Red Button +## Optional Hardware -Link: https://www.amazon.com/gp/product/B00T6RCGNC +The following parts are optional but may enhance your experience: -Cost: $9 +### 10000 mAh Battery (for portable use) ---- +Link: https://www.amazon.com/gp/product/B07JYYRT7T -## Other tools +Notes: This allows you to use Go Note Go away from a power outlet. You can also power Go Note Go directly from your car, laptop, or a standard outlet via USB if your use case allows Go Note Go to remain plugged in during use. -These tools aren't Go Note Go specific, but will help you in the setup process. +Cost: ~$14-19 -### External monitor and a USB Mouse. +### Velcro -These will be useful for configuring and debugging Go Note Go, e.g. setting up WiFi and configuring your note-taking system. +Link: https://www.amazon.com/gp/product/B08P3MXLLD -### Wire, Wire Stripper +Notes: Useful for mounting the keyboard to different surfaces (e.g., car dashboard) or attaching the battery to the back of the keyboard. When applying the sticky side to a car dashboard, allow to dry overnight. -If you use The Beautiful Red Button you'll need wire and wire strippers. For wire I used 18 gauge lamp wire I got from Home Depot. +Cost: ~$7 -Possible wire link: https://www.lowes.com/pd/Southwire-25-Ft-18-2-Black-Stranded-Lamp-Cord/5001050863 +### USB Cables -Wire stripper link: https://www.amazon.com/Mr-Stripper-Stripping-Crimping-Electrical/dp/B086V5M1B4 (I chose this link arbitrarily; I got mine at Home Depot). +Links: +* USB to USB-C cable for connecting the Pi to power sources +* Short cables may be useful for connecting peripherals while minimizing clutter -Notes: I don't know if this is the best choice for wire; a higher gauge might be better. +--- -### Solder? Soldering iron? +## Other Tools for Setup -I haven't had to use solder yet, but might need to for hooking up the button. +These tools aren't Go Note Go specific, but may help you in the setup process: -Hot glue or heat shrink and a heat gun might be nice-to-haves too to ensure solid stable connections. +### External Monitor (temporary, for initial setup) -### Possible other parts for button +This can be useful for initial debugging, but is not required with the new setup process. -These might be useful for connecting the button to the GPIO pins on the Pi: -https://www.amazon.com/dp/B0774NMT1S -I don't know. In my experience these were too loose to fit nicely on the GPIO pins. +### USB Mouse (temporary, for initial setup) -I'm going to try these next: GenBasic 40 Piece Female to Female Jumper Wires (4 Inch) https://www.amazon.com/dp/B077N58HFK ($5) +This can be helpful during initial configuration but is not required with the new setup process. \ No newline at end of file diff --git a/installation.md b/installation.md index e9fb62bc..c7326447 100644 --- a/installation.md +++ b/installation.md @@ -1,82 +1,62 @@ ## Installation Instructions -These instructions assume you're starting from a clean install of Raspbian, -and that your Raspberry Pi is connected to an external monitor. -Once you are set up, an external monitor will no longer be necessary. - -1. Clone GoNoteGo - - ```bash -mkdir -p /home/pi/code/github/dbieber -cd /home/pi/code/github/dbieber -git clone https://github.com/dbieber/GoNoteGo.git -``` - -2. Set up settings - - ```bash -cd /home/pi/code/github/dbieber/GoNoteGo -cp gonotego/settings/secure_settings_template.py gonotego/settings/secure_settings.py -nano gonotego/settings/secure_settings.py # Configure your settings here. -``` - -It's OK to leave settings that you're not using at their default values. - -3. Put Google service key on device - -* `mkdir /home/pi/secrets` # Run on Raspberry Pi. -* `scp path/to/google_credentials.json pi@192.168.0.106:/home/pi/secrets/` # Run on primary. - -Run `hostname -I` on the Raspberry Pi to determine the IP address to use in the scp command. - -4. Install dependencies - - ```bash -sudo apt update -sudo apt upgrade -sudo apt install firefox-esr xvfb portaudio19-dev libatlas-base-dev redis-server espeak rustc python3-dev - -cd /home/pi/code/github/dbieber/GoNoteGo -mkdir out -pip3 install virtualenv -/home/pi/.local/bin/virtualenv env -p python3 -./env/bin/pip install grpcio -U --no-binary=grpcio -./env/bin/pip install -e . -``` - -5. Start on boot - - ```bash -sudo nano /etc/rc.local -``` - Add this line to rc.local: - `/home/pi/code/github/dbieber/GoNoteGo/env/bin/supervisord -c /home/pi/code/github/dbieber/GoNoteGo/gonotego/supervisord.conf` - -6. Install geckodriver to /usr/local/bin - - ```bash -cd -wget https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-arm7hf.tar.gz -tar -xvf geckodriver-v0.23.0-arm7hf.tar.gz -rm geckodriver-v0.23.0-arm7hf.tar.gz -sudo mv geckodriver /usr/local/bin -``` - -7. Set up Internet - -* Run `sudo nano /etc/wpa_supplicant/wpa_supplicant.conf` -* Follow the guide at https://www.raspberrypi.org/documentation/computers/configuration.html to set up your wpa_supplicant.conf file. - -Setting up internet through the operating system's UI may also work. - -8. Set up your audio - -* Make sure audio is coming out of the desired output device at an acceptable volume. - -9. Verify everything's working! - -* Type a text note and press enter; it should appear in your notes. -* Press your hotkey and speak an audio note; it too should appear in your notes. -* Type ":ok" and press enter; you should hear the machine say "ok". -* If you're having any trouble getting set up, open a [new GitHub issue](https://github.com/dbieber/GoNoteGo/issues). -* That's it; you're good to go! Happy note-taking! +These instructions will guide you through setting up Go Note Go on a Raspberry Pi 400. + +1. Download the latest image from GitHub Actions artifacts + +2. Flash the image onto an SD card + + Example commands (macOS): + ```bash + diskutil unmountDisk /dev/disk4 + sudo dd bs=4M if=/Users/yourusername/Downloads/go-note-go.img of=/dev/rdisk4 conv=fsync status=progress + ``` + +3. Insert the SD card into the Raspberry Pi 400 and power it on + + Give it a minute to boot. + +4. Start the settings server + + Type the following command and press Enter: + ``` + :server + ``` + + This will start a WiFi hotspot called GoNoteGo-Wifi. + +5. Connect to the GoNoteGo-Wifi hotspot + + Connect from another device like a phone or computer. + The password is: `swingset` + +6. Configure your Go Note Go + + Navigate to: `192.168.4.1:8000` + + Here you can configure: + - WiFi networks to connect to + - Where to upload your notes + - Other settings + + Click Save when finished. + +7. Verify internet connection + + Run the following command on the Go Note Go: + ``` + :i + ``` + + It should respond with 'Yes' indicating it's connected to the internet. + +8. Turn off the WiFi hotspot (optional) + + Run the following command: + ``` + :server stop + ``` + +9. That's it! Your Go Note Go is ready to use. Happy note-taking! + +If you're having any trouble getting set up, open a [new GitHub issue](https://github.com/dbieber/GoNoteGo/issues). \ No newline at end of file From 18ca476393345038fd1a870fa5355b206ac74013 Mon Sep 17 00:00:00 2001 From: David Bieber Date: Mon, 14 Apr 2025 22:17:36 +0000 Subject: [PATCH 2/4] Add back recommendation for Pi 400 complete kit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Restored details about the recommended Pi 400 complete kit - Noted which components are included in the complete kit - Kept component breakdown for those who already have some parts 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- hardware.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/hardware.md b/hardware.md index 25ad96b4..3aed3b28 100644 --- a/hardware.md +++ b/hardware.md @@ -10,11 +10,17 @@ Link: https://www.raspberrypi.com/products/raspberry-pi-400-unit/ Details: The Raspberry Pi 400 with US keyboard is recommended. You can purchase from e.g. [PiShop](https://www.pishop.us/product/raspberry-pi-400-complete-kit/). -Cost: ~$70 +It's recommended to order the complete kit which includes: +- The Raspberry Pi 400 unit ($70) +- Class 10 microSD Card With Raspbian - 16GB +- USB-C Power Supply, 5.1V 3.0A, Black, UL Listed +- Micro-HDMI to HDMI cable for Pi 4, 3ft, Black + +Cost: ~$70 (unit only) or ~$91 (complete kit) #### SD Card -A Class 10 microSD Card - 16GB or larger is recommended. +A Class 10 microSD Card - 16GB or larger is recommended. (This is included if you purchase the complete Raspberry Pi 400 kit). Cost: ~$10-15 @@ -34,7 +40,7 @@ Cost: $13-30 #### Power Source -A USB-C Power Supply, 5.1V 3.0A for the Raspberry Pi 400. +A USB-C Power Supply, 5.1V 3.0A for the Raspberry Pi 400. (This is included if you purchase the complete Raspberry Pi 400 kit). Cost: ~$10 From a1ff9041cdf1ff208b1dada4ef3cd911d4d83b4a Mon Sep 17 00:00:00 2001 From: David Bieber Date: Mon, 14 Apr 2025 22:19:28 +0000 Subject: [PATCH 3/4] Fix sentence formatting in installation.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Added periods at the end of all sentences for consistency - Improved readability of step instructions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- installation.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/installation.md b/installation.md index c7326447..39f8cda1 100644 --- a/installation.md +++ b/installation.md @@ -2,9 +2,9 @@ These instructions will guide you through setting up Go Note Go on a Raspberry Pi 400. -1. Download the latest image from GitHub Actions artifacts +1. Download the latest image from GitHub Actions artifacts. -2. Flash the image onto an SD card +2. Flash the image onto an SD card. Example commands (macOS): ```bash @@ -12,11 +12,11 @@ These instructions will guide you through setting up Go Note Go on a Raspberry P sudo dd bs=4M if=/Users/yourusername/Downloads/go-note-go.img of=/dev/rdisk4 conv=fsync status=progress ``` -3. Insert the SD card into the Raspberry Pi 400 and power it on +3. Insert the SD card into the Raspberry Pi 400 and power it on. Give it a minute to boot. -4. Start the settings server +4. Start the settings server. Type the following command and press Enter: ``` @@ -25,14 +25,14 @@ These instructions will guide you through setting up Go Note Go on a Raspberry P This will start a WiFi hotspot called GoNoteGo-Wifi. -5. Connect to the GoNoteGo-Wifi hotspot +5. Connect to the GoNoteGo-Wifi hotspot. Connect from another device like a phone or computer. - The password is: `swingset` + The password is: `swingset`. -6. Configure your Go Note Go +6. Configure your Go Note Go. - Navigate to: `192.168.4.1:8000` + Navigate to: `192.168.4.1:8000`. Here you can configure: - WiFi networks to connect to @@ -41,7 +41,7 @@ These instructions will guide you through setting up Go Note Go on a Raspberry P Click Save when finished. -7. Verify internet connection +7. Verify internet connection. Run the following command on the Go Note Go: ``` @@ -50,7 +50,7 @@ These instructions will guide you through setting up Go Note Go on a Raspberry P It should respond with 'Yes' indicating it's connected to the internet. -8. Turn off the WiFi hotspot (optional) +8. Turn off the WiFi hotspot (optional). Run the following command: ``` From 6f707635b30ad17fa0ceae578dbe834a5950796b Mon Sep 17 00:00:00 2001 From: David Bieber Date: Mon, 14 Apr 2025 22:20:10 +0000 Subject: [PATCH 4/4] Clarify audio response in installation instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Specified that the internet check responds "out loud" for clarity 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/installation.md b/installation.md index 39f8cda1..cc012c59 100644 --- a/installation.md +++ b/installation.md @@ -48,7 +48,7 @@ These instructions will guide you through setting up Go Note Go on a Raspberry P :i ``` - It should respond with 'Yes' indicating it's connected to the internet. + It should respond out loud with 'Yes' indicating it's connected to the internet. 8. Turn off the WiFi hotspot (optional).