Add documentation for KUKA Sunrise features and programs

- Created a new document for the Station interface, detailing its menu structure, process data, safety functions, frames, and smartPAD function buttons.
- Added a document for RobotPowerControl, explaining its purpose for safely shutting down or restarting the KUKA Sunrise Cabinet controller.
- Introduced ServerFriRos2 documentation, outlining its role in establishing an FRI connection between the KUKA LBR iiwa and a ROS 2 computer.
- Documented the TeachKuka application, which allows manual teaching of the KUKA LBR iiwa, including position capturing and trajectory recording.
- Added an overview of Sunrise Workbench, including installation instructions for Windows and Linux.
- Created a section on installing a Windows compatibility tool (PortProton) on Linux.
- Documented the installation process for SunriseWorkbench on Linux using PortProton.
- Added installation instructions for SunriseWorkbench on Windows.
- Created troubleshooting documentation for configuration errors and SSL errors during installation.
- Implemented a hook to generate the shared PDF only during the default-language build.
This commit is contained in:
Даниил Грабарь
2026-08-13 18:01:59 +03:00
parent 08ebd40671
commit 79d88db930
42 changed files with 2973 additions and 17 deletions
@@ -0,0 +1,57 @@
# Installing SunriseWorkbench
This section explains how to install SunriseWorkbench on Linux using PortProton.
!!! note "Prerequisite"
Before starting, make sure that PortProton is installed and configured. See [Installing a Windows compatibility tool](emulator.md).
## Starting the installer
**Step 1.** Open the directory containing the SunriseWorkbench installer. Right-click the `.exe` file and select **Open with → PortProton**. Leave the default settings in the dialog and click **Run**.
![Starting the installer with PortProton](../../assets/sun_install/linux/workbench/step-01.png)
## Installation process
**Step 2.** Select the installation language (English by default) and click **OK**.
![Selecting the language](../../assets/sun_install/linux/workbench/step-02.png)
**Step 3.** Click **Next** in the installation wizard's welcome window.
![Welcome window](../../assets/sun_install/linux/workbench/step-03.png)
**Step 4.** Review the license agreement and accept its terms.
![License agreement](../../assets/sun_install/linux/workbench/step-04.png)
**Step 5.** Keep the default installation path unless you have a specific reason to change it.
![Installation path](../../assets/sun_install/linux/workbench/step-05.png)
**Step 6.** Select **Desktop** to create a SunriseWorkbench desktop shortcut.
![Desktop shortcut](../../assets/sun_install/linux/workbench/step-06.png)
**Step 7.** Click **Install** and wait until all required components have been installed.
![Installation process](../../assets/sun_install/linux/workbench/step-07.png)
Click **Create shortcut** to place the shortcut on the desktop.
## First launch
**Step 8.** Start SunriseWorkbench from the desktop shortcut. Click **Run** so that PortProton can initialize the application environment.
![Selecting a workspace](../../assets/sun_install/linux/workbench/step-08.png)
**Step 9.** The application asks for a workspace path. Keep the default value and select **Use this as the default and do not ask again**.
![Main SunriseWorkbench window](../../assets/sun_install/linux/workbench/step-09.png)
**Step 10.** After the main window loads, click **New Sunrise Project**.
![Creating a new project](../../assets/sun_install/linux/workbench/step-10.png)
!!! tip "Further configuration"
See [Creating a new project](../../config/new-project.md) for project configuration instructions. You should also [install the required libraries](../../config/libraries.md).