https://github.com/martinvichnal/esp-iot-lamp
This is a really simple Open Source WiFi smart lamp project with ESP32 and WS2812B LEDs
https://github.com/martinvichnal/esp-iot-lamp
esp32 smarthome smartlamp wifi ws2812b
Last synced: about 2 months ago
JSON representation
This is a really simple Open Source WiFi smart lamp project with ESP32 and WS2812B LEDs
- Host: GitHub
- URL: https://github.com/martinvichnal/esp-iot-lamp
- Owner: martinvichnal
- Created: 2023-05-04T21:23:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-20T15:37:29.000Z (almost 3 years ago)
- Last Synced: 2025-03-04T19:45:05.126Z (over 1 year ago)
- Topics: esp32, smarthome, smartlamp, wifi, ws2812b
- Language: C++
- Homepage:
- Size: 122 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ESP-IoT-Lamp
------------------------------------------------------------------------------------------------------------------------------
## Introduction
This is a really simple Open Source WiFi smart lamp repository. This project was built with Espressif ESP32 and WS2812B LEDs controlled by FastLED library.
The main goal was to build a Smart Lamp that you controll with your phone.
- *Feel free to **improve use or fork** this repository in your own projects, just mention me on it :)*
- *For any bugs or improvements feel free to make an [issue](https://github.com/martinvichnal/ESP_IOT_Project/issues) or make a [pull request](https://github.com/martinvichnal/ESP_IOT_Project/pulls)*
------------------------------------------------------------------------------------------------------------------------------
## Table of Contents
- [Introduction](#introduction)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [Basic Controls](#basic-controls)
- [Installation](#installation)
- [Hardware Requirements](#hardware-requirements)
- [Software Requirements](#software-requirements)
- [Communication](#communication)
- [Flow Charts](#flow-charts)
- [WiFi Manager](#wifi-manager)
- [Blending](#blending)
- [Mentions](#mentions)
------------------------------------------------------------------------------------------------------------------------------
## Usage
- Connect your LEDs to [this](https://github.com/martinvichnal/ESP_IOT_Project/blob/b9c0bc6115a8d086cfb76bf80369942787a9aea7/src/main.cpp#LL111C42-L111C42)
```C++
#define LED_PIN 5 // Led DATA output
```
- To use this code first you need to set your home WiFi SSID and PASS in the [following code](https://github.com/martinvichnal/ESP_IOT_Project/blob/ecf1069e504b3fa3c4f153a6b806b2fd85c221e6/src/main.cpp#L80):
```C++
// Replace with your network credentials
const char *ssid = "your SSID";
const char *password = "your PASS";
```
- Upload
- When the ESP has connected to your home internet it will put out a message in the serial monitor with the IP adress.
- Copy it then paste it in your web. (Disclaimer! you need to be connected to the same internet as your ESP)
*In further versions you won't have to hard code your credentials.*
### Basic Controls
The lamp has 3 main effects: ***Rainbow***, ***Colors Fade*** and ***Custom Color***.
You can controll the brightness of the leds, in one mode you can controll the hue of the leds and in 2 of the modes you can controll the speed too.
------------------------------------------------------------------------------------------------------------------------------
## Installation
### Hardware Requirements
- Board: ***ESP32***
- Light: ***WS2812B***, 30 LEDs in total
- Power supply: ***18650 battery*** and ***MP2636 charger board***
### Software Requirements
- Operating System: ***ALL***
- Programming environment: ***Visual Studio Code - PlatformIO***
- Programming language: ***C++***
- Additional dependencies or libraries:
```C++
#include
#include
#include
#include
#include
// https://community.platformio.org/t/solved-asyncelegantota-collect2-exe-error-ld-returned-1-exit-status/28553
#include
#include
#include
#include "FileSystem.h"
#include "Cipher.h" // For encryption
```
------------------------------------------------------------------------------------------------------------------------------
## Communication
The ESP is communicating via WebSockets and in that it is passing JSON file which is looks like this:
```JSON
{
"state":0,
"mode":2,
"brightnessValue":255,
"speedValue":25,
"rgbValue":125
}
```
| Name | Value | Description |
| ----------- | ----------- | ----------- |
| "state" | 1/0, true/false | On/Off state |
| "mode" | 0..2 | Mode select |
| "brightnessValue" | 0..255 | Brightness |
| "speedValue" | 0..100 | Speed in two modes |
| "rgbValue" | 0..255 | Hue value in one mode |
------------------------------------------------------------------------------------------------------------------------------
## Flow Charts
This flow chart section contains main functions for easy understanding.
### WiFi Manager
This fucntion the initWiFi() where the ESP basically manages the wifi connection.
This fucnion is not running in setup() or loop() (so it runs in one of the cores) because then it wouldn't do anything untill you are connected to the internet. This is important because the lamp can be used as a standalone unit (eg. using it withount any internet) just have to put it in some buttons lol
```mermaid
flowchart TD
initWiFi["initWiFi()"] --> TryToConnectNetwork[Trying to connect to network]
TryToConnectNetwork --> TryingForSec[Trying For 'tryForMs' Sec]
TryingForSec --> Success{Success ?}
Success -->|YES| initServer[Initializing WebServer and WebSocket]
Success -->|NO| initWifiManager["initWiFiManager()"]
initServer --> exitInitWifi["Exiting initWiFi()"]
initWifiManager --> startWebserverWifiManager["Starting servers with AP"]
startWebserverWifiManager --> GettingPWSSID["Waiting for PW and SSID"]
GettingPWSSID --> SuccessPWSSID{Success ?}
SuccessPWSSID -->|YES| Restart
SuccessPWSSID -->|NO| initWifiManager["initWiFiManager()"]
Restart --> initWiFi
```
### Blending
Blending fucntion is just a "Nice to have" part of the code. This is blending two led sources when mode change happened.
Little buggy at the moment. issue: #2
```mermaid
flowchart TD
ModeChanged{"Mode Changed ?"}
ModeChanged -->|NO| runPatternActualMode1["runPattern(actualMode, leds)"]
ModeChanged -->|YES| runPatternActualMode2["runPattern(actualMode, source1)"]
runPatternActualMode2 --> runPatternNewMode["runPattern(newMode, source2)"]
runPatternNewMode --> blend["blend(source1, source2, leds, NUM_LEDS, blendAmount)"]
blend --> blendIs255{"blendAmount == 255"}
blendIs255 -->|YES| actualModeIsTheNewMode["actualMode = newMode"]
actualModeIsTheNewMode --> ModeChangedisFalse["Mode Changed = false"]
ModeChangedisFalse --> blendAmountIs0["blendAmount = 0"]
blendIs255 -->|NO| blendAmountInc["blendAmount++"]
```
------------------------------------------------------------------------------------------------------------------------------
## Mentions
This project would not be here without these repositories so huge thanks :)
[alanswx/ESPAsyncWiFiManager](https://github.com/alanswx/ESPAsyncWiFiManager),
[kurimawxx00/wifi-manager](https://github.com/kurimawxx00/wifi-manager),
[me-no-dev/ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer).