kkelomatic_home/INFORMATION_NEEDED.md

Information Needed for Documentation

This document outlines the information needed to complete the home automation system documentation. Please provide as much detail as possible for each section.

1. Network Configuration

• IP addresses for all devices:
  • Raspberry Pi (CODESYS)
  • Node-RED host
  • MQTT broker (LXC container)
  • Zigbee2MQTT host
  • Home Assistant host
• Network topology (VLANs, subnets, etc.)
• Port numbers used by services (MQTT, Node-RED, Home Assistant, etc.)
• Firewall rules or network restrictions

2. CODESYS Configuration

• CODESYS version and license type
• Network variable names and types (sent to Node-RED)
• Network variable names and types (received from Node-RED)
• EtherCAT IO card model and configuration
• Relay mapping (which relay controls which light/device)
• Water boiler control logic
• Project file location or export (if available)

3. Node-RED Configuration

• Node-RED version
• Flow export or description of main flows
• MQTT topics used for communication
• CODESYS network variable integration details
• Custom nodes or functions used
• Automation logic descriptions

4. MQTT Broker

• MQTT broker software (Mosquitto, Eclipse, etc.) and version
• LXC container specifications
• Authentication configuration (users, passwords, ACLs)
• Topic structure and naming conventions
• Retain policies and QoS levels

5. Zigbee2MQTT

• Zigbee2MQTT version
• Coordinator device model
• List of Zigbee devices (switches, sensors, etc.) with:
  • Device names
  • Model numbers
  • MQTT topics
  • Functions/features
• Configuration file location or export
• Network key (if you're comfortable sharing, or note that it's stored securely)

6. Home Assistant

• Home Assistant version and installation type (HassOS, Docker, etc.)
• Integration configurations:
  • MQTT integration settings
  • Node-RED integration (if used)
  • Zigbee integration (if direct)
• Dashboard screenshots or descriptions
• Automation rules
• Custom components or add-ons

7. Hardware Inventory

• Raspberry Pi model and specifications
• Beckhoff EtherCAT IO card model number
• Relay module details (model, number of channels)
• Zigbee coordinator hardware
• Zigbee switch models and quantities
• Water boiler model and control interface
• Any other connected hardware

8. Physical Wiring

• Relay to device mapping (which relay controls which physical device)
• Wiring diagrams or descriptions
• Safety considerations or warnings

9. Automation Logic

• How light switches trigger actions
• Water boiler control logic and schedules
• Any time-based automations
• Error handling and fallback behaviors
• Manual override procedures

10. Access Information (Optional)

If you'd like me to access services directly to gather information:

• SSH access details (if comfortable)
• Web interface URLs and credentials (if comfortable)
• API endpoints and authentication
• File system paths to configuration files

Note: Only provide access information if you're comfortable doing so. I can work with exported configuration files instead.

11. Troubleshooting & Known Issues

• Common problems and solutions
• Known limitations
• Planned improvements

Priority Items

To get started quickly, the most important information is:

1. Network IP addresses and topology
2. CODESYS network variable names
3. MQTT topic structure
4. Zigbee device list
5. Relay to device mapping

---

How to Provide Information:

1. Fill out this checklist and provide details in a separate document
2. Export configuration files and share them
3. Grant access to services (if comfortable)
4. Provide screenshots of configurations
5. Schedule a walkthrough session

Let me know your preferred method!