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>
96 lines
1.7 KiB
Markdown
96 lines
1.7 KiB
Markdown
# Node-RED Configuration
|
|
|
|
## Overview
|
|
|
|
Node-RED provides flow-based programming for automation logic and acts as a bridge between CODESYS, MQTT, and Home Assistant.
|
|
|
|
## Installation
|
|
|
|
- **Version**: [To be filled]
|
|
- **Installation Method**: [To be filled]
|
|
- **Host**: [To be filled]
|
|
- **Port**: [To be filled]
|
|
|
|
## Main Flows
|
|
|
|
### Flow 1: [Name]
|
|
|
|
**Purpose**: [Description]
|
|
|
|
**Nodes Used**:
|
|
- [Node type]: [Function]
|
|
|
|
**Logic**: [Description]
|
|
|
|
### Flow 2: [Name]
|
|
|
|
[Similar structure]
|
|
|
|
## CODESYS Integration
|
|
|
|
### Network Variable Nodes
|
|
|
|
- **Connection Method**: [To be filled]
|
|
- **Variables Mapped**: [To be filled]
|
|
- **Update Frequency**: [To be filled]
|
|
|
|
## MQTT Integration
|
|
|
|
### Subscribed Topics
|
|
|
|
| Topic | QoS | Function | Description |
|
|
|-------|-----|----------|-------------|
|
|
| [Topic] | [QoS] | [Function] | [Description] |
|
|
|
|
### Published Topics
|
|
|
|
| Topic | QoS | Function | Description |
|
|
|-------|-----|----------|-------------|
|
|
| [Topic] | [QoS] | [Function] | [Description] |
|
|
|
|
## Home Assistant Integration
|
|
|
|
- **Integration Method**: [MQTT, HTTP, API, etc.]
|
|
- **Entities Created**: [To be filled]
|
|
- **Automations**: [To be filled]
|
|
|
|
## Custom Functions
|
|
|
|
### JavaScript Functions
|
|
|
|
```javascript
|
|
// [Function name and description]
|
|
// [Code if available]
|
|
```
|
|
|
|
## Error Handling
|
|
|
|
- **Error Nodes**: [To be filled]
|
|
- **Retry Logic**: [To be filled]
|
|
- **Fallback Behaviors**: [To be filled]
|
|
|
|
## Flow Export
|
|
|
|
[If available, include flow export or reference to flow file]
|
|
|
|
## Dashboard (if used)
|
|
|
|
- **Dashboard Nodes**: [To be filled]
|
|
- **UI Components**: [To be filled]
|
|
|
|
## Troubleshooting
|
|
|
|
### Common Issues
|
|
|
|
- [Issue]: [Solution]
|
|
|
|
### Debugging
|
|
|
|
- How to enable debug messages
|
|
- Flow validation
|
|
- Message inspection
|
|
|
|
---
|
|
|
|
**Status**: Template - needs flow details
|