Remove obsolete INFORMATION_NEEDED.md and streamline README.md for clarity
- Deleted the INFORMATION_NEEDED.md file as it was no longer necessary for documentation. - Revised README.md to enhance the overview of the home automation system, focusing on how services and CODESYS connectivity work. - Updated project structure in README.md for better organization and clarity, including links to relevant documentation. This update simplifies the documentation and improves the overall user experience for developers and users of the home automation system.
This commit is contained in:
61
README.md
61
README.md
@@ -1,56 +1,35 @@
|
||||
# Home Automation System
|
||||
# Home Automation
|
||||
|
||||
## Overview
|
||||
How home automation works in this house: **services** and **CODESYS** connectivity.
|
||||
|
||||
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.
|
||||
## How it works
|
||||
|
||||
## System Architecture
|
||||
- **CODESYS** (Raspberry Pi) runs the PLC: lights and water boiler via EtherCAT I/O.
|
||||
- **Node-RED** runs automation logic and talks to CODESYS over **UDP (network variables)**.
|
||||
- **MQTT** broker (LXC) is the message bus.
|
||||
- **Zigbee2MQTT** bridges Zigbee switches to MQTT.
|
||||
- **Home Assistant** is the dashboard and can trigger automations.
|
||||
|
||||
- **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
|
||||
Flow: Zigbee switch or HA → Node-RED → UDP → CODESYS → EtherCAT → relays/lights or boiler.
|
||||
|
||||
## Project Structure
|
||||
## Project layout
|
||||
|
||||
```
|
||||
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
|
||||
├── codesys/ # CODESYS project and source (PLC logic, NVL)
|
||||
├── docs/ # Documentation (architecture, services, Codesys)
|
||||
└── scripts/ # parse-codesys-xml.py
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
See **[docs/README.md](docs/README.md)** for the full documentation index.
|
||||
- **Architecture & setup:** [docs/reference/architecture.md](docs/reference/architecture.md), [setup.md](docs/reference/setup.md)
|
||||
- **Services:** [docs/integration/](docs/integration/) — MQTT, Node-RED, Home Assistant, Zigbee2MQTT
|
||||
- **CODESYS:** [docs/codesys/codesys.md](docs/codesys/codesys.md), [codesys/src/NVL/README.md](codesys/src/NVL/README.md) (connectivity)
|
||||
|
||||
### 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)
|
||||
## CODESYS connectivity
|
||||
|
||||
## Information Needed
|
||||
- **NVL_Out** (PLC → Node-RED): light states + boiler status, UDP.
|
||||
- **NVL_In** (Node-RED → PLC): light and boiler commands, UDP.
|
||||
|
||||
See [INFORMATION_NEEDED.md](INFORMATION_NEEDED.md) for what’s required to complete the documentation.
|
||||
|
||||
## Maintenance
|
||||
|
||||
- Last Updated: January 27, 2026
|
||||
- System Status: Operational
|
||||
See [codesys/src/NVL/README.md](codesys/src/NVL/README.md) and [nodered-payload.md](codesys/src/NVL/nodered-payload.md) for layout and ports.
|
||||
|
||||
Reference in New Issue
Block a user