Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/installtion instructions.md #160

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 24 additions & 33 deletions Installations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
* [For MacOS](#for-macos)

# For Windows
The first step is to install the ESP-IDF v4.2.
The first step is to install the ESP-IDF v5.2.

## Step 1:Download the installer from [here](https://dl.espressif.com/dl/esp-idf/?idf=4.4)
## Step 1:Download the installer from [here](https://dl.espressif.com/dl/esp-idf/?idf=5.2)
Please download the **offline** version pointed by the
arrow
<p align="center">
Expand Down Expand Up @@ -49,23 +49,26 @@ We recommend to keep the default installation path and click next.
<img src="./documentation/Assets/Installation/6.png">
</p>

### Step 6: Once you click On Finish, this is what you should be getting.
### Step 6: Once you click On Finish, this is what you should be getting.

<p align="center">
<img src="./documentation/Assets/Installation/7.png">
<img src="./documentation/Assets/Installation/7.png">
</p>

### Step 7: Open ESP-IDF 4.2 CMD which should be on your desktop
### Step 7: Open ESP-IDF 5.2 PowerShell which should be on your desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JaytidaA you haven't updated your fork before pushing these changes. This has caused the same changes to appear which have been done previously which might result in merge conflicts


<p align="center">
<img src="./documentation/Assets/Installation/esp-idf.jpeg">
</p>

### Step 8: Cloning the Wall-E Git Repo
To clone the Repo just execute the following command on ESP-IDF Command Prompt. We are making the project folder in Desktop
```sh
cd %userprofile%\Desktop
git clone https://github.com/SRA-VJTI/Wall-E.git --recurse-submodules
To clone the Repo just execute the following command on ESP-IDF Command Prompt. We are making the project folder in our home directory.

```powershell
cd ~
mkdir Projects
cd Projects
git clone https://github.com/SRA-VJTI/Wall-E --recursive --depth 1
cd Wall-E
```

Expand All @@ -74,7 +77,7 @@ cd Wall-E
</p>

**Pro Tip**:
`cd %userprofile%\Desktop\Wall-E` takes you to the Wall-E directory which contains all the required code
`cd ~/Projects/Wall-E` takes you to the Wall-E directory which contains all the required code

## For Linux

Expand Down Expand Up @@ -102,19 +105,17 @@ sudo chmod +x wall_e_install.sh


## For MacOS
### STEP 1 : Installing the necessary file
- Download the file "wall_e_install.sh" given in the root folder itself and put it in the "Downloads" folder
- Download the driver by clicking on this [link](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip) , unzip it, then install it on the system

### STEP 2 : Opening The Terminal
### STEP 1 : Opening The Terminal
Open the terminal by pressing command+space and then typing terminal.

**Note:** If you're an M1 mac os user refer this [link](https://youtu.be/9W8rTTE1WEA) to open the terminal.

### STEP 3 : Installing the Pre-Requisites
Copy this command in the command in the terminal , then press return
### STEP 2 : Installing the necessary file
- Download the driver by executing the following command in the terminal.
```sh
source ~/Downloads/wall_e_install.sh
curl https://raw.githubusercontent.com/SRA-VJTI/Wall-E/refs/heads/master/wall_e_install.sh -o wall_e_install.sh
sudo chmod +x wall_e_install.sh
./wall_e_install.sh
```
Note:- when you are asked to type the password in the terminal, password will not be visible to you. Just type the password and then press return.

Expand All @@ -130,7 +131,7 @@ Cloning the Wall-E Git repo
To clone the repo,execute the following commands on terminal.
```sh
cd $HOME
git clone https://github.com/SRA-VJTI/Wall-E.git --recurse-submodules
git clone https://github.com/SRA-VJTI/Wall-E.git --recurse_submodules
cd Wall-E
```
<p align="center">
Expand Down Expand Up @@ -164,18 +165,10 @@ ls
</p>

* For Windows -
```sh
cd %userprofile%\Desktop\Wall-E
```powershell
cd ~/Projects/Wall-E
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
```
<p align="center">
<img src="./documentation/Assets/Installation/10.jpeg">
</p>

<p align="center">
<img src="./documentation/Assets/Installation/12.jpeg">
</p>


### Step 2 : Connect Your Device
Connect your ESP32 board to the computer and check under what serial port the board is visible.
Expand Down Expand Up @@ -214,8 +207,8 @@ idf.py set-target esp32 #Command for Setting the Target
idf.py menuconfig # Command for Opening the Configuration Menu
```
* For Windows -
```sh
cd %userprofile%\Desktop\Wall-E\hello_world #Navigating to the file
```powershell
cd ~/Projects/Wall-E/1_led_blink #Navigating to the file
idf.py set-target esp32 #Command for Setting the Target
idf.py menuconfig #Command for Opening the Configuration
```
Expand Down Expand Up @@ -256,5 +249,3 @@ and for **windows** COM1 can be replaced by other number depending on the port t
```sh
idf.py flash monitor
```


Binary file modified documentation/Assets/Installation/0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/Assets/Installation/esp-idf.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.