From ac8caea2b107b6ccda20911d0464a06a8981be09 Mon Sep 17 00:00:00 2001 From: Oleg Kalachev Date: Thu, 16 Jun 2022 00:55:32 +0300 Subject: [PATCH] docs: update some outdated articles --- clover_blocks/README.md | 10 +++++----- docs/en/camera_calibration.md | 4 ++-- docs/en/rviz.md | 2 +- docs/en/simulation_vm.md | 4 +--- docs/en/web_video_server.md | 2 +- docs/ru/camera_calibration.md | 4 ++-- docs/ru/rviz.md | 2 +- docs/ru/simulation_vm.md | 6 ++---- docs/ru/web_video_server.md | 2 +- 9 files changed, 16 insertions(+), 20 deletions(-) diff --git a/clover_blocks/README.md b/clover_blocks/README.md index 3077085d..f00cb86c 100644 --- a/clover_blocks/README.md +++ b/clover_blocks/README.md @@ -19,7 +19,7 @@ The frontend files are located in [`www`](./www/) subdirectory. The frontend app ### Services * `~run` ([*clover_blocks/Run*](srv/Run.srv)) – run Blockly-generated program (in Python). -* `~stop` ([*std_srvs/Trigger*](http://docs.ros.org/melodic/api/std_srvs/html/srv/Trigger.html)) – terminate the running program. +* `~stop` ([*std_srvs/Trigger*](http://docs.ros.org/noetic/api/std_srvs/html/srv/Trigger.html)) – terminate the running program. * `~store` ([*clover_blocks/load*](srv/Store.srv)) – store a user program (to `/programs` by default). * `~load` ([*clover_blocks/load*](srv/Load.srv)) – load all the stored programs. @@ -45,11 +45,11 @@ http:///clover_blocks/?navigate_tolerance=0.5&sleep_time=0.1 #### Published -* `~running` ([*std_msgs/Bool*](http://docs.ros.org/melodic/api/std_msgs/html/msg/Bool.html)) – indicates if the program is currently running. -* `~block` ([*std_msgs/String*](http://docs.ros.org/melodic/api/std_msgs/html/msg/String.html)) – current executing block (maximum topic rate is limited). -* `~error` ([*std_msgs/String*](http://docs.ros.org/melodic/api/std_msgs/html/msg/String.html)) – user program errors and exceptions. +* `~running` ([*std_msgs/Bool*](http://docs.ros.org/noetic/api/std_msgs/html/msg/Bool.html)) – indicates if the program is currently running. +* `~block` ([*std_msgs/String*](http://docs.ros.org/noetic/api/std_msgs/html/msg/String.html)) – current executing block (maximum topic rate is limited). +* `~error` ([*std_msgs/String*](http://docs.ros.org/noetic/api/std_msgs/html/msg/String.html)) – user program errors and exceptions. * `~prompt` ([*clover_blocks/Prompt*](msg/Prompt.msg)) – user input request (includes random request ID string). This topic is published from the frontend side: -* `~prompt/` ([*std_msgs/String*](http://docs.ros.org/melodic/api/std_msgs/html/msg/String.html)) – user input response. +* `~prompt/` ([*std_msgs/String*](http://docs.ros.org/noetic/api/std_msgs/html/msg/String.html)) – user input response. diff --git a/docs/en/camera_calibration.md b/docs/en/camera_calibration.md index aeb997f5..5dadc9b7 100644 --- a/docs/en/camera_calibration.md +++ b/docs/en/camera_calibration.md @@ -10,14 +10,14 @@ There are several tools allowing to calibrate the camera and store calculated pa Main tutorial: http://wiki.ros.org/camera_calibration/Tutorials/MonocularCalibration. -In order to calibrate the camera with the `camera_calibration` ROS-package you need a computer with OS GNU/Linux and [ROS Melodic](ros-install.md) installed. +In order to calibrate the camera with the `camera_calibration` ROS-package you need a computer with OS GNU/Linux and [ROS Noetic](http://wiki.ros.org/noetic/Installation/Ubuntu) installed. ROS Camera Calibrator 1. Using the Terminal, install `camera_calibration` package to your computer: ```bash - sudo apt-get install ros-melodic-camera-calibration + sudo apt-get install ros-noetic-camera-calibration ``` 2. Download the chessboard – [chessboard.pdf](../assets/chessboard.pdf). Print the chessboard on paper or open it on the computer screen. diff --git a/docs/en/rviz.md b/docs/en/rviz.md index a647dddc..2d2f25b7 100644 --- a/docs/en/rviz.md +++ b/docs/en/rviz.md @@ -11,7 +11,7 @@ To use rviz and rqt, a PC running Ubuntu Linux (or a virtual machine such as [Pa > **Hint** You can use the [preconfigured virtual machine image](simulation_vm.md) with ROS and Clover toolkit. -Install package `ros-melodic-desktop-full` or `ros-melodic-desktop` using the [installation documentation](http://wiki.ros.org/melodic/Installation/Ubuntu). +Install package `ros-noetic-desktop-full` or `ros-noetic-desktop` using the [installation documentation](http://wiki.ros.org/noetic/Installation/Ubuntu). Start rviz --- diff --git a/docs/en/simulation_vm.md b/docs/en/simulation_vm.md index 10175b35..34b780ad 100644 --- a/docs/en/simulation_vm.md +++ b/docs/en/simulation_vm.md @@ -2,7 +2,7 @@ In addition to [native installation instructions](simulation_native.md), we provide a [preconfigured developer virtual machine image](https://github.com/CopterExpress/clover_vm/releases/latest). The image contains: -* Ubuntu 18.04 with XFCE lightweight desktop environment; +* Ubuntu 20.04 with XFCE lightweight desktop environment; * ROS packages required to develop for the Clover platform; * QGroundControl; * preconfigured Gazebo simulation environment; @@ -16,8 +16,6 @@ The VM is an easy way to set up a simulation environment, but can be used as a d You can download the latest VM image [in the VM releases repository](https://github.com/CopterExpress/clover_vm/releases). -> **Note** The virtual machine should be used when native installation is not feasible or possible. You may experience reduced performance in programs that use 3D rendering, like rviz and Gazebo. - ## Setting up the VM You need to use a VM manager that supports OVF format, like [VirtualBox](https://www.virtualbox.org/wiki/Downloads), [VMware Player](https://www.vmware.com/products/workstation-player.html) or [VMware Workstation](https://www.vmware.com/products/workstation-pro.html). diff --git a/docs/en/web_video_server.md b/docs/en/web_video_server.md index b84b25d2..dd797168 100644 --- a/docs/en/web_video_server.md +++ b/docs/en/web_video_server.md @@ -20,7 +20,7 @@ Parameters `width`, `height`, etc. re also available. Read more about `web_video ## Browse with rqt_image_view -To browse images with the rqt tools the user needs a computer with Ubuntu 18.04 and [ROS Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu). +To browse images with the rqt tools the user needs a computer with Ubuntu 20.04 and [ROS Noetic](http://wiki.ros.org/noetic/Installation/Ubuntu). [Connect to the Clover Wi-Fi network](wifi.md) an run `rqt_image_view` with its IP-address: diff --git a/docs/ru/camera_calibration.md b/docs/ru/camera_calibration.md index 798d8215..e29da39b 100644 --- a/docs/ru/camera_calibration.md +++ b/docs/ru/camera_calibration.md @@ -10,14 +10,14 @@ Основной туториал: http://wiki.ros.org/camera_calibration/Tutorials/MonocularCalibration. -Для калибровки камеры с использованием ROS-пакета camera_calibration необходим компьютер с установленным ОС GNU/Linux и [ROS Melodic](ros-install.md). +Для калибровки камеры с использованием ROS-пакета camera_calibration необходим компьютер с установленным ОС GNU/Linux и [ROS Noetic](http://wiki.ros.org/noetic/Installation/Ubuntu). ROS Camera Calibrator 1. Используя Терминал, установите на компьютер пакет `camera_calibration`: ```bash - sudo apt-get install ros-melodic-camera-calibration + sudo apt-get install ros-noetic-camera-calibration ``` 2. Скачайте калибровочную доску – [`chessboard.pdf`](../assets/chessboard.pdf). Распечатайте доску на принтере либо выведите ее на экран компьютера. diff --git a/docs/ru/rviz.md b/docs/ru/rviz.md index d60bbc2d..019814dc 100644 --- a/docs/ru/rviz.md +++ b/docs/ru/rviz.md @@ -11,7 +11,7 @@ > **Hint** Вы можете можете использовать готовый [образ виртуальной машины](simulation_vm.md) с инструментами для Клевера. -На него необходимо установить пакет `ros-melodic-desktop-full` или `ros-melodic-desktop`, используя [документацию по установке](http://wiki.ros.org/melodic/Installation/Ubuntu). +На него необходимо установить пакет `ros-noetic-desktop-full` или `ros-noetic-desktop`, используя [документацию по установке](http://wiki.ros.org/noetic/Installation/Ubuntu). Запуск rviz --- diff --git a/docs/ru/simulation_vm.md b/docs/ru/simulation_vm.md index 29832e89..3ea08464 100644 --- a/docs/ru/simulation_vm.md +++ b/docs/ru/simulation_vm.md @@ -1,10 +1,10 @@ # Установка виртуальной машины -Для работы с платформой Клевер рекомендуется иметь [установленное окружение ROS](ros.md) на своём компьютере. К сожалению, [установка ROS](ros-install.md) сопряжена с рядом трудностей: требуется использовать операционную систему Ubuntu 18.04, процесс установки длительный и требует выполнения большого количества команд в терминале. +Для работы с платформой Клевер рекомендуется иметь [установленное окружение ROS](ros.md) на своём компьютере. К сожалению, [установка ROS и симулятора](simulation_native.md) сопряжена с рядом трудностей: требуется использовать операционную систему Ubuntu 20.04, процесс установки длительный и требует выполнения большого количества команд в терминале. Для облегчения процесса настройки окружения мы предлагаем использовать виртуальную машину со всем необходимым для работы с платформой Клевер. В состав виртуальной машины входят: -* операционная система Ubuntu 18.04 с легковесной графической оболочкой XFCE; +* операционная система Ubuntu 20.04 с легковесной графической оболочкой XFCE; * предустановленные пакеты ROS для работы с Клевером; * QGroundControl; * предварительно настроенный симулятор Gazebo; @@ -18,8 +18,6 @@ Скачать текущую версию виртуальной машины можно [в релизах репозитория виртуальной машины](https://github.com/CopterExpress/clover_vm/releases/latest). -> **Warning** Виртуальную машину следует использовать только в тех случаях, когда по каким-то причинам использование Ubuntu 18.04 напрямую невозможно. Производительность всех программ, особенно тех, которые используют 3D-графику - jMAVSim, Gazebo, rviz - будет существенно ниже; кроме того, в ряде случаев будут возникать графические ошибки, приводящие к частичной или полной неработоспособности указанных программ. - ## Установка виртуальной машины Для запуска виртуальной машины разработчика требуется использовать одну из совместимых сред виртуализации: [VirtualBox](https://www.virtualbox.org/wiki/Downloads), [VMware Player](https://www.vmware.com/products/workstation-player.html), [VMware Workstation](https://www.vmware.com/products/workstation-pro.html). diff --git a/docs/ru/web_video_server.md b/docs/ru/web_video_server.md index 87d4a319..e01cd687 100644 --- a/docs/ru/web_video_server.md +++ b/docs/ru/web_video_server.md @@ -20,7 +20,7 @@ http://192.168.11.1:8080/stream_viewer?topic=/main_camera/image_raw&type=mjpeg&q ## Просмотр через rqt_image_view -Для просмотра изображений через инструменты rqt необходим компьютер с установленной Ubuntu 18.04 и [ROS Melodic](http://wiki.ros.org/melodic/Installation/Ubuntu). +Для просмотра изображений через инструменты rqt необходим компьютер с установленной Ubuntu 20.04 и [ROS Noetic](http://wiki.ros.org/noetic/Installation/Ubuntu). [Подключитесь к Wi-Fi сети Клевера](wifi.md) и запустите `rqt_image_view` с указанием его IP-адреса: