🛍️ distributoreSwag

Welcome to the distributore Swag repository! This project manages a water dispenser controlled via an ESP32.

🗂️ Table of contents

Requirements
- Hardware
- Software
Project Tree Organization
Getting Started
- How to Build the Project
- How to Burn and Run the Project
Proejct diagram and user guide
- distributoreSwag Workflow
Things to improve
Presentation and Videos
Team Members

📈 Requirements

Hardware

ESP32 and relative sensors:

Buzzer
Display LCD 1602 with I2C module
RGB LED
Button
Ultrasonic HC-SR04 sensor
Microservo 9G SG90 5V
Breadboard, cables and resistors

Software

VS Code with the PlatformIO extension.

🌲 Project tree organization

.
├── README.md
├── lib
│   ├── AP
│   │   ├── AP.cpp
│   │   ├── AP.h
│   │   ├── captiveRequestHandler.cpp
│   │   └── captiveRequestHandler.h
│   ├── button
│   │   ├── button.cpp
│   │   └── button.h
│   ├── buzzer
│   │   ├── buzzer.cpp
│   │   ├── buzzer.h
│   │   └── pitches.h
│   ├── display
│   │   ├── display.cpp
│   │   └── display.h
│   ├── logic
│   │   ├── logic.cpp
│   │   └── logic.h
│   ├── rgb
│   │   ├── rgb.cpp
│   │   └── rgb.h
│   ├── servo
│   │   ├── servo.cpp
│   │   └── servo.h
│   ├── timerControl
│   │   ├── timerControl.cpp
│   │   └── timerControl.h
│   └── ultrasound
│       ├── ultrasound.cpp
│       └── ultrasound.h
├── platformio.ini
├── src
│   └── main.cpp

💪 Getting started

How to build the project

You can either clone this repository via terminal

git clone https://github.com/jagorev/distributoreSwag.git

or download the project folder.

Then, using VS Code with the PlatformIO extension, open the project (PlatformIO Home Page --> Open Project).

Ultimately, using the terminal inside VS Code, proceed to build the project

platformio run

alternatively, click on the ✔️ in the bottom bar.

How to burn and run the project

First, you need to connect the ESP32 to the computer.

Then, proceed by uploading the built project through the terminal inside VS Code (specifying the target port)

pio run --target upload

alternatively, click on the → in the bottom bar.

To run the project, just click on the RST button on the ESP32.

📝 Project diagram and user guide