Skip to content

Commit 20d9ba5

Browse files
sarayusapavovw
andauthored
Updated Readme (#181)
* updated readme * added new images * fixed lowercase * compressed images * remove switch control from README.md --------- Co-authored-by: atharva <62803658+vovw@users.noreply.github.com>
1 parent 77f7df3 commit 20d9ba5

6 files changed

Lines changed: 60 additions & 28 deletions

File tree

README.md

Lines changed: 60 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
12
<p align="center">
23
<img src="documentation/images/logo.png"/>
34

4-
<h3 align="center"> Wall-E version 2.6 </h3>
5+
<h3 align="center"> Wall-E version 2.7 </h3>
56
<p align="center">
6-
Code repository for <a href="https://github.com/SRA-VJTI/Wall-E">Wall-E_v2.6</a>
7+
Code repository for <a href="https://github.com/SRA-VJTI/Wall-E">Wall-E_v2.7</a>
78
<br />
89
<br />
910
<a href="https://github.com/SRA-VJTI/Wall-E/issues">Report Bug</a>
@@ -32,37 +33,49 @@
3233

3334
## Table of Contents
3435
- [About the Workshop](#about-the-workshop)
36+
- [Architecture](#architecture)
3537
- [Installation](#installation)
3638
- [Examples](#examples)
3739
- [Resources](#resources)
3840
- [Contribution](#contribution)
3941
- [License](#license)
4042

41-
- [Acknowledgements](#acknowledgements)
42-
4343
## About the Workshop
4444
<p align="center">
45-
<img src="documentation/images/wall_E_bot.JPG"/>
45+
<img width = 600 src="documentation/images/walle_v2.7.jpeg"/>
4646
<a href="https://github.com/SRA-VJTI/Wall-E-Sim">
47-
<h3 align="center"> Wall-E bot simulation </h3>
47+
<h3 align="center"> Wall-E </h3>
4848
</a>
4949
</p>
5050

5151
<p align="center">
5252

53-
|<img width="333" height="263" src="documentation/Assets/self_balance_demo.gif"> | <img width="463" height="263" src="documentation/Assets/walle_oled.jpg">|
54-
:-------------------------:|:-------------------------:
55-
Wall-E Bot Self-Balancing | Wall-E Bot with OLED Display
53+
| <img height="350" src="documentation/images/self_balancing.gif"> | <img height="350" src="documentation/images/oled.jpg"> | <img height="350" src="documentation/images/led_matrix.gif"> |
54+
:-------------------------:|:-------------------------:|:-------------------------:
55+
Wall-E Bot Self-Balancing | Wall-E Bot with OLED Display | Wall-E Bot with LED Matrix
56+
57+
Wall-E is a two-wheeled educational **self balancing** and **line following** robot developed by **SRA-VJTI**, designed to teach embedded robotics concepts such as **control theory (PID)**, and **embedded communication**. The brain of the robot is an **ESP32** microcontroller paired with a custom-made SRA development board.
58+
59+
This repository hosts the firmware, demo projects, and study material used in SRA VJTI's Wall-E workshop. With features like inbuilt Wi-Fi support and BLE, and extensive application in several domains like IoT, RF, etc, The workshop entails various essential concepts such as PID Control, Embedded Communication Protocols, PWM, Filters, RTOS, etc. and gives its attendees (first-year students) a general idea about the world of robotics and embedded hardware.
60+
61+
## Architecture
5662

57-
</p>
63+
### Hardware
64+
- **ESP32 Microcontroller**: central processing, sensor reading, control loops
65+
- **SRA Development Board**: custom PCB that connects ESP32 to sensors, motor drivers, power supply, etc.
66+
- **Sensors**
67+
- MPU6050 IMU (gyro + accelerometer) for self balancing
68+
- Light Sensor Array (LSA) for line following
69+
- **Actuators**: Dual DC motors (controlled via PWM)
70+
- **Communication**: I2C, SPI, UART for peripheral communication
71+
- **User Interface**
72+
- (Optional) OLED display for local feedback
73+
### Software
74+
- Built using **ESP-IDF**, leveraging tasks in FreeRTOS.
75+
- WebSocket interface for real-time tuning : dynamic tuning via WebSocket without reflashing firmware.
76+
- runs Conway's Game of Life on the SRA Board LED matrix using ESP-IDF
5877

59-
How do you make a robot follow a line? Now what if the robot has only two wheels. How will it balance and follow the line? This is exactly what is taught in the Wall-E workshop.
60-
The Wall-E workshop focuses on the concepts of line-following and self-balancing, using ESP32, a powerful micro-controller with features like inbuilt Wi-Fi support and BLE, with extensive application in several domains like IoT, RF, etc. The workshop entails various essential concepts such as PID Control, Embedded Communication Protocols, PWM, Filters, RTOS, etc. and gives its attendees (first-year students) a general idea about the world of robotics and embedded hardware. Following are some of the highlights:
61-
- The custom-made SRA Development Board & ESP32.
62-
- ESP-IDF, the official IoT Development framework by espressif.
63-
- Motor Control with PWM and PID.
64-
- Accelerometer , gyroscope and complimentary filter.
65-
- Communcation protocols ( UART , SPI , I2C )
78+
---
6679

6780

6881
## Installation
@@ -74,23 +87,40 @@ The Wall-E workshop focuses on the concepts of line-following and self-balancing
7487

7588
| TOPIC | Link | Description |
7689
| :-------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------: |
77-
| LED Matrix | [LED_Matrix](https://github.com/SRA-VJTI/Wall-E/blob/master/1_led_matrix/README.md) | Conway's Game of Life on the SRA Board LED matrix using ESP32 |
78-
| Light Sensing Array | [LSA](https://github.com/SRA-VJTI/Wall-E/blob/master/2_LSA/README.md) | Sensing Array that uses different Light Sensors, majorly used for Line-Following |
79-
| MPU6050 | [MPU](https://github.com/SRA-VJTI/Wall-E/blob/master/3_MPU/README.md) | Motion controlled MPU measures angles with respect to 6 Degrees of Freedom |
80-
| Pulse Width Modulation | [PWM](https://github.com/SRA-VJTI/Wall-E/blob/master/4_PWM/README.md) | Calculate average voltage and controls speed accordingly |
81-
| Line-Following | [Line_Following](https://github.com/SRA-VJTI/Wall-E/tree/master/5_line_following/) | Line-Following algorithm that enables the bot to follow the path of white line |
82-
| Self-Balancing | [Self_Balancing](https://github.com/SRA-VJTI/Wall-E/blob/master/6_self_balancing/README.md) | Self-Balancing algorithm that enables the bot to balance its weight under the force of gravity |
83-
84-
85-
86-
<!-- ROADMAP -->
90+
| LED Matrix | [LED_Matrix](https://github.com/SRA-VJTI/Wall-E/blob/master/1_led_matrix/README.md) | Performing LED Blink by connecting the LED with esp32 |
91+
| Light Sensing Array | [LSA](https://github.com/SRA-VJTI/Wall-E/blob/master/2_LSA/README.md) | Sensing Array that uses different Light Sensors, majorly used for Line-Following |
92+
| MPU6050 | [MPU](https://github.com/SRA-VJTI/Wall-E/blob/master/3_MPU/README.md) | Motion controlled MPU measures angles with respect to 6 Degrees of Freedom |
93+
| Pulse Width Modulation | [PWM](https://github.com/SRA-VJTI/Wall-E/blob/master/5_PWM/README.md) | Calculate average voltage and controls speed accordingly |
94+
| Line-Following | [Line_Following](https://github.com/SRA-VJTI/Wall-E/tree/master/6_line_following/) | Line-Following algorithm that enables the bot to follow the path of white line |
95+
| Self-Balancing | [Self_Balancing](https://github.com/SRA-VJTI/Wall-E/blob/master/7_self_balancing/README.md) | Self-Balancing algorithm that enables the bot to balance its weight under the force of gravity |
96+
97+
## Running the Example Projects
98+
99+
100+
### 1. Choose an Example
101+
Navigate to one of the examples in the examples directory under Wall-E.
102+
```bash
103+
cd components/sra-board-component/examples/<example_name>
104+
```
105+
### 2. Configure
106+
Opens the ESP-IDF configuration menu where you can set project options, enable features, and adjust hardware settings.
107+
```bash
108+
idf.py menuconfig
109+
```
110+
### 3. Build and Flash
111+
Builds the project, flashes it to the ESP32, and starts the serial monitor to view real-time logs.
112+
```bash
113+
idf.py build
114+
idf.py flash
115+
idf.py monitor
116+
```
87117

88118
## Resources
89119

90120
- Please visit and look at our [Custom-made SRA development board](https://github.com/SRA-VJTI/sra-board-hardware-design)
91121
- Visit ESP-IDF SRA board [Components](https://github.com/SRA-VJTI/sra-board-hardware-design) to have a detailed information about the components of SRA board
92122
<p align="center">
93-
<img src="documentation/images/sra_board.png"/>
123+
<img src="documentation/images/board_v2.7.jpeg"/>
94124
<h3 align="center"> SRA development board </h3>
95125
</p>
96126

@@ -126,3 +156,5 @@ Contributions are what make the open source community such an amazing place to b
126156
[license-url]: https://github.com/SRA-VJTI/Wall-E/blob/master/LICENSE
127157

128158

159+
160+
192 KB
Loading
43.7 MB
Loading

documentation/images/oled.jpg

126 KB
Loading
5.21 MB
Loading
855 KB
Loading

0 commit comments

Comments
 (0)