ESP32-chat-communication-over-wifi

The aim of the project is to build a chat system using two esp32 development boards.

Table of Contents

• About the Project
  • Tech Stack
  • File Structure
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Results and Demo
• Future Work
• Troubleshooting
• Contributors
• Acknowledgements and Resources
• License

About The Project

• Aim of the project is to build a chat system between two ESP32 development boards.
• The chat system should be fast,secure and easy to use.
• Communication protocol used is ESP-NOW as
  • It overcomes the drawbacks of traditonal wifi connection.
  • The pairing between devices is needed prior to their communication. After the pairing is done, the connection is secure and peer-to-peer.
  • ESP NOW does not require a router for the connection,Thus this project can be used anywhere,at any remote places.
  • If suddenly one of the boards loses power or resets, when it restarts, it will automatically connect to its peers.

To read more about the project refer this documentation

Tech Stack

• FreeRTOS
• ESP-IDF

File Structure

 .
├── Components              # Contains files of specific library of functions or Hardware used
│    ├──esp_now             # Contains the code to setup connection using ESP-NOW. 
│    ├──CMakeLists.txt      # To include this component in a esp-idf 
├── docs                    # Documentation files 
│   ├── report.pdf          # Project report
│   └── results             # Folder containing the video, gifs of the result
├── main                    # Source files of project
│   ├──main.c               # Main Source code.
│   ├──kconfig.projbuild    # Shows the menu of project configuration
│   ├──CMakeLists.txt       # To include source code files in esp-idf.
├── CmakeLists.txt          # To include components and main folder while executing
├── LICENSE
└── README.md 

Getting Started

Prerequisites

• ESP-IDF v4.0 and above

  You can visit the ESP-IDF Programmming Guide for the installation steps.

Installation

Clone the repo

git clone https://github.com/RISHI27-dot/ESP32-chat-communication-over-wifi

Usage

Configuration

idf.py menuconfig

• Chat history

  • Store command history in flash - to store the chat history ans use previous chats.

• ESP-NOW Configuration

  • Send len - espnow packet lenght.

Build

idf.py build

Flash and Monitor

• Connect two esp32 through ports and run the following command on two seprate terminals.
• The terminals will act as user interface.

idf.py -p /dev/ttyUSB0 flash monitor

idf.py -p /dev/ttyUSB1 flash monitor

Code

• The input of chat is taken from the user through the console.
• The chat data is sent to espnow and console task suspended,chat data is sent to other esp32 board.
• Console task is resumed to take the next chat.
• When the chat data is received by the other esp32 board it is printed to the console.

Results and Demo

Future Work

• Add a http web server chat interface.
• Add encryption to the chat communication.

Contributors

• Viraj Jagdale
• Rishikesh Donadkar

Acknowledgements and Resources

• SRA VJTI Eklavya 2020
• Special thanks
  • Gautam Agrawal
  • Dhairya Shah
• Refered FreeRTOS for FreeRTOS API.
• Refered ESP_NOW for ESP-NOW API.

License

Describe your License for your project.