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>
102 lines
2.3 KiB
Markdown
102 lines
2.3 KiB
Markdown
# Redesign Summary - Quick Reference
|
|
|
|
## What We're Changing
|
|
|
|
### Current Structure → New Structure
|
|
|
|
**Before**:
|
|
- Room-based with generic `l_1`, `l_2` names
|
|
- Fixed 6 lights per room
|
|
- Toggle-based control
|
|
- No status feedback from relays
|
|
|
|
**After**:
|
|
- Room-based in CODESYS, flat in Home Assistant
|
|
- Descriptive names: `kitchen_main`, `master_bedroom_bedside_left`
|
|
- Command-based control (ON/OFF for HA, toggle for Zigbee)
|
|
- Actual relay status feedback
|
|
- Water boiler with comprehensive safety
|
|
|
|
---
|
|
|
|
## Key Documents
|
|
|
|
1. **`light-naming-configuration.md`** ⭐ **START HERE**
|
|
- Complete light naming for all 16 rooms
|
|
- Water boiler control structure
|
|
- Safety measures
|
|
- **Action**: Review and modify with your actual lights
|
|
|
|
2. **`redesign-implementation-roadmap.md`**
|
|
- Step-by-step implementation guide
|
|
- Phase-by-phase checklist
|
|
- Timeline estimates
|
|
|
|
3. **`structure-redesign-analysis.md`**
|
|
- Detailed analysis of structure options
|
|
- Why Option 4 (Hybrid) was chosen
|
|
|
|
4. **`fb_switch-redesign-recommendation.md`**
|
|
- Function block redesign details
|
|
- Control logic improvements
|
|
|
|
---
|
|
|
|
## Quick Structure Reference
|
|
|
|
### Light Naming Convention
|
|
```
|
|
Format: {room}_{function}
|
|
|
|
Examples:
|
|
- kitchen_main
|
|
- master_bedroom_bedside_left
|
|
- outdoor_front_security
|
|
```
|
|
|
|
### Function Types
|
|
- `main` - Primary light
|
|
- `bedside_left/right` - Bedside lamps
|
|
- `under_cabinet` - Task lighting
|
|
- `security` - Security lighting
|
|
- `ambient` - Atmospheric lighting
|
|
- etc.
|
|
|
|
### CODESYS Access
|
|
```iec
|
|
rooms.kitchen.main.ha_on := TRUE;
|
|
rooms.master_bedroom.bedside_left.state;
|
|
```
|
|
|
|
### Home Assistant Entity
|
|
```
|
|
light.kitchen_main
|
|
light.master_bedroom_bedside_left
|
|
```
|
|
|
|
---
|
|
|
|
## Water Boiler Safety Features
|
|
|
|
1. ✅ **Temperature Protection** (max 80°C, min 10°C)
|
|
2. ✅ **Time Limits** (max 8h ON, min 30m OFF)
|
|
3. ✅ **Flow Detection** (shut off if no flow)
|
|
4. ✅ **Emergency Stop** (immediate shutdown)
|
|
5. ✅ **Pressure Protection** (if sensor available)
|
|
6. ✅ **State Monitoring** (relay status readback)
|
|
7. ✅ **Error Reporting** (comprehensive error codes)
|
|
|
|
---
|
|
|
|
## Next Steps
|
|
|
|
1. **Review** `light-naming-configuration.md`
|
|
2. **Modify** light names per room based on actual installation
|
|
3. **Map** relays to lights
|
|
4. **Start** Phase 1 of implementation roadmap
|
|
|
|
---
|
|
|
|
**Status**: Ready for configuration review
|
|
**Priority**: Review and customize light names first
|