nearxos
23439e1cd0
- Added a new section in README.md for creating and managing lights by room in Home Assistant, linking to a focused guide. - Enhanced the all-lights-and-rooms.md documentation with a reference to the new guide for clarity on entity creation and room assignment. - Made minor adjustments to the room-config.js file, commenting out outdated device-to-room mappings to improve code clarity. This update improves the documentation and usability for users managing lights and rooms in Home Assistant.
32 lines
1.5 KiB
Markdown
32 lines
1.5 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
|
|
- [HA: create and manage lights by room](integration/ha-lights-and-rooms.md) — Create entities, assign to rooms (Areas), sync with room-config.js
|
|
- [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
|