From 71adbae89ef2617a2b9b98fa74920f45afed48f9 Mon Sep 17 00:00:00 2001 From: henryharrod Date: Tue, 23 Apr 2024 10:29:14 +0100 Subject: [PATCH] Update known-issues to include TF-1686 (#20) This PR adds known-issue TF-1686 to the documentation. --- docs/downloads/v1-0-0.md | 8 +++++--- docs/downloads/v1-0-1.md | 10 +++++++--- docs/manual/getting-started.md | 7 +++++++ docs/manual/installation/installation.md | 7 +++++++ docs/manual/known-issues.md | 11 ++++++----- docs/manual/transform.client/transform.client.md | 7 +++++++ 6 files changed, 39 insertions(+), 11 deletions(-) diff --git a/docs/downloads/v1-0-0.md b/docs/downloads/v1-0-0.md index 052044c..18cc5e2 100644 --- a/docs/downloads/v1-0-0.md +++ b/docs/downloads/v1-0-0.md @@ -9,6 +9,7 @@ sidebar_label: Release Notes v1.0.0 - **macOS Client Version**: `1.0.0` ## New In This Release + - Everything! 🎉 - **transform**.engine is your ultimate live plugin host: low-latency, high reliability, and versatile network control. - ⚡ **Powerful**: Run VST3 plugins in up to 64 chains at down to 1 ms latency over Dante. @@ -22,9 +23,10 @@ sidebar_label: Release Notes v1.0.0 ## Known Issues Users should be aware of the following [known issues](../manual/known-issues) in this release, which we hope to address in a future update: -* TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing -* TF-1345: Chain metering freezes whilst that chain restarts -* TF-1673: Engine service status indicators are occasionally inaccurate + +- TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing +- TF-1345: Chain metering freezes whilst that chain restarts +- TF-1686: Connecting the client to the **transform**.engine using a link-local address results in the client not functioning as expected A small number of plugins may experience compatibility issues running on transform.engine. For details, see our plugin compatibility database at https://plugins.fourieraudio.com . diff --git a/docs/downloads/v1-0-1.md b/docs/downloads/v1-0-1.md index 4398cf4..b909284 100644 --- a/docs/downloads/v1-0-1.md +++ b/docs/downloads/v1-0-1.md @@ -9,9 +9,11 @@ sidebar_label: Release Notes v1.0.1 - **macOS Client Version**: `1.0.1` ## New In This Release + This is a bugfix patch release; for details of the newest features, see [v1.0.0](v1-0-0)! ## Bugs Fixed In This Release + 1. **TF-1682: Engines running release `v0.0.9`, `v0.0.10` fail to offer upgrade automatically** We discovered that devices which left the factory running certain older versions could fail to @@ -29,9 +31,11 @@ with **transform**.engine `v1.0.0`. ## Known Issues Users should be aware of the following [known issues](../manual/known-issues) in this release, which we hope to address in a future update: -* TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing -* TF-1345: Chain metering freezes whilst that chain restarts -* TF-1673: Engine service status indicators are occasionally inaccurate + +- TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing +- TF-1345: Chain metering freezes whilst that chain restarts +- TF-1673: Engine service status indicators are occasionally inaccurate +- TF-1686: Connecting the client to the **transform**.engine using a link-local address results in the client not functioning as expected A small number of plugins may experience compatibility issues running on transform.engine. For details, see our plugin compatibility database at https://plugins.fourieraudio.com . diff --git a/docs/manual/getting-started.md b/docs/manual/getting-started.md index d75634b..d5e3f3b 100644 --- a/docs/manual/getting-started.md +++ b/docs/manual/getting-started.md @@ -45,6 +45,13 @@ In order for the audio engine to start (enabling you to install, open and plugin ::: +:::warning + +Please note that at this time, the **transform**.client must be connected by either a static or DHCP IP address - **not link-local**; see [known issue TF-1686](./known-issues). +This will be resolved in a future release. + +::: + # Step 4: Configure the IP address of the client computer On your Windows or macOS computer (that you have connected to your **transform**.engine as per diff --git a/docs/manual/installation/installation.md b/docs/manual/installation/installation.md index 2d54839..98d51d5 100644 --- a/docs/manual/installation/installation.md +++ b/docs/manual/installation/installation.md @@ -17,3 +17,10 @@ You will need: Using the OLED display on the front of the unit, you can configure the IP address for the Dante Control, Primary and Secondary connections. For more details on this, see [here](../transform.engine/oled). + +:::warning + +Please note that at this time, the **transform**.client must be connected by either a static or DHCP IP address - **not link-local**; see [known issue TF-1686](../known-issues). +This will be resolved in a future release. + +::: diff --git a/docs/manual/known-issues.md b/docs/manual/known-issues.md index c3bdbff..a2add52 100644 --- a/docs/manual/known-issues.md +++ b/docs/manual/known-issues.md @@ -8,11 +8,12 @@ While we would of course love to all live in a land of no software bugs, we are We intend on resolving all known issues in a future release, but until then, here's the current list of known issue advisories: -| Issue Ref. | Issue Details | Workaround | Fixed In Version | -|------------|---------------|------------|------------------| -| TF-944 | Dante Secondary Link-Local IP addresses are not supported. If the Secondary network port is set to use Link Local addressing, it will be assigned an IP address in the `169.254/16` range rather than the `172.31/16` range as required for Dante Secondary functionality. | Only use Static or DHCP IP addressing for Dante Secondary. At your own peril, you could set a static IP in the `172.31/16` subnet, however this is **not recommended** as you may experience network issues with IP conflicts in such a configuration. | - | -| TF-1345 | While a chain restarts, metering freezes on that chain. | This is purely cosmetic: you can see that a chain is restarting if all plugins have a lightning bolt next to them. The metering should resume normal service once all plugins have restarted. | - | -| TF-1673 | Engine service status indicators are occasionally inaccurate. In certain circumstances, the engine status indicators can show a service being offline when it is actually online, or vice versa. | This is purely cosmetic. Support can obtain accurate details about engine status by inspecting the logs. | - | +| Issue Ref. | Issue Details | Workaround | Fixed In Version | +| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | +| TF-944 | Dante Secondary Link-Local IP addresses are not supported. If the Secondary network port is set to use Link Local addressing, it will be assigned an IP address in the `169.254/16` range rather than the `172.31/16` range as required for Dante Secondary functionality. | Only use Static or DHCP IP addressing for Dante Secondary. At your own peril, you could set a static IP in the `172.31/16` subnet, however this is **not recommended** as you may experience network issues with IP conflicts in such a configuration. | - | +| TF-1345 | While a chain restarts, metering freezes on that chain. | This is purely cosmetic: you can see that a chain is restarting if all plugins have a lightning bolt next to them. The metering should resume normal service once all plugins have restarted. | - | +| TF-1673 | Engine service status indicators are occasionally inaccurate. In certain circumstances, the engine status indicators can show a service being offline when it is actually online, or vice versa. | This is purely cosmetic. Support can obtain accurate details about engine status by inspecting the logs. | - | +| TF-1686 | Connecting the client to the **transform**.engine using a link-local address results in the client not functioning as expected. | Please only connect the **transform**.client to the **transform**.engine using static or DHCP IP addresses. If you are using Dante in link-local mode, please connect the client to the engine using the control port, configured to either a static or DHCP address. | - | While we strive to support as many plugins as possible on the **transform**.engine, as the engine is an open platform running third-party plugins, there may occasionally be compatibility issues between diff --git a/docs/manual/transform.client/transform.client.md b/docs/manual/transform.client/transform.client.md index f24efb8..f23367c 100644 --- a/docs/manual/transform.client/transform.client.md +++ b/docs/manual/transform.client/transform.client.md @@ -23,6 +23,13 @@ Launch the **transform**.client, and select 'Connect to new device', input the I And voila, you're in! +:::warning + +Please note that at this time, the **transform**.client must be connected by either a static or DHCP IP address - **not link-local**; see [known issue TF-1686](../known-issues). +This will be resolved in a future release. + +::: + ### Multiple Clients Multiple users on different devices can connect to the same **transform**.engine and make edits to different plugins at the same time.