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:
Даниил Грабарь
@@ -0,0 +1,73 @@
|
||||
# Installing a Windows compatibility tool
|
||||
|
||||
Windows applications can be run on Linux with **PortProton**, installed from the **Flathub** repository using the **Flatpak** package manager.
|
||||
|
||||
## Installing Flatpak
|
||||
|
||||
On Ubuntu 18.10 or later, run:
|
||||
|
||||
=== "Bash"
|
||||
```bash
|
||||
sudo apt update && sudo apt upgrade -y
|
||||
sudo apt install flatpak
|
||||
```
|
||||
|
||||
## Installing the GNOME Software plugin
|
||||
|
||||
To add Flatpak support to GNOME Software:
|
||||
|
||||
=== "Bash"
|
||||
```bash
|
||||
sudo apt install gnome-software-plugin-flatpak
|
||||
```
|
||||
|
||||
## Adding the Flathub repository
|
||||
|
||||
=== "Bash"
|
||||
```bash
|
||||
flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
|
||||
```
|
||||
|
||||
!!! warning "Restart required"
|
||||
Restart the system after adding the repository so that the changes take effect.
|
||||
|
||||
## Installing PortProton
|
||||
|
||||
PortProton can be installed either from the terminal or through GNOME Software.
|
||||
|
||||
**From the terminal:**
|
||||
|
||||
=== "Bash"
|
||||
```bash
|
||||
flatpak install flathub ru.linux_gaming.PortProton
|
||||
```
|
||||
|
||||
Start it with:
|
||||
|
||||
=== "Bash"
|
||||
```bash
|
||||
flatpak run ru.linux_gaming.PortProton
|
||||
```
|
||||
|
||||
**From GNOME Software:**
|
||||
|
||||
After Flathub has been added, PortProton is also available in GNOME Software.
|
||||
|
||||
|
||||
|
||||
## Initial setup
|
||||
|
||||
On first launch, PortProton automatically installs the required Wine dependencies and helper components. This process takes several minutes.
|
||||
|
||||
|
||||
|
||||
After initialization, the application's main functions become available, including:
|
||||
|
||||
- **Wine settings** — manage the Wine environment;
|
||||
- **Windows command prompt** — run `cmd.exe` inside Wine;
|
||||
- **File manager** — access the virtual Windows file system.
|
||||
|
||||
|
||||
|
||||
!!! tip "Next step"
|
||||
After installing PortProton, proceed to [Installing SunriseWorkbench](workbench.md).
|
||||
@@ -0,0 +1,11 @@
|
||||
# Installation on Linux
|
||||
|
||||
SunriseWorkbench is compatible only with Windows. On Linux, install a compatibility tool that can run Windows applications.
|
||||
|
||||
Several popular solutions are available:
|
||||
|
||||
- **PortProton**
|
||||
- **ProtonPlus**
|
||||
- **Bottles**
|
||||
|
||||
The [Windows emulator installation](emulator.md) section explains how to install each of these tools.
|
||||
@@ -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**.
|
||||
|
||||
|
||||
|
||||
## Installation process
|
||||
|
||||
**Step 2.** Select the installation language (English by default) and click **OK**.
|
||||
|
||||
|
||||
|
||||
**Step 3.** Click **Next** in the installation wizard's welcome window.
|
||||
|
||||
|
||||
|
||||
**Step 4.** Review the license agreement and accept its terms.
|
||||
|
||||
|
||||
|
||||
**Step 5.** Keep the default installation path unless you have a specific reason to change it.
|
||||
|
||||
|
||||
|
||||
**Step 6.** Select **Desktop** to create a SunriseWorkbench desktop shortcut.
|
||||
|
||||
|
||||
|
||||
**Step 7.** Click **Install** and wait until all required components have been installed.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
**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**.
|
||||
|
||||
|
||||
|
||||
**Step 10.** After the main window loads, click **New Sunrise Project**.
|
||||
|
||||
|
||||
|
||||
!!! 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).
|
||||
@@ -0,0 +1,42 @@
|
||||
# Installation on Windows
|
||||
|
||||
This section explains how to install SunriseWorkbench on Windows.
|
||||
|
||||
## Installing SunriseWorkbench
|
||||
|
||||
**Step 1.** Start the SunriseWorkbench installer. Select the installation language (English by default) and click **OK**.
|
||||
|
||||
|
||||
|
||||
**Step 2.** Click **Next** in the installation wizard's welcome window.
|
||||
|
||||
|
||||
|
||||
**Step 3.** Review the license agreement and accept its terms.
|
||||
|
||||
|
||||
|
||||
**Step 4.** Keep the default installation path unless you have a specific reason to change it.
|
||||
|
||||
|
||||
|
||||
**Step 5.** Select **Create Desktop Shortcut** for convenient access.
|
||||
|
||||
|
||||
|
||||
**Step 6.** Click **Install** and wait until all required components have been installed.
|
||||
|
||||
|
||||
|
||||
## First launch
|
||||
|
||||
**Step 7.** On first launch, the application asks for a workspace path. Keep the default path and select **Use this as the default and do not ask again**.
|
||||
|
||||
|
||||
|
||||
**Step 8.** After the main window loads, click **New Sunrise Project** to create a project.
|
||||
|
||||
|
||||
|
||||
!!! 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).
|
||||
Reference in New Issue
Block a user