ESP32-Serial

Web-based Serial monitor for ESP32 for debugging & viewing the logs.

Table of Contents

• Installation Guide
• Requirements
• Running the Project
• Usage
• Contributing
• License

Installation Guide

Follow these steps to set up and run the project on a Linux PC (Not yet tested on Mac/ Windows)

1. Clone the Repository

First, clone the repository to your local machine using the following command:

git clone https://github.com/developer-srj/ESP32-serial.git

2. Navigate to the Project Directory

Change to the project directory:

cd ESP32-serial

3. Install Dependencies

Install the required Python packages listed in the requirements.txt file:

pip install -r requirements.txt

4. Make the run.sh File Executable

Before running the script, ensure that the run.sh file is executable:

chmod +x run.sh

5. Run the Script

Execute the run.sh script by running the run.sh located in the ESP32-serial directory to start the Serial Monitor in your Browser

Or use below bash command

./run.sh

Requirements

Ensure that the following dependencies are listed in your requirements.txt file:

asyncio
pyserial
websockets

These packages can be installed using pip and are required for the project to run.

Running the Project

Once you have completed the installation steps, you can run the project by executing the run.sh script. This script will run the server.py & open the index.html for your Browser.

Execute the run.sh script by running the run.sh located in the ESP32-serial directory to start the Serial Monitor in your Browser:

use below shell command

./run.sh

Usage

Execute the run.sh script to start the Serial Monitor in your Browser:

use below shell command

./run.sh

Contributing

If you’d like to contribute to this project, please follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix (git checkout -b feature-branch).
3. Make your changes and commit them (git commit -am 'Add new feature').
4. Push your branch to GitHub (git push origin feature-branch).
5. Open a pull request on GitHub to merge your changes into the main repository.

Please ensure that your code adheres to the project's coding standards and includes appropriate tests.

License

This project is licensed under the MIT License - see the LICENSE file for details.