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>
94 lines
2.0 KiB
Markdown
94 lines
2.0 KiB
Markdown
# Zigbee2MQTT Configuration
|
|
|
|
## Overview
|
|
|
|
Zigbee2MQTT bridges Zigbee wireless devices to the MQTT ecosystem, allowing Zigbee switches to communicate with the rest of the automation system.
|
|
|
|
## Installation
|
|
|
|
- **Version**: [To be filled]
|
|
- **Host**: [To be filled]
|
|
- **Installation Method**: [Docker, native, etc.]
|
|
- **Configuration File**: [Path to be filled]
|
|
|
|
## Coordinator
|
|
|
|
- **Model**: [To be filled]
|
|
- **Firmware**: [To be filled]
|
|
- **Port**: [To be filled]
|
|
|
|
## Zigbee Devices
|
|
|
|
### Light Switches
|
|
|
|
| Device Name | Model | IEEE Address | MQTT Topic | Functions |
|
|
|------------|-------|--------------|------------|-----------|
|
|
| [Name] | [Model] | [Address] | [Topic] | [Functions] |
|
|
|
|
### Other Devices
|
|
|
|
[Add other Zigbee devices if applicable]
|
|
|
|
## MQTT Topics
|
|
|
|
### Topic Structure
|
|
|
|
- **Base Topic**: [To be filled, typically `zigbee2mqtt`]
|
|
- **Device Topics**: `[base_topic]/[device_name]`
|
|
- **Bridge Topics**: `[base_topic]/bridge/*`
|
|
|
|
### Common Topics
|
|
|
|
| Topic | Type | Description |
|
|
|-------|------|-------------|
|
|
| `zigbee2mqtt/[device]/set` | Publish | Control device |
|
|
| `zigbee2mqtt/[device]` | Subscribe | Device state |
|
|
| `zigbee2mqtt/bridge/state` | Subscribe | Bridge status |
|
|
| `zigbee2mqtt/bridge/log` | Subscribe | Bridge logs |
|
|
|
|
## Device Configuration
|
|
|
|
### Switch Configuration
|
|
|
|
[Configuration details for switches]
|
|
|
|
### Pairing Process
|
|
|
|
1. [Step 1]
|
|
2. [Step 2]
|
|
3. [Step 3]
|
|
|
|
## Network Security
|
|
|
|
- **Network Key**: [Stored securely - location to be documented]
|
|
- **PAN ID**: [To be filled]
|
|
- **Channel**: [To be filled]
|
|
|
|
## Integration with Node-RED
|
|
|
|
- **How switches trigger flows**: [To be filled]
|
|
- **Topic mappings**: [To be filled]
|
|
|
|
## Integration with Home Assistant
|
|
|
|
- **Auto-discovery**: [Enabled/Disabled]
|
|
- **Manual configuration**: [If applicable]
|
|
|
|
## Troubleshooting
|
|
|
|
### Common Issues
|
|
|
|
- **Device not responding**: [Solution]
|
|
- **Pairing failures**: [Solution]
|
|
- **Network instability**: [Solution]
|
|
|
|
### Debugging
|
|
|
|
- Enable debug logging
|
|
- Check MQTT messages
|
|
- Monitor Zigbee network map
|
|
|
|
---
|
|
|
|
**Status**: Template - needs device list and configuration
|