OMGeeky/homecontrol.esp-sensors
1
0
Fork 0
mirror of https://github.com/OMGeeky/homecontrol.esp-sensors.git synced 2026-02-23 15:49:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

add main

Browse Source
This commit is contained in:
OMGeeky
2025-05-07 20:55:57 +02:00
parent 404feb7839
commit e12ba1aaee
2 changed files with 141 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/esp32_deployment_guide.md
View File

@@ -1,6 +1,6 @@
# ESP32 Deployment Guide for Button-Triggered Display Example
# ESP32 Deployment Guide for Button-Triggered Display Application
This guide provides step-by-step instructions for setting up and deploying the `button_triggered_display.py` example to an ESP32 microcontroller.
This guide provides step-by-step instructions for setting up and deploying the button-triggered display application to an ESP32 microcontroller.
## Required Hardware Components
@@ -92,23 +92,12 @@ You can use a tool like `ampy` or `rshell` to upload these libraries:
3. **Copy the necessary files**:
```bash
cp -r src/esp_sensors deploy/
cp examples/button_triggered_display.py deploy/main.py
cp src/main.py deploy/main.py
```
4. **Modify the imports in main.py**:
Edit `deploy/main.py` to change the import statements:
```python
# Replace these lines:
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
from src.esp_sensors.oled_display import OLEDDisplay
from src.esp_sensors.dht22 import DHT22Sensor
# With these lines:
from esp_sensors.oled_display import OLEDDisplay
from esp_sensors.dht22 import DHT22Sensor
```
Note: The main.py file is already configured with the correct imports for deployment.
5. **Upload the files to ESP32**:
4. **Upload the files to ESP32**:
```bash
# Upload the esp_sensors package
ampy --port /dev/ttyUSB0 mkdir esp_sensors
@@ -118,12 +107,12 @@ You can use a tool like `ampy` or `rshell` to upload these libraries:
ampy --port /dev/ttyUSB0 put deploy/esp_sensors/humidity.py esp_sensors/humidity.py
ampy --port /dev/ttyUSB0 put deploy/esp_sensors/dht22.py esp_sensors/dht22.py
ampy --port /dev/ttyUSB0 put deploy/esp_sensors/oled_display.py esp_sensors/oled_display.py
# Upload the main script (will run automatically on boot)
ampy --port /dev/ttyUSB0 put deploy/main.py
```
## Running the Example
## Running the Application
1. **Reset your ESP32** by pressing the reset button or disconnecting and reconnecting power.
@@ -204,4 +193,4 @@ For battery-powered applications, you can increase the sleep duration by modifyi
- [MicroPython Documentation](https://docs.micropython.org/)
- [ESP32 Technical Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf)
- [SSD1306 OLED Display Guide](https://docs.micropython.org/en/latest/esp8266/tutorial/ssd1306.html)
- [DHT22 Sensor Guide](https://randomnerdtutorials.com/esp32-dht11-dht22-temperature-humidity-sensor-micropython/)
- [DHT22 Sensor Guide](https://randomnerdtutorials.com/esp32-dht11-dht22-temperature-humidity-sensor-micropython/)