nearxos
714aa84504
- Introduced new sections in README.md for Node-RED flows related to living room lighting and room management. - Added links to specific documentation for living room flow, all lights and rooms configuration, and living room analysis. - Enhanced overall organization of the README to improve user navigation and understanding of Node-RED integration with Home Assistant. This update enriches the documentation for users implementing Node-RED in their home automation setups.
31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
# Documentation
|
|
|
|
Basics: **how home automation works**, **services**, and **CODESYS connectivity**.
|
|
|
|
## Reference (architecture & setup)
|
|
|
|
- [Architecture](reference/architecture.md) — Components and data flow
|
|
- [Hardware](reference/hardware.md) — Raspberry Pi, EtherCAT, Zigbee
|
|
- [Network](reference/network.md) — Topology
|
|
- [Setup](reference/setup.md) — Installation order
|
|
- [Quick reference](reference/quick-reference.md)
|
|
|
|
## Services
|
|
|
|
- [MQTT](integration/mqtt.md) — Broker (LXC)
|
|
- [Node-RED](integration/nodered.md) — Automation and CODESYS bridge
|
|
- [Home Assistant](integration/homeassistant.md) — Dashboard
|
|
- [Zigbee2MQTT](integration/zigbee2mqtt.md) — Zigbee ↔ MQTT
|
|
|
|
## Node-RED + HA (lights and rooms)
|
|
|
|
- [Living Room flow](integration/nodered-livingroom-flow.md) — Test flow, NVL send, Action node, sync
|
|
- [All lights and rooms](integration/all-lights-and-rooms.md) — Scale to all lights: config, HA entities (YAML bulk), checklist
|
|
- [Living Room analysis](integration/nodered-livingroom-analysis.md) — Current nodes and wiring (from live Node-RED)
|
|
|
|
## CODESYS
|
|
|
|
- [CODESYS configuration](codesys/codesys.md) — Runtime, EtherCAT, NVL
|
|
- [PLC algorithm design](codesys/plc-algorithm-design.md) — Logic and I/O
|
|
- **NVL (connectivity):** [codesys/src/NVL/README.md](../codesys/src/NVL/README.md) — UDP, NVL_In / NVL_Out, payload layout
|