Add about PolyScope X compatibility

UniversalRobots · Dec 16, 2024 · d9a22c4 · d9a22c4
1 parent 8b9fb9f
commit d9a22c4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/doc/architecture/script_sender.rst b/doc/architecture/script_sender.rst
@@ -22,3 +22,7 @@ The following example creates a ``ScriptSender`` listening on port ``12345`` and
    :linenos:
    :lineno-match:
    :start-at: constexpr uint32_t PORT
+
+.. note::
+   PolyScope X users cannot use the URCap linked above. There is a development version of a URCapX
+   available at https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCapX.
diff --git a/doc/polyscope_compatibility.rst b/doc/polyscope_compatibility.rst
@@ -25,4 +25,13 @@ your robot.
      - `polyscope_compat_break_1 <https://github.com/UniversalRobots/Universal_Robots_Client_Library/tree/polyscope_compat_break_1>`_
      - `tcp_offset in RTDE interface <https://github.com/UniversalRobots/Universal_Robots_Client_Library/pull/110>`_
 
+
+.. note::
+   |polyscope| X doesn't support all features supported by this library for |polyscope| 5.
+   Currently, the following components are known not to be supported:
+
+     - Dashboard client -- |polyscope| X doesn't have a dashboard server.
+     - Using external control on |polyscope| X requires another URCapX for making external control
+       work. This is currently in the process of being created.
+
 .. |polyscope| replace:: PolyScope