|
|
|
---
|
|
|
|
title: Connect to KNX Interface
|
|
|
|
---
|
|
|
|
- The connection to a Knx Interface can be configured via "/configuration/apisettings" in the General Options tab
|
|
|
|
## Connecting to a KNX Interface
|
|
|
|
|
|
|
|
- Here the IP Address and Port of a IP Tunnel can be entered
|
|
|
|
To connect the API to a real KNX installation via a KNX IP Tunnel, follow the instructions below.
|
|
|
|
|
|
|
|
- Configuration changes must be saved and the API restarted
|
|
|
|
---
|
|
|
|
|
|
|
|
### Configuration Steps
|
|
|
|
|
|
|
|
1. Navigate to the **General Options** tab under
|
|
|
|
`/configuration/apisettings`.
|
|
|
|
|
|
|
|
- In the standard output of the API a log message will inform if the connection was sucessful - if not the API will continously attempt to connect
|
|
|
|
2. Enter the **IP Address** and **Port** of your KNX IP Tunnel.
|
|
|
|
|
|
|
|
- Alternatively the "datapoint/values" endpoint will respond with status code 504 Gateway Timeout if no connection is currently available
|
|
|
|
3. Click **Save Changes**.
|
|
|
|
|
|
|
|
4. Restart the API to apply the configuration.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### Connection Feedback
|
|
|
|
|
|
|
|
- After saving and restarting, a log message will appear in the **API's standard output**, indicating whether the connection was successful.
|
|
|
|
- If the connection fails, the API will continuously attempt to reconnect.
|
|
|
|
- Alternatively, requests to the `/datapoint/values` endpoint will return a
|
|
|
|
**504 Gateway Timeout** status if no connection is available.
|
|
|
|
|
|
|
|
> **Note:** If the **"Activate Simulator"** option is enabled in the **Simulator Options** tab, the API **will not attempt** to connect to a KNX Interface.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
Note: If the box "Activate Simulator" is checked in the Simulator Options tab the API will not connect to a Knx Interface |
|
|
\ No newline at end of file |
|
|
|
➡️ [Back to Using the API](home/03-Usage) |
|
|
\ No newline at end of file |
