Skip to content

Commit

Permalink
readme update #27
Browse files Browse the repository at this point in the history
  • Loading branch information
ibrahimmansur4 committed Aug 31, 2023
1 parent ce7ea05 commit 5ceebec
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
8 changes: 4 additions & 4 deletions .vscode/c_cpp_properties.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
"includePath": [
"/home/ibrahim/mobile_robotics_basics/include",
"/home/ibrahim/mobile_robotics_basics/src",
"/home/ibrahim/mobile_robotics_basics/lib/Wifi_data_processing",
"/home/ibrahim/.platformio/packages/framework-arduinoespressif32/libraries/WiFi/src",
"/home/ibrahim/mobile_robotics_basics/lib/Dead Reckoning",
"/home/ibrahim/mobile_robotics_basics/lib/Encoder Control",
"/home/ibrahim/mobile_robotics_basics/lib/Motor Control",
"/home/ibrahim/mobile_robotics_basics/lib/Wifi_data_processing",
"/home/ibrahim/.platformio/packages/framework-arduinoespressif32/libraries/WiFi/src",
"/home/ibrahim/mobile_robotics_basics/.pio/libdeps/esp32doit-devkit-v1/AS5600",
"/home/ibrahim/mobile_robotics_basics/.pio/libdeps/esp32doit-devkit-v1/SoftWire/src",
"/home/ibrahim/mobile_robotics_basics/.pio/libdeps/esp32doit-devkit-v1/AsyncDelay/src",
Expand Down Expand Up @@ -250,11 +250,11 @@
"path": [
"/home/ibrahim/mobile_robotics_basics/include",
"/home/ibrahim/mobile_robotics_basics/src",
"/home/ibrahim/mobile_robotics_basics/lib/Wifi_data_processing",
"/home/ibrahim/.platformio/packages/framework-arduinoespressif32/libraries/WiFi/src",
"/home/ibrahim/mobile_robotics_basics/lib/Dead Reckoning",
"/home/ibrahim/mobile_robotics_basics/lib/Encoder Control",
"/home/ibrahim/mobile_robotics_basics/lib/Motor Control",
"/home/ibrahim/mobile_robotics_basics/lib/Wifi_data_processing",
"/home/ibrahim/.platformio/packages/framework-arduinoespressif32/libraries/WiFi/src",
"/home/ibrahim/mobile_robotics_basics/.pio/libdeps/esp32doit-devkit-v1/AS5600",
"/home/ibrahim/mobile_robotics_basics/.pio/libdeps/esp32doit-devkit-v1/SoftWire/src",
"/home/ibrahim/mobile_robotics_basics/.pio/libdeps/esp32doit-devkit-v1/AsyncDelay/src",
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,26 @@ This project implements a robot control system using ESP32. The system includes
## Code Explanation

- The code calculates the robot's position based on encoder readings and motion equations.
- Wifi control is provided to drive the robot using predefined commands (`'f'` for forward, `'b'` for reverse, etc.).
- Wifi control is provided to drive the robot using predefined commands ('f' for forward, 'b' for reverse, etc.).
- Wi-Fi communication is used to send the robot's position to a server.
- AS5600 encoder library is used to integrate the AS5600 encoder's built-in functions.

## App Control

- The robot can be controlled remotely using a mobile app.
- The app sends commands over Wi-Fi to control the robot's movements (forward, reverse, left, right, stop, etc.).
- The robot's position coordinates (x and y) can also be sent to the app from the ESP32.

## Processing of Coordinates

- The ESP32 receives coordinates (x and y) from the app, which are comma-separated and in string format.
- The `processCoordinates` function handles the received coordinates.
- The function processes the coordinates, which can be used for further calculations, motor control, or any other actions.

## File Structure

- `main.cpp`: Main Arduino code file.
- `MotorControl.h` , `EncoderControl.h`, `dead_Reckoning.h`: Header file containing variable and function declarations.
- `MotorControl.h`, `EncoderControl.h`, `dead_Reckoning.h`: Header file containing variable and function declarations.
- `AS5600.h`, `AS5600.cpp`: AS5600 encoder library files (if required).

## How to Use
Expand All @@ -50,4 +62,3 @@ This project is inspired by [source link](http://www-personal.umich.edu/~johannb
## License

This project is licensed under the [MIT License](LICENSE).

0 comments on commit 5ceebec

Please sign in to comment.