Skip to content

Commit 199daf5

Browse files
dbieberclaude
andcommitted
Update installation and hardware documentation
- 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 <noreply@anthropic.com>
1 parent f23f440 commit 199daf5

File tree

2 files changed

+103
-134
lines changed

2 files changed

+103
-134
lines changed

hardware.md

Lines changed: 43 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,83 @@
11
## Hardware Guide
22

3-
Here is some sample hardware you can use to build your own Go Note Go. Costs might exclude taxes and shipping.
3+
Here is the required hardware you need to build your own Go Note Go:
44

5-
### Raspberry Pi 400
5+
### Required Hardware
66

7-
Link: https://www.raspberrypi.com/products/raspberry-pi-400-unit/
7+
#### Raspberry Pi 400
88

9-
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:
10-
- The Raspberry Pi 400 unit ($70)
11-
- Class 10 microSD Card With Raspbian - 16GB
12-
- USB-C Power Supply, 5.1V 3.0A, Black, UL Listed
13-
- Micro-HDMI to HDMI cable for Pi 4, 3ft, Black
9+
Link: https://www.raspberrypi.com/products/raspberry-pi-400-unit/
1410

15-
Cost: $91
11+
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/).
1612

17-
### USB Mic and Speakers
13+
Cost: ~$70
1814

19-
Links:
20-
* Microphone: https://www.adafruit.com/product/3367 ($6)
21-
* Adafruit Speaker: https://www.adafruit.com/product/3369 ($13)
22-
* Etsy Speaker: https://www.etsy.com/listing/1056790095/usb-speaker-stick ($30)
15+
#### SD Card
2316

24-
Cost: $19 - $36
25-
26-
---
17+
A Class 10 microSD Card - 16GB or larger is recommended.
2718

28-
## Additional Hardware: Take Go Note Go on the Go
19+
Cost: ~$10-15
2920

30-
The following parts are optional, but will better allow you to take Go Note Go on the go.
21+
#### USB Microphone
3122

32-
### 10000 mAh battery
23+
Example: https://www.adafruit.com/product/3367
3324

34-
Link: https://www.amazon.com/gp/product/B07JYYRT7T
25+
Cost: ~$6
3526

36-
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.
27+
#### USB Speaker
3728

38-
Cost: $19 (currently $14)
29+
Options:
30+
* Adafruit Speaker: https://www.adafruit.com/product/3369 (~$13)
31+
* Etsy Speaker: https://www.etsy.com/listing/1056790095/usb-speaker-stick (~$30)
3932

40-
### Velcro
33+
Cost: $13-30
4134

42-
Link: https://www.amazon.com/gp/product/B08P3MXLLD
35+
#### Power Source
4336

44-
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.
37+
A USB-C Power Supply, 5.1V 3.0A for the Raspberry Pi 400.
4538

46-
Cost: $7
39+
Cost: ~$10
4740

48-
### USB Cables
41+
Total Cost for Required Hardware: ~$109-131
4942

50-
Links:
51-
* 3 ft USB - USB C cable: https://www.amazon.com/gp/product/B089DM4KDW
52-
* 6 in USB - USB C cable: https://www.amazon.com/gp/product/B012V56D2A
53-
54-
Cost: $13 ($6.99 for 3 ft and $5.99 for 6 in)
43+
---
5544

56-
### The Beautiful Red Button
45+
## Optional Hardware
5746

58-
Link: https://www.amazon.com/gp/product/B00T6RCGNC
47+
The following parts are optional but may enhance your experience:
5948

60-
Cost: $9
49+
### 10000 mAh Battery (for portable use)
6150

62-
---
51+
Link: https://www.amazon.com/gp/product/B07JYYRT7T
6352

64-
## Other tools
53+
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.
6554

66-
These tools aren't Go Note Go specific, but will help you in the setup process.
55+
Cost: ~$14-19
6756

68-
### External monitor and a USB Mouse.
57+
### Velcro
6958

70-
These will be useful for configuring and debugging Go Note Go, e.g. setting up WiFi and configuring your note-taking system.
59+
Link: https://www.amazon.com/gp/product/B08P3MXLLD
7160

72-
### Wire, Wire Stripper
61+
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.
7362

74-
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.
63+
Cost: ~$7
7564

76-
Possible wire link: https://www.lowes.com/pd/Southwire-25-Ft-18-2-Black-Stranded-Lamp-Cord/5001050863
65+
### USB Cables
7766

78-
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).
67+
Links:
68+
* USB to USB-C cable for connecting the Pi to power sources
69+
* Short cables may be useful for connecting peripherals while minimizing clutter
7970

80-
Notes: I don't know if this is the best choice for wire; a higher gauge might be better.
71+
---
8172

82-
### Solder? Soldering iron?
73+
## Other Tools for Setup
8374

84-
I haven't had to use solder yet, but might need to for hooking up the button.
75+
These tools aren't Go Note Go specific, but may help you in the setup process:
8576

86-
Hot glue or heat shrink and a heat gun might be nice-to-haves too to ensure solid stable connections.
77+
### External Monitor (temporary, for initial setup)
8778

88-
### Possible other parts for button
79+
This can be useful for initial debugging, but is not required with the new setup process.
8980

90-
These might be useful for connecting the button to the GPIO pins on the Pi:
91-
https://www.amazon.com/dp/B0774NMT1S
92-
I don't know. In my experience these were too loose to fit nicely on the GPIO pins.
81+
### USB Mouse (temporary, for initial setup)
9382

