Initial commit: Home automation docs and CODESYS project
- 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>
This commit is contained in:
89
docs/reference/network.md
Normal file
89
docs/reference/network.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Network Topology
|
||||
|
||||
## Overview
|
||||
|
||||
This document describes the network configuration and topology of the home automation system.
|
||||
|
||||
## Network Diagram
|
||||
|
||||
```
|
||||
[To be created with actual IP addresses]
|
||||
```
|
||||
|
||||
## IP Address Assignments
|
||||
|
||||
| Device/Service | IP Address | MAC Address | Hostname | Notes |
|
||||
|----------------|------------|-------------|----------|-------|
|
||||
| Raspberry Pi (CODESYS) | [To be filled] | [To be filled] | [To be filled] | |
|
||||
| Node-RED Host | [To be filled] | [To be filled] | [To be filled] | |
|
||||
| MQTT Broker (LXC) | [To be filled] | [To be filled] | [To be filled] | |
|
||||
| Zigbee2MQTT Host | [To be filled] | [To be filled] | [To be filled] | |
|
||||
| Home Assistant | [To be filled] | [To be filled] | [To be filled] | |
|
||||
|
||||
## Network Segments
|
||||
|
||||
### Subnets
|
||||
|
||||
- **Main Network**: [Subnet/CIDR]
|
||||
- **IoT Network**: [If separate VLAN/subnet]
|
||||
- **Management Network**: [If separate]
|
||||
|
||||
### VLANs
|
||||
|
||||
[If VLANs are used]
|
||||
|
||||
## Port Assignments
|
||||
|
||||
| Service | Protocol | Port | Access | Notes |
|
||||
|---------|----------|------|--------|-------|
|
||||
| MQTT | TCP | 1883 | Internal | |
|
||||
| MQTT TLS | TCP | 8883 | Internal | If enabled |
|
||||
| Node-RED | HTTP | [Port] | [Access] | |
|
||||
| Home Assistant | HTTP | [Port] | [Access] | |
|
||||
| CODESYS | [Protocol] | [Port] | [Access] | |
|
||||
| Zigbee2MQTT | HTTP | [Port] | [Access] | |
|
||||
|
||||
## Firewall Rules
|
||||
|
||||
[Document firewall rules if applicable]
|
||||
|
||||
## DNS
|
||||
|
||||
- **Internal DNS**: [If used]
|
||||
- **Hostname Resolution**: [How devices find each other]
|
||||
|
||||
## Routing
|
||||
|
||||
[If complex routing is involved]
|
||||
|
||||
## Network Services
|
||||
|
||||
### DHCP
|
||||
|
||||
- **DHCP Server**: [To be filled]
|
||||
- **Reserved IPs**: [List if static IPs are reserved]
|
||||
|
||||
### DNS
|
||||
|
||||
- **DNS Servers**: [To be filled]
|
||||
|
||||
## Security
|
||||
|
||||
- **Network Isolation**: [To be filled]
|
||||
- **VPN Access**: [If applicable]
|
||||
- **Remote Access**: [How remote access is configured]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Network Connectivity
|
||||
|
||||
- **Ping Tests**: [How to test connectivity]
|
||||
- **Port Checks**: [How to verify ports are open]
|
||||
|
||||
### Common Issues
|
||||
|
||||
- [Issue]: [Solution]
|
||||
|
||||
---
|
||||
|
||||
**Status**: Template - needs IP addresses and network details
|
||||
Reference in New Issue
Block a user