nearxos
bf7bd56fe7
- Reorganized project: codesys/, docs/codesys|redesign|integration|reference/, scripts/ - CODESYS project and exports in codesys/ - Documentation index in docs/README.md - Redesign and light naming configuration - Water boiler control and safety design Co-authored-by: Cursor <cursoragent@cursor.com>
57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
# Home Automation System
|
||
|
||
## Overview
|
||
|
||
This project documents a comprehensive home automation system built around a Raspberry Pi running CODESYS, integrated with Node-RED, Zigbee2MQTT, MQTT broker, and Home Assistant.
|
||
|
||
## System Architecture
|
||
|
||
- **CODESYS Runtime** (Raspberry Pi) — Industrial control, physical I/O
|
||
- **Beckhoff EtherCAT IO** — Relays for lighting and water boiler
|
||
- **Node-RED** — Automation logic and integration
|
||
- **MQTT Broker** (LXC) — Message broker
|
||
- **Zigbee2MQTT** — Zigbee ↔ MQTT bridge
|
||
- **Home Assistant** — Dashboard and automation
|
||
- **Zigbee Switches** — Wireless light switches
|
||
|
||
## Project Structure
|
||
|
||
```
|
||
kkelomatic_home/
|
||
├── codesys/ # CODESYS project and exports
|
||
│ ├── Home_Automation (1).project
|
||
│ ├── Home_Automation.export
|
||
│ ├── Home_Automation.xml
|
||
│ └── Home_Automation.projectarchive
|
||
├── docs/ # Documentation
|
||
│ ├── README.md # Documentation index (start here)
|
||
│ ├── codesys/ # CODESYS docs
|
||
│ ├── integration/ # Node-RED, MQTT, HA, Zigbee
|
||
│ ├── redesign/ # Redesign and implementation
|
||
│ └── reference/ # Architecture, hardware, setup
|
||
├── scripts/ # Helper scripts
|
||
│ └── parse-codesys-xml.py
|
||
├── INFORMATION_NEEDED.md
|
||
└── README.md
|
||
```
|
||
|
||
## Documentation
|
||
|
||
See **[docs/README.md](docs/README.md)** for the full documentation index.
|
||
|
||
### Quick links
|
||
- [Architecture](docs/reference/architecture.md)
|
||
- [CODESYS Configuration](docs/codesys/codesys.md)
|
||
- [Setup Guide](docs/reference/setup.md)
|
||
- [Redesign Summary](docs/redesign/redesign-summary.md)
|
||
- [Light Naming Configuration](docs/redesign/light-naming-configuration.md)
|
||
|
||
## Information Needed
|
||
|
||
See [INFORMATION_NEEDED.md](INFORMATION_NEEDED.md) for what’s required to complete the documentation.
|
||
|
||
## Maintenance
|
||
|
||
- Last Updated: January 27, 2026
|
||
- System Status: Operational
|