diff --git a/README.md b/README.md index 1242729..3d23735 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ For developers, see [Project Overview](#project-overview). For users setting up - [Project Overview](#project-overview) - [Directory Structure](#directory-structure) - [Dependencies](#dependencies) + - [Hardware Set-up](#hardware-set-up) - [Deployment](#deployment) - [Single command all-in-one](#single-command-all-in-one) - [Pi Environment Set-up](#pi-environment-set-up) @@ -57,6 +58,23 @@ The main project dependencies are specified in [pyproject.toml](./pyproject.toml - [piicodev](https://pypi.org/project/piicodev/) provides modules for interfacing with Raspberry Pi peripherals. - [face-recognition](https://pypi.org/project/face-recognition/) provides the face recognition model. +## Hardware Set-up +

+ +

+The following materials are required to construct this project. + +- 1x Raspberry Pi 3B +- 1x PiicoDev Adapter for Raspberry Pi +- 2x PiicoDev Connector 100mm, 1x PiicoDev Connector 200mm, 1x PiicoDev Connector 50mm +- 1x Raspberry Pi Camera Module +- 1x Vibrating Motor Disk +- 2x USB-C Power Supplis +- 1x PiicoDev Servo Driver, 1x PiicoDev OLED Display, 2x PiicoDev Button +- 1x FS90R Servo. + +The above wiring diagram shows how to connect these components. The components must be connected before turning on the Pi for the first time. + ## Deployment ### Single command all-in-one To set up the Pi's environment, deploy the code base, and start the program follow the following steps. diff --git a/assets/wiring.png b/assets/wiring.png new file mode 100644 index 0000000..f77549b Binary files /dev/null and b/assets/wiring.png differ diff --git a/run.sh b/run.sh index a94d2ef..e5a5836 100755 --- a/run.sh +++ b/run.sh @@ -21,4 +21,4 @@ if ! ./deploy.sh ../deploypaths.txt $SSHTARGET $SSHUSER; then fi echo -e $INFO -ssh $SSHUSER@$SSHTARGET 'bash -s' < run-garden.sh +ssh $SSHUSER@$SSHTARGET 'bash -s' < run_garden.sh diff --git a/scripts/run-garden.sh b/scripts/run_garden.sh similarity index 100% rename from scripts/run-garden.sh rename to scripts/run_garden.sh