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:
115
docs/integration/homeassistant.md
Normal file
115
docs/integration/homeassistant.md
Normal file
@@ -0,0 +1,115 @@
|
||||
# Home Assistant Configuration
|
||||
|
||||
## Overview
|
||||
|
||||
Home Assistant provides the user interface (dashboard) and additional automation capabilities for the home automation system.
|
||||
|
||||
## Installation
|
||||
|
||||
- **Version**: [To be filled]
|
||||
- **Installation Type**: [HassOS, Docker, Python venv, etc.]
|
||||
- **Host**: [To be filled]
|
||||
- **Port**: [To be filled]
|
||||
- **URL**: [To be filled]
|
||||
|
||||
## Integrations
|
||||
|
||||
### MQTT Integration
|
||||
|
||||
- **Broker**: [IP/URL]
|
||||
- **Port**: [To be filled]
|
||||
- **Discovery**: [Enabled/Disabled]
|
||||
- **Topics**: [To be filled]
|
||||
|
||||
### Node-RED Integration
|
||||
|
||||
- **Integration Method**: [MQTT, HTTP, API, etc.]
|
||||
- **Configuration**: [To be filled]
|
||||
|
||||
### Zigbee Integration
|
||||
|
||||
- **Direct Zigbee**: [If Home Assistant has direct Zigbee integration]
|
||||
- **Via Zigbee2MQTT**: [Configuration]
|
||||
|
||||
## Entities
|
||||
|
||||
### Lighting Entities
|
||||
|
||||
| Entity ID | Name | Source | Control Method |
|
||||
|-----------|------|--------|----------------|
|
||||
| [ID] | [Name] | [Source] | [Method] |
|
||||
|
||||
### Water Boiler Entity
|
||||
|
||||
| Entity ID | Name | Source | Control Method |
|
||||
|-----------|------|--------|----------------|
|
||||
| [ID] | [Name] | [Source] | [Method] |
|
||||
|
||||
### Other Entities
|
||||
|
||||
[Add other entities]
|
||||
|
||||
## Dashboards
|
||||
|
||||
### Main Dashboard
|
||||
|
||||
- **Layout**: [Description or screenshot reference]
|
||||
- **Cards**: [List of cards/widgets]
|
||||
- **Views**: [Different views/pages]
|
||||
|
||||
### Mobile Dashboard
|
||||
|
||||
[If different from main]
|
||||
|
||||
## Automations
|
||||
|
||||
### Automation 1: [Name]
|
||||
|
||||
- **Trigger**: [Description]
|
||||
- **Condition**: [Description]
|
||||
- **Action**: [Description]
|
||||
|
||||
### Automation 2: [Name]
|
||||
|
||||
[Similar structure]
|
||||
|
||||
## Scripts
|
||||
|
||||
[Document any Home Assistant scripts]
|
||||
|
||||
## Scenes
|
||||
|
||||
[Document scenes if used]
|
||||
|
||||
## Custom Components
|
||||
|
||||
- **Custom Components**: [List if any]
|
||||
- **Add-ons**: [List if any]
|
||||
|
||||
## Configuration Files
|
||||
|
||||
- **Configuration Location**: [Path]
|
||||
- **Main Config File**: [Path]
|
||||
- **Automation Files**: [Path]
|
||||
- **Dashboard Files**: [Path]
|
||||
|
||||
## Access Control
|
||||
|
||||
- **Users**: [To be filled]
|
||||
- **API Tokens**: [To be filled - stored securely]
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
- [Issue]: [Solution]
|
||||
|
||||
### Debugging
|
||||
|
||||
- Enable debug logging
|
||||
- Check integration status
|
||||
- Review logs
|
||||
|
||||
---
|
||||
|
||||
**Status**: Template - needs configuration details
|
||||
Reference in New Issue
Block a user