diff --git a/docs/assets/simulation_ubuntu_account.png b/docs/assets/simulation_ubuntu_account.png new file mode 100644 index 00000000..c8626369 Binary files /dev/null and b/docs/assets/simulation_ubuntu_account.png differ diff --git a/docs/assets/simulation_utm.png b/docs/assets/simulation_utm.png new file mode 100644 index 00000000..8e6c0644 Binary files /dev/null and b/docs/assets/simulation_utm.png differ diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 7103a9cb..a1bf12dc 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -50,6 +50,7 @@ * [Native setup](simulation_native.md) * [VM setup](simulation_vm.md) * [Usage](simulation_usage.md) + * [Setup on M1 computers](simulation_m1.md) * [ROS](ros.md) * [MAVROS](mavros.md) * [Supplementary materials](supplementary.md) diff --git a/docs/en/simulation_m1.md b/docs/en/simulation_m1.md new file mode 100644 index 00000000..b4983370 --- /dev/null +++ b/docs/en/simulation_m1.md @@ -0,0 +1,53 @@ +# Running simulator on M1 powered computer + +There is no preconfigured VM image for ARM64 architecture of M1 chip (Apple Silicon), so the only possibility is to install the simulation software manually. + +The recommended virtual machine hypervisor is [UTM app](https://mac.getutm.app/). Also it's possible to use **VMware Fusion Public Tech Preview** with M1 support. + +## Simulation installation with UTM + + + +1. Download UTM App from the official site [mac.getutm.app](https://mac.getutm.app/) and install it. +2. Download Ubuntu Linux 20.04 installation iso-file for ARM64 architecture using the link: https://cdimage.ubuntu.com/focal/daily-live/current/focal-desktop-amd64.iso. +3. Create a new virtual machine in UTM, using the following settings: + + * **Type**: Virtualize. + * **Operating System**: Linux. + * **Memory**: 4096 MB or more. + * **CPU Cores**: 4 or more. + * Turn on *Enable hardware OpenGL acceleration* option. + * **Storage**: 20 GB or more. + +4. Run the created virtual machine. +5. Choose *Install Ubuntu* in the menu and install it using the installation master. + + * Recommended apps: *Minimal installation*. + * Installation type: *Erase disk and install Ubuntu*. + * Input your account parameters, for example: + + + +6. Finish the installation and run the system. +7. Install the simulation using the [native setup manual](simulation_native.md). + +### Troubleshooting + +#### Black screen + +If you see a black screen on your virtual machine, try to run the machine without the GPU support. + +In virtual machine settings, choose *Display*, and set *Emulated Display Card* menu to *virtio-ramfb*. Run you machine. If it runs successfully, change the setting back to *virtio-ramfb-gl (GPU Supported)* and run it again. + +#### Problem with `git clone` + +The following error can occur while performing `git clone`: + +```txt +on git clone if error: RPC failed; curl 56 GnuTLS recv error (-54): Error in the pull function. +fatal: the remote end hung up unexpectedly +fatal: early EOF +fatal: index-pack failed +``` + +In this case, change the type of the network card to bridged. In the virtual machine settings, choose *Network*, and set *Network Mode* menu to *Bridged (Advanced)*. diff --git a/docs/ru/SUMMARY.md b/docs/ru/SUMMARY.md index b67ec0e4..27fc3543 100644 --- a/docs/ru/SUMMARY.md +++ b/docs/ru/SUMMARY.md @@ -51,6 +51,7 @@ * [Сборка на собственной машине](simulation_native.md) * [Установка виртуальной машины](simulation_vm.md) * [Использование симулятора](simulation_usage.md) + * [Установка на компьютеры c M1](simulation_m1.md) * [ROS](ros.md) * [MAVROS](mavros.md) * [Дополнительные материалы](supplementary.md) diff --git a/docs/ru/simulation_m1.md b/docs/ru/simulation_m1.md new file mode 100644 index 00000000..d2f150b8 --- /dev/null +++ b/docs/ru/simulation_m1.md @@ -0,0 +1,53 @@ +# Симулятор на компьютерах с чипом M1 + +Для архитектуры ARM64, которую используют компьютеры с чипом M1 (Apple Silicon), [готовый образ с симулятором](simulation_vm.md) не выпускается, поэтому возможна только ручная установка симулятора. + +В качестве виртуальной машины рекомендуется использовать бесплатное приложение [**UTM**](https://mac.getutm.app/). Также возможно использование **VMware Fusion Public Tech Preview** с поддержкой M1. + +## Установка симулятора с UTM + + + +1. Скачайте UTM с официального сайта [mac.getutm.app](https://mac.getutm.app/) и установите его. +2. Скачайте исходный образ установщика Ubuntu 20.04 для архитектуры ARM64 по ссылке: https://cdimage.ubuntu.com/focal/daily-live/current/focal-desktop-amd64.iso. +3. Создайте новую виртуальную машину в UTM, выбирая следующие настройки: + + * **Тип**: Virtualize. + * **Operating System** (ОС): Linux. + * **Memory** (память): 4096 MB или более. + * **CPU Cores** (ядра процессора): 4 или более. + * Включите поддержку OpenGL: *Enable hardware OpenGL acceleration*. + * **Storage** (размер хранилища): 20 GB или более. + +4. Запустите созданную виртуальную машину. +5. Выберите пункт *Install Ubuntu* и установите Ubuntu с помощью мастера установки. + + * Рекомендуемый набор ПО: *Minimal installation*. + * Тип установки: *Erase disk and install Ubuntu*. + * Введите параметры учетной записи по желанию, например: + + + +6. Завершите установку и запустите установленную систему. +7. Установите симулятор согласно [инструкции по сборке симулятора на собственной машине](simulation_native.md). + +### Возможные проблемы при установке + +#### Отсутствие картинки + +Если при запуске виртуальной машины вместо изображения вы видите черный фон, попробуйте запустить машину с отключенной поддержкой GPU. + +В настройках виртуальной машины выберите *Display*, в пункте *Emulated Display Card* выберите *virtio-ramfb*. Запустите машину. При успешном запуске поменяйте настройку обратно на *virtio-ramfb-gl (GPU Supported)* и снова запустите машину. + +#### Проблема с `git clone` + +При осуществлении команды `git clone` может возникнуть подобная ошибка: + +```txt +on git clone if error: RPC failed; curl 56 GnuTLS recv error (-54): Error in the pull function. +fatal: the remote end hung up unexpectedly +fatal: early EOF +fatal: index-pack failed +``` + +В этом случае поменяйте типа сетевой карты на Bridged. В настройках виртуальной машины выберите *Network*, в пункте *Network Mode* выберите *Bridged (Advanced)*.