94-
I'm going to try these next: GenBasic 40 Piece Female to Female Jumper Wires (4 Inch) https://www.amazon.com/dp/B077N58HFK ($5)
83+
This can be helpful during initial configuration but is not required with the new setup process.

installation.md

Lines changed: 60 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,62 @@
11
## Installation Instructions
22

3-
These instructions assume you're starting from a clean install of Raspbian,
4-
and that your Raspberry Pi is connected to an external monitor.
5-
Once you are set up, an external monitor will no longer be necessary.
6-
7-
1. Clone GoNoteGo
8-
9-
```bash
10-
mkdir -p /home/pi/code/github/dbieber
11-
cd /home/pi/code/github/dbieber
12-
git clone https://github.com/dbieber/GoNoteGo.git
13-
```
14-
15-
2. Set up settings
16-
17-
```bash
18-
cd /home/pi/code/github/dbieber/GoNoteGo
19-
cp gonotego/settings/secure_settings_template.py gonotego/settings/secure_settings.py
20-
nano gonotego/settings/secure_settings.py # Configure your settings here.
21-
```
22-
23-
It's OK to leave settings that you're not using at their default values.
24-
25-
3. Put Google service key on device
26-
27-
* `mkdir /home/pi/secrets` # Run on Raspberry Pi.
28-
* `scp path/to/google_credentials.json pi@192.168.0.106:/home/pi/secrets/` # Run on primary.
29-
30-
Run `hostname -I` on the Raspberry Pi to determine the IP address to use in the scp command.
31-
32-
4. Install dependencies
33-
34-
```bash
35-
sudo apt update
36-
sudo apt upgrade
37-
sudo apt install firefox-esr xvfb portaudio19-dev libatlas-base-dev redis-server espeak rustc python3-dev
38-
39-
cd /home/pi/code/github/dbieber/GoNoteGo
40-
mkdir out
41-
pip3 install virtualenv
42-
/home/pi/.local/bin/virtualenv env -p python3
43-
./env/bin/pip install grpcio -U --no-binary=grpcio
44-
./env/bin/pip install -e .
45-
```
46-
47-
5. Start on boot
48-
49-
```bash
50-
sudo nano /etc/rc.local
51-
```
52-
Add this line to rc.local:
53-
`/home/pi/code/github/dbieber/GoNoteGo/env/bin/supervisord -c /home/pi/code/github/dbieber/GoNoteGo/gonotego/supervisord.conf`
54-
55-
6. Install geckodriver to /usr/local/bin
56-
57-
```bash
58-
cd
59-
wget https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-arm7hf.tar.gz
60-
tar -xvf geckodriver-v0.23.0-arm7hf.tar.gz
61-
rm geckodriver-v0.23.0-arm7hf.tar.gz
62-
sudo mv geckodriver /usr/local/bin
63-
```
64-
65-
7. Set up Internet
66-
67-
* Run `sudo nano /etc/wpa_supplicant/wpa_supplicant.conf`
68-
* Follow the guide at https://www.raspberrypi.org/documentation/computers/configuration.html to set up your wpa_supplicant.conf file.
69-
70-
Setting up internet through the operating system's UI may also work.
71-
72-
8. Set up your audio
73-
74-
* Make sure audio is coming out of the desired output device at an acceptable volume.
75-
76-
9. Verify everything's working!
77-
78-
* Type a text note and press enter; it should appear in your notes.
79-
* Press your hotkey and speak an audio note; it too should appear in your notes.
80-
* Type ":ok" and press enter; you should hear the machine say "ok".
81-
* If you're having any trouble getting set up, open a [new GitHub issue](https://github.com/dbieber/GoNoteGo/issues).
82-
* That's it; you're good to go! Happy note-taking!
3+
These instructions will guide you through setting up Go Note Go on a Raspberry Pi 400.
4+
5+
1. Download the latest image from GitHub Actions artifacts
6+
7+
2. Flash the image onto an SD card
8+
9+
Example commands (macOS):
10+
```bash
11+
diskutil unmountDisk /dev/disk4
12+
sudo dd bs=4M if=/Users/yourusername/Downloads/go-note-go.img of=/dev/rdisk4 conv=fsync status=progress
13+
```
14+
15+
3. Insert the SD card into the Raspberry Pi 400 and power it on
16+
17+
Give it a minute to boot.
18+
19+
4. Start the settings server
20+
21+
Type the following command and press Enter:
22+
```
23+
:server
24+
```
25+
26+
This will start a WiFi hotspot called GoNoteGo-Wifi.
27+
28+
5. Connect to the GoNoteGo-Wifi hotspot
29+
30+
Connect from another device like a phone or computer.
31+
The password is: `swingset`
32+
33+
6. Configure your Go Note Go
34+
35+
Navigate to: `192.168.4.1:8000`
36+
37+
Here you can configure:
38+
- WiFi networks to connect to
39+
- Where to upload your notes
40+
- Other settings
41+
42+
Click Save when finished.
43+
44+
7. Verify internet connection
45+
46+
Run the following command on the Go Note Go:
47+
```
48+
:i
49+
```
50+
51+
It should respond with 'Yes' indicating it's connected to the internet.
52+
53+
8. Turn off the WiFi hotspot (optional)
54+
55+
Run the following command:
56+
```
57+
:server stop
58+
```
59+
60+
9. That's it! Your Go Note Go is ready to use. Happy note-taking!
61+
62+
If you're having any trouble getting set up, open a [new GitHub issue](https://github.com/dbieber/GoNoteGo/issues).

0 commit comments

Comments
 (0)