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>
77 lines
1.5 KiB
Markdown
77 lines
1.5 KiB
Markdown
# Setup Guide
|
|
|
|
## Overview
|
|
|
|
This guide provides step-by-step instructions for setting up the home automation system from scratch.
|
|
|
|
## Prerequisites
|
|
|
|
- [ ] Hardware components assembled
|
|
- [ ] Network infrastructure in place
|
|
- [ ] Access to all devices
|
|
- [ ] Required software licenses (CODESYS)
|
|
|
|
## Installation Order
|
|
|
|
1. Network Configuration
|
|
2. MQTT Broker Setup
|
|
3. CODESYS Installation
|
|
4. Node-RED Installation
|
|
5. Zigbee2MQTT Setup
|
|
6. Home Assistant Installation
|
|
7. Integration Configuration
|
|
|
|
## Step-by-Step Setup
|
|
|
|
### 1. Network Configuration
|
|
|
|
[Detailed network setup instructions]
|
|
|
|
### 2. MQTT Broker (LXC)
|
|
|
|
[Instructions for setting up MQTT broker in LXC container]
|
|
|
|
### 3. CODESYS on Raspberry Pi
|
|
|
|
[Instructions for installing and configuring CODESYS]
|
|
|
|
### 4. Node-RED
|
|
|
|
[Instructions for installing and configuring Node-RED]
|
|
|
|
### 5. Zigbee2MQTT
|
|
|
|
[Instructions for setting up Zigbee2MQTT]
|
|
|
|
### 6. Home Assistant
|
|
|
|
[Instructions for installing and configuring Home Assistant]
|
|
|
|
### 7. Integration
|
|
|
|
[Instructions for connecting all components]
|
|
|
|
## Configuration Files
|
|
|
|
[Links to or locations of configuration files]
|
|
|
|
## Verification
|
|
|
|
### Testing Checklist
|
|
|
|
- [ ] MQTT broker is accessible
|
|
- [ ] CODESYS can communicate with Node-RED
|
|
- [ ] Zigbee devices are paired
|
|
- [ ] Node-RED flows are working
|
|
- [ ] Home Assistant can see all entities
|
|
- [ ] Switches control lights correctly
|
|
- [ ] Water boiler control works
|
|
|
|
## Troubleshooting Setup Issues
|
|
|
|
[Common setup problems and solutions]
|
|
|
|
---
|
|
|
|
**Status**: Template - needs detailed setup instructions
|