From b82c52d5ab29d6252eab8fc9aef39835a8e0cd09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20=C3=81ngel=20S=C3=A1nchez?= Date: Sun, 23 Aug 2020 11:07:21 +0100 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1bed57e..7da23f8 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,25 @@ -# arduino-robot-car -Source code to control a 4-wheel robot car based on Arduino Uno. The code has been tested for the "Elegoo Smart Robot Car Kit V3.0 Plus", but can be easily adatped for other similar ones. +# Arduino 4-wheel robot car +Program to control a 4-wheel robot car based on Arduino Uno. The code has been tested for the [Elegoo Smart Robot Car Kit V3.0 Plus](https://www.elegoo.com/download/), but can be easily adatped for other similar ones. The robot consists of a 4 DC motors driven by a H-Bridge with dual output, connecting the two left wheels and the two right ones to its outputs. The car is remotely controlled either by Bluetooth, through the Elegoo Tool app, or by infrared. An ultrasonic sensor attached to a servo motor measures the front distance to objects. A line tracking sensor on the base, with 3 pairs of LED + photoresistors, allows to follow a line drawn on the floor. -Some functionalities have been added in the software to the official Elegoo release. + +Some extra functionalities have been added in the software to the official Elegoo release: +- Park mode. +- Better obstacle avoidance mode. +- Custom mode. The ability to program the robot from the app is not implemented, as it can be relatively easy to using the custom mode, modifying the code. ## Requirements Apart from the standard Arduino libraries, some other ones must be installed: -- ArduinoJson: https://arduinojson.org -- IRRemote: https://github.com/z3t0/Arduino-IRremote -- Servo: https://www.arduino.cc/reference/en/libraries/servo/ +- [ArduinoJson](https://arduinojson.org) +- [IRRemote](https://github.com/z3t0/Arduino-IRremote) +- [Servo](https://www.arduino.cc/reference/en/libraries/servo/) ## Installation 1. Install the required libraries. 2. Download the repository and flash the Arduino. For VSCode, modify the includePath to use the downloaded libraries; if using the Arduino IDE, change the name of the src folder to something appropriate. ## Usage -The oficial Elegoo Tool application for Android must be downloaded to interact with the robot. Nevertheless, changing the initial robot mode will allow you to use it without the app. +The oficial "Elegoo Ble Tool" application for Android / iPhone / iPad must be downloaded to interact with the robot. Nevertheless, changing the initial robot mode will allow you to use it without the app. ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.