diff --git a/README.md b/README.md index 74be12f..c130401 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,60 @@ The table below shows the difference between this project and the original one. https://user-images.githubusercontent.com/471808/148647807-02e3e901-6181-4473-8ac4-3b5998fa8d17.mp4 +## Software + +### Raspberry Pi + +#### Requirements + +Raspberry Pi is running [`Raspberry Pi OS`](https://www.raspberrypi.com/software/). + +- Enable `I2C` through `raspi-config` + +``` bash +sudo raspi-config +``` + +- Install required packages + +``` bash +sudo apt-get install python3-numpy python3-pip +``` + +- Install required Python modules + +``` bash +pip3 install adafruit-circuitpython-servokit +``` + +> Tips: It is convenient to debug code on Raspberry Pi through VSCode's remote feature. + +#### Running + +The hexapod program, located under `./software/raspberry pi/`, is written in Python. Use the following command to start it manually. + +``` bash +python3 hexapod.py +``` + +### Android + +screenshot_wifi screenshot_bluetooth + +screenshot_control1 + +screenshot_control2 + +### PC + +PC program source files are located under `./software/pc/`. The compiled program can be downloaded under the [release](https://github.com/rookiepeng/hexapod/releases) page. + +pc_interface + +- Find the correct IP address of the Raspberry Pi on the hexapod +- Connect to the hexapod using the IP address +- Use the buttons on the panel to control the hexapod + ## Mechanism ### Bill of Materials (BOM) @@ -124,56 +178,3 @@ https://user-images.githubusercontent.com/471808/148647807-02e3e901-6181-4473-8a diagram -## Software - -### Raspberry Pi - -#### Requirements - -Raspberry Pi is running [`Raspberry Pi OS`](https://www.raspberrypi.com/software/). - -- Enable `I2C` through `raspi-config` - -``` bash -sudo raspi-config -``` - -- Install required packages - -``` bash -sudo apt-get install python3-numpy python3-pip -``` - -- Install required Python modules - -``` bash -pip3 install adafruit-circuitpython-servokit -``` - -> Tips: It is convenient to debug code on Raspberry Pi through VSCode's remote feature. - -#### Running - -The hexapod program, located under `./software/raspberry pi/`, is written in Python. Use the following command to start it manually. - -``` bash -python3 hexapod.py -``` - -### PC - -PC program source files are located under `./software/pc/`. The compiled program can be downloaded under the [release](https://github.com/rookiepeng/hexapod/releases) page. - -pc_interface - -- Find the correct IP address of the Raspberry Pi on the hexapod -- Connect to the hexapod using the IP address -- Use the buttons on the panel to control the hexapod - -### Android - -screenshot_wifi screenshot_bluetooth - -screenshot_control1 - -screenshot_control2