diff --git a/.markdownlint.json b/.markdownlint.json index 57e79e51..a6eab7fe 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -22,6 +22,7 @@ "ROS Kinetic", "ROS Melodic", "OpenCV", + "OpenVPN", "Gazebo", "GitHub", "FPV", diff --git a/docs/en/4g.md b/docs/en/4g.md index 2b67e3bb..3652fe45 100644 --- a/docs/en/4g.md +++ b/docs/en/4g.md @@ -18,15 +18,15 @@ Note that when connected, the modem must be recognized in the system as a networ Create the VPN network keys to connect Raspberry Pi and the ground station. -To connect Raspberry Pi to your network, install the *openvpn* package: +To connect Raspberry Pi to your network, install the OpenVPN package: ```bash sudo apt-get install openvpn ``` -Move your keys to the */etc/openvpn/client* directory. For convenience, use the graphical SFTP data transfer interface, for example: WinSCP, FileZilla, etc. +Move your keys to the `/etc/openvpn/client` directory. For convenience, use the graphical SFTP data transfer interface, for example: WinSCP, FileZilla, etc. -To enable the client mode, you must activate the keys you have transmitted. Keys can be generated in various formats, for example: *.ovpn*, *.conf*. The key or configuration used on your copter should be strictly in *.conf* format. +To enable the client mode, you must activate the keys you have transmitted. Keys can be generated in various formats, for example: `.ovpn`, `.conf`. The key or configuration used on your copter should be strictly in `.conf` format. Initialize the service that uses your keys to connect in client mode: diff --git a/docs/en/arduino.md b/docs/en/arduino.md index e80bc97c..4ad88994 100644 --- a/docs/en/arduino.md +++ b/docs/en/arduino.md @@ -4,7 +4,7 @@ For interaction with ROS topics and services on a Raspberry Pi, you can use the The main tutorial for rosserial: http://wiki.ros.org/rosserial_arduino/Tutorials -Arudino is to be installed on Clover and connected via a USB port. +Arduino is to be installed on Clover and connected via a USB port. ## Configuring Arduino IDE @@ -14,7 +14,7 @@ To work with ROS and Arduino, you should understand the format of installed pack rosrun rosserial_arduino make_libraries.py. ``` -The obtained folder `ros_lib` is to be copied to `/libraries` on a computer with Arudino IDE. +The obtained folder `ros_lib` is to be copied to `/libraries` on a computer with Arduino IDE. ## Configuring Raspberry Pi @@ -24,7 +24,7 @@ To run the program on Arduino once, you can use command: roslaunch clover arduino.launch ``` -To start the link with Arduino at the startup automatically, set argument `arudino` in the Clover launch file (`~/catkin_ws/src/clover/clover/launch/clover.launch`): +To start the link with Arduino at the startup automatically, set argument `arduino` in the Clover launch file (`~/catkin_ws/src/clover/clover/launch/clover.launch`): ```xml @@ -202,7 +202,7 @@ getTelemetry.call(gt_req, gt_res); ## Problem -When using Arudino Nano, RAM may be insufficient. In this case, messages will appear in the Aruino IDE like: +When using Arduino Nano, RAM may be insufficient. In this case, messages will appear in the Arduino IDE like: ``` Global variables use 1837 bytes (89%) of the dynamic memory, leaving 211 bytes for local variables. The maximum is 2048 bytes. diff --git a/docs/en/assemble_3.md b/docs/en/assemble_3.md index 51311396..739bc2ec 100644 --- a/docs/en/assemble_3.md +++ b/docs/en/assemble_3.md @@ -51,7 +51,7 @@ TODO 1. Unpack the power board and install the power ribbon cable. 2. Switch the multimeter in the DC voltage measurement mode (20V or 200V range). -3. Check the correct functionning of the power board by connecting the battery. +3. Check the correct functioning of the power board by connecting the battery. * Voltage measurements are to be made between black and red wires. * Output voltage at the XT30 connector should be equal to the battery voltage (10 V to 12.6 V). * The output voltage at the power ribbon cable should be between 4.9 V to 5.3 V. @@ -69,7 +69,7 @@ TODO BLACK -> OUT- RED -> OUT+ -6. Check BEC functionning. +6. Check BEC functioning. * Solder the BEC to the power board: BLACK -> - diff --git a/docs/en/assemble_4.md b/docs/en/assemble_4.md index 1c5d4d84..66f2d4e4 100644 --- a/docs/en/assemble_4.md +++ b/docs/en/assemble_4.md @@ -29,7 +29,7 @@ ## Installing motors 1. Unbox the motors. -2. Shorten the motor wires using wire strippers or sidecutters: +2. Shorten the motor wires using wire strippers or side cutters: * Cut wires to 30 mm. * Strip 5 mm of insulation while taking care to not damage the cores @@ -315,7 +315,7 @@ The flight controller expects PPM signal from your RC gear. Switch your transmit 6. Connect the camera ribbon cable to the camera. -7. Connect the laser rangefineder to the Raspberry Pi using the following pinout: +7. Connect the laser rangefinder to the Raspberry Pi using the following pinout: * Connect **VCC** to pin 1 (**3v3**) * Connect **GND** to pin 9 (**Ground**) * Connect **SDA** to pin 3 (**GPIO2**) @@ -391,7 +391,7 @@ Perform the quadrotor components setup according to [the "Configuration" section > **Warning** Be sure to **not** mount the propellers **until the setup is complete**. Do it only when you are ready to fly. -Attach the propellers according to their rotation direction. The battery should be disconnected duting propeller installation. +Attach the propellers according to their rotation direction. The battery should be disconnected during propeller installation.
diff --git a/docs/en/ir_sensors.md b/docs/en/ir_sensors.md index fb0dae01..9bed19d0 100644 --- a/docs/en/ir_sensors.md +++ b/docs/en/ir_sensors.md @@ -8,7 +8,7 @@ Infrared sensors are a convenient tool for transmitting any commands to the copt Most IR receivers operate and are connected the same way. Such receivers have 3 pins for connecting: G/GND — ground V/VCC — 5V power, S/OUT — signal. -ir reciver connection to raspberry +ir receiver connection to raspberry > **Hint** The signal port doesn't have to be connected to port GPIO 17; this pin may be changed during the [in/out port settings](#in/out). diff --git a/docs/en/jetson_nano.md b/docs/en/jetson_nano.md index 5e4af94b..90988dc2 100644 --- a/docs/en/jetson_nano.md +++ b/docs/en/jetson_nano.md @@ -137,7 +137,7 @@ Jetson Nano currently does not support older Raspberry Pi v1 cameras (that are b Fortunately, these cameras are available using GStreamer. You can try using the [`gscam`](http://wiki.ros.org/gscam) ROS package or our [`jetson_camera`](https://github.com/sfalexrog/jetson_camera) node. The latter requires you to build OpenCV 3.4 from source with GStreamer support. -The GStreamer pipelines are available at [JetsonHacksNano CSI camera reposotory](https://github.com/JetsonHacksNano/CSI-Camera). +The GStreamer pipelines are available at [JetsonHacksNano CSI camera repository](https://github.com/JetsonHacksNano/CSI-Camera). You may also notice that the camera image has a red tint that is more pronounced near the edges. This can be fixed by image signal processor tuning. Generally this should be done by your camera manufacturer; [here is a sample ISP configuration](https://www.arducam.com/docs/camera-for-jetson-nano/fix-red-tint-with-isp-tuning/) from Adrucam diff --git a/docs/en/leds.md b/docs/en/leds.md index 2a8ba9bc..7ee6fff6 100644 --- a/docs/en/leds.md +++ b/docs/en/leds.md @@ -12,7 +12,7 @@ Our [Raspberry Pi image](image.md) contains preinstalled modules for interfacing * control individual LED colors (low-level control); * configure the strip to display flight events. -> **Caution** LED strip can consume a lot of power! Powering it from a Raspyerry Pi may overload the computer's power circuitry. Consider using a separate BEC as a power source. +> **Caution** LED strip can consume a lot of power! Powering it from a Raspberry Pi may overload the computer's power circuitry. Consider using a separate BEC as a power source. ## High-level control diff --git a/docs/en/leds_old.md b/docs/en/leds_old.md index f6aac0fd..b163cc74 100644 --- a/docs/en/leds_old.md +++ b/docs/en/leds_old.md @@ -8,7 +8,7 @@ Connect the +5v and GND leads of your LED to a power source and the DIN (data in leds -> **Caution** LED strip can consume a lot of power! Powering it from a Raspyerry Pi may overload the computer's power circuitry. Consider using a separate BEC as a power source. +> **Caution** LED strip can consume a lot of power! Powering it from a Raspberry Pi may overload the computer's power circuitry. Consider using a separate BEC as a power source. diff --git a/docs/en/ros-install.md b/docs/en/ros-install.md index b2632048..1895c331 100644 --- a/docs/en/ros-install.md +++ b/docs/en/ros-install.md @@ -41,21 +41,21 @@ Now you can install the ROS package itself. ``` After the package has installed, initialize `rosdep`. -Package `rosdep` will allow to easily install dependecies for the source files that you whish to compile. Running some essential components of ROS will as well require this package. +Package `rosdep` will allow to easily install dependencies for the source files that you whish to compile. Running some essential components of ROS will as well require this package. ```bash sudo rosdep init rosdep update ``` -If you are not confortable with entering environment variables manually each time, you may configure it in a way that it add itself in your bash session on every new shell startup: +If you are not comfortable with entering environment variables manually each time, you may configure it in a way that it add itself in your bash session on every new shell startup: ```bash echo "source /opt/ros/melodic/setup.bash" >> ~/.bashrc source ~/.bashrc ``` -If you whish to install any additionnal packages for yout ROS Melodic simply use: +If you whish to install any additional packages for your ROS Melodic simply use: ```bash sudo apt-get install ros-melodic-PACKAGE diff --git a/docs/en/setup.md b/docs/en/setup.md index 334ea121..29b543c1 100644 --- a/docs/en/setup.md +++ b/docs/en/setup.md @@ -114,7 +114,7 @@ Press the *Save* button to save the changed value to the flight controller. Chan > **Hint** Note that you should fine-tune the PID parameters for each drone individually. -#### Cicruit breaker parameters +#### Circuit breaker parameters 1. Set `CBRK_USB_CHK` to 197848 to allow flights with the USB cable connected. 2. Disable safety switch check: `CBRK_IO_SAFETY` = 22027. diff --git a/docs/en/uart.md b/docs/en/uart.md index 0f1965b4..a1b8904a 100644 --- a/docs/en/uart.md +++ b/docs/en/uart.md @@ -37,7 +37,7 @@ By default, Raspberry Pi 3 PL011 is connected to the Bluetooth module. And Mini For the sake of convenience of working with these outputs, aliases exist in Raspbian: * `/dev/serial0` – always points to the TTY device that is connected to the GPIO ports. -* `/dev/serial1` – always points to the TTY device that is connected to the Bluetooh module. +* `/dev/serial1` – always points to the TTY device that is connected to the Bluetooth module. ### Configuration of UART on Raspberry Pi 3 diff --git a/docs/ru/4g.md b/docs/ru/4g.md index 4c68ebef..d66dc1a9 100644 --- a/docs/ru/4g.md +++ b/docs/ru/4g.md @@ -18,15 +18,15 @@ Сформируйте необходимые ключи VPN сети, для подключения Raspberry Pi и наземной станции. -Для того, чтобы подключить Raspberry Pi к вашей сети, установите пакет *openvpn*: +Для того, чтобы подключить Raspberry Pi к вашей сети, установите пакет `openvpn`: ```bash sudo apt-get install openvpn ``` -Перенесите ваши ключи в директорию */etc/openvpn/client*. Для удобства используйте графический SFTP интерфейс передачи данных, к примеру: WinSCP, FileZilla и т.д. +Перенесите ваши ключи в директорию `/etc/openvpn/client`. Для удобства используйте графический SFTP интерфейс передачи данных, к примеру: WinSCP, FileZilla и т.д. -Для включения режима клиента, необходимо активировать переданные вами ключи. Ключи могу быть сформированы в различных форматах, к примеру: *.ovpn*, *.conf*. Ключ или конфигурация использующийся на вашем коптере, должны быть строго в формате *.conf*. +Для включения режима клиента, необходимо активировать переданные вами ключи. Ключи могу быть сформированы в различных форматах, к примеру: `.ovpn`, `.conf`. Ключ или конфигурация использующийся на вашем коптере, должны быть строго в формате `.conf`. Инициализируйте сервис применяющий ваши ключи для подключения в режиме клиента: @@ -34,7 +34,7 @@ sudo apt-get install openvpn sudo systemctl enable openvpn-client@config-name ``` -где *config-name* - название вашего конфигурационного файла. +где `config-name` - название вашего конфигурационного файла. Если все сделано правильно, при каждом перезапуске системы, сервис-клиент будет автоматически подключаться к вашей сети. @@ -65,7 +65,7 @@ sudo systemctl enable openvpn-client@config-name > **Info** При выборе джойстика, обратите внимание на количество рабочих каналов и на поддержку его, в QGroundControl(SDL2). Встречаются пульты поддерживающие всего 4 канала, что не удобно для такого типа управления. -Если изменения положения стиков отображается в окне QGgroundControl, вам остается только применить параметр, определяющий, что управление коптером происходит с помощью джойстика, а не радиоаппаратуры: +Если изменения положения стиков отображается в окне QGroundControl, вам остается только применить параметр, определяющий, что управление коптером происходит с помощью джойстика, а не радиоаппаратуры: `COM_RC_IN_MODE` - Joystick/No RC Checks