Installing EchoLib

This guide walks through the installation process for the EchoLib library in the Arduino IDE. The library provides comprehensive wireless communication and robotics control functionality for the ECHO.

---

Things To Consider:

TIMING:

EchoLib may take a bit longer to install on your first download. This is because it includes multiple external libraries, such as the Adafruit servo driver, Arduino WiFi, Bluetooth, etc., all combined into one simple package. Instead of installing and managing these separately, EchoLib brings everything together for you in a single import. While this can make the initial install slower, it makes coding much easier especially for beginners. Once installed, you won’t have to worry about setting these up again!

---

Downloading EchoLib:

1. Visit the EchoLib GitHub repository.

2. Go to the release page.

3. Download the latest .ZIP file.

4. Save the Echo_Lib.zip file to a location you can easily find (e.g., downloads folder)

IMPORTANT:

Do NOT unzip the file. The Arduino IDE requires the library to be in ZIP format for installation.

---

Installing EchoLib in Arduino IDE:

Method 1: Using the Library Manager (Recommended)

1. Open the Arduino IDE

2. Navigate to Sketch → Include Library → Add .ZIP Library...

3. In the file browser, locate the downloaded EchoLib.zip file

4. Select the file and click Open (or Choose on Mac)

5. Wait for the installation to complete. You should see a success message in the status bar:

   Library installed successfully.

6. Restart Arduino IDE to ensure the library is fully loaded

Method 2: Manual Installation

If the ZIP installation method doesn't work, you can install manually:

1. Locate your Arduino libraries folder:

   • Windows: Documents\Arduino\libraries\

   • Mac: ~/Documents/Arduino/libraries/

   • Linux: ~/Arduino/libraries/

2. Extract the contents of Echo_Lib.zip

   1. This just means double-click so its no longer a .ZIP file :)

3. Copy the extracted Echo_Lib folder into your libraries folder

4. The structure should look like:

   Arduino/
   └── libraries/
       └── Echo_Lib/
           ├── src/
           ├── examples/
           ├── library.properties
           └── README.md

5. Restart the Arduino IDE

---

Verifying Installation:

To confirm EchoLib is installed correctly:

• try including the library in a new sketch:

#include <EchoLib.h>

void setup() {
    // If this compiles without errors, EchoLib is installed
}

void loop() {
}

Click Verify (checkmark icon). If the sketch compiles without errors, EchoLib is properly installed.

---

Testing Your Installation:

Create a simple test sketch to verify everything works:

#include <EchoLib.h>

BLEServerWrapper ble("TestEcho");

void setup() {
    Serial.begin(115200);
    delay(1000);
    
    Serial.println("Testing EchoLib Installation...");
    
    ble.begin();
    ble.connect();
    
    Serial.println("EchoLib initialized successfully!");
    Serial.println("Installation test complete.");
}

void loop() {
    ble.loop();
    delay(1000);
}

Expected Output:

Testing EchoLib Installation...
Initializing BLE...
BLE Server initialized successfully
Device name: TestEcho
==============================
BLE Advertising started
Device name: TestEcho
Waiting for a client connection...
==============================
EchoLib initialized successfully!
Installation test complete.

---

Troubleshooting:

Library Not Found After Installation:

Problem: The Arduino IDE shows "library not found" error when compiling.

SOLUTIONS:

• Restart the Arduino IDE completely

• Verify the library folder structure is correct

• Check that the library is in the correct Arduino libraries folder

• Try reinstalling using the manual installation method

Compilation Errors:

Problem: Sketch fails to compile with errors referencing EchoLib.

SOLUTIONS:

• Ensure ESP32 board support is properly installed

• Verify you've selected an ESP32 board under Tools → Board

• Update ESP32 board support to the latest version

• Check that all library dependencies are met

Upload Fails:

Problem: Cannot upload sketches to the ECHO board.

SOLUTIONS:

• Verify the correct COM port is selected

• Check USB cable (try a different cable)

• Press and hold the PROG button on ECHO while uploading

• Reduce upload speed to 115200 under Tools → Upload Speed

• Install or update USB-to-Serial drivers for your operating system

---

Updating EchoLib:

To update to a newer version of EchoLib:

1. Download the latest EchoLib.zip from the GitHub repository

2. Remove the old version:

   • Go to Sketch → Include Library → Manage Libraries...

   • Search for "EchoLib"

   • Click Remove (if available in Library Manager)

   • Or manually delete the EchoLib folder from your libraries directory

3. Install the new version following the installation steps above

4. Restart the Arduino IDE

---