Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dra1ex/esp_ir_motion
Smart IR Motion Sensor based on ESP32/ESP8266
https://github.com/dra1ex/esp_ir_motion
esp32 esp8266 motion-sensor mqtt
Last synced: 6 days ago
JSON representation
Smart IR Motion Sensor based on ESP32/ESP8266
- Host: GitHub
- URL: https://github.com/dra1ex/esp_ir_motion
- Owner: DrA1ex
- Created: 2024-09-12T10:32:27.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-28T11:43:42.000Z (9 days ago)
- Last Synced: 2024-10-28T14:44:28.591Z (9 days ago)
- Topics: esp32, esp8266, motion-sensor, mqtt
- Language: C++
- Homepage: https://dra1ex.github.io/esp_ir_motion/
- Size: 202 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# esp-ir-motion
Smart IR Motion Sensor based on ESP32/ESP8266
## UI
## Features
- Web/Mobile Application (PWA)
- Optional sound and visual (LED) alerting
- Integration with any Smart Home Assistant (such as Alise) via MQTT broker
- MQTT Protocol
## Connection
## Installation
### Manual Build / OTA
1. Install [Platform.IO](https://platformio.org/install):
2. (Optional) Modify the `credentials.h` file and, if necessary, customize `constants.h`. You can change these parameters later through the Web UI.
3. Upload filesystem and firmware
**Note:** This repository contains a submodule. Please use the `--recursive` option when cloning.
```bash
git clone --recursive https://github.com/DrA1ex/esp_ir_motion.git
cd esp_ir_motion
# Make script executable
chmod +x ./upload_fs.sh
# Specify the platform: esp32-c3 or esp8266
PLATFORM=esp32-c3
# Set the environment: debug, release, or ota
ENV=release
# For OTA: set your ESP's address
ADDRESS=esp_motion.local
# Additional envs if OTA enabled
if [ "$ENV" = "ota" ]; then OTA=1 else OTA=0 ADDRESS= fi
pio run -t upload -e $PLATFORM-$ENV --upload-port "$ADDRESS"
./upload_fs.sh --upload-port "$ADDRESS"
```
## MQTT Protocol
| Topic In * | Topic Out * | Type | Values | Comments |
|---------------------------|-------------------------------|-------------|----------------------|---------------------------------------|
| `MQTT_TOPIC_POWER` | `MQTT_OUT_TOPIC_POWER` | `uint8_t` | 0..1 | Power state: ON (1) / OFF (0) |
| `MQTT_TOPIC_PAUSE` | `MQTT_OUT_TOPIC_PAUSE` | `uint8_t` | 0..1 | Trigger Silent mode (default time) |
| `MQTT_TOPIC_SILENT` | | `uint32_t` | duration in seconds | Set Silent mode for custom time |
| | `MQTT_OUT_TOPIC_ALARM` | `uint8_t` | 0..1 | Indicates alarm state |
\* Actual topic values decalred in `constants.h`
## Misc
### Configuring a Secure WebSocket Proxy with Nginx
If you're hosting a Web UI that uses SSL, you'll need to set up a Secure WebSocket (`wss://...`) server instead of the non-secure `ws://` provided by your ESP. Browsers require secure socket connections for WebSocket functionality, so this configuration is essential.
To achieve this, you can use Nginx as a proxy to create an SSL-enabled WebSocket connection.
#### Step 0: Install Nginx
```sh
apt install nginx
```
#### Step 1: Create the Nginx Configuration
Create a file at `/etc/nginx/conf.d/ws.locations` and add the following content:
```nginx
location /w_esp_ir_motion/ws {
proxy_pass http:///ws; # Replace with your actual service address
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection keep-alive;
proxy_set_header Host $host;
}
# You can create proxy for multiple hosts
location /w_esp_ir_motion_2/ws {
proxy_pass http:///ws; # Replace with your actual service address
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection keep-alive;
proxy_set_header Host $host;
}
```
#### Step 2: Reload the Nginx Configuration
After saving the configuration file, reload Nginx to apply the changes:
```sh
nginx -s reload
```
**Note**
Make sure to replace `` and `` with the actual IP addresses of your ESP devices.
#### Step 3: Check result
Open WebUi in browser https://dra1ex.github.io/esp_ir_motion/?host=ADDRESS/w_esp_ir_motion