Readme and Agent documentation updated
This commit is contained in:
52
README.md
52
README.md
@@ -1,3 +1,53 @@
|
||||
# ESP-Home-Scripts
|
||||
|
||||
Device description files for my ESPHome-devices - currently still transmitted "manually"...
|
||||
ESPHome configuration files for ESP32-based home automation devices integrated with Home Assistant.
|
||||
|
||||
## Overview
|
||||
|
||||
This repository contains device configuration files for various ESPHome devices around my home. Each YAML file represents a complete device configuration that can be compiled and uploaded to the corresponding ESP32 hardware.
|
||||
|
||||
## Devices
|
||||
|
||||
- **ades-office-control-panel.yaml** - Office control panel with LVGL touchscreen display
|
||||
- **ades-office-resistive-control-panel.yaml** - Alternative office control panel with resistive touch
|
||||
- **ns-panel-ground-floor.yaml** - Sonoff NS Panel for ground floor home controls
|
||||
- **oekoboiler-interface.yaml** - Monitoring and control interface for eco-boiler system
|
||||
- **old-phone-doorbell.yaml** - Repurposed vintage phone as smart doorbell
|
||||
- **powermeter.yaml** - Real-time power consumption monitoring device
|
||||
|
||||
## Setup
|
||||
|
||||
1. Install [ESPHome](https://esphome.io/guides/getting_started_command_line.html)
|
||||
2. Create a `secrets.yaml` file with your credentials:
|
||||
```yaml
|
||||
wifi_ssid: "your-wifi-ssid"
|
||||
wifi_password: "your-wifi-password"
|
||||
ota_password: "your-ota-password"
|
||||
# Add other device-specific secrets as needed
|
||||
```
|
||||
3. Validate a configuration:
|
||||
```bash
|
||||
esphome config device-name.yaml
|
||||
```
|
||||
4. Compile and upload:
|
||||
```bash
|
||||
esphome run device-name.yaml
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- ESPHome (latest version recommended)
|
||||
- Home Assistant instance for device integration
|
||||
- ESP32 development boards (esp32dev)
|
||||
- Device-specific hardware (displays, sensors, etc.)
|
||||
|
||||
## Notes
|
||||
|
||||
- Configurations are currently transmitted manually to devices
|
||||
- All sensitive credentials are stored in `secrets.yaml` (not tracked in git)
|
||||
- Devices use OTA (Over-The-Air) updates for firmware upgrades
|
||||
- Each device integrates with Home Assistant via the native API
|
||||
|
||||
## License
|
||||
|
||||
See [LICENSE](LICENSE) file for details.
|
||||
|
||||
Reference in New Issue
Block a user