diff --git a/docs/assets/clover-rescue-team/allsettings.png b/docs/assets/clover-rescue-team/allsettings.png new file mode 100644 index 00000000..117f52e1 Binary files /dev/null and b/docs/assets/clover-rescue-team/allsettings.png differ diff --git a/docs/assets/clover-rescue-team/bot1.jpg b/docs/assets/clover-rescue-team/bot1.jpg new file mode 100644 index 00000000..a22aad57 Binary files /dev/null and b/docs/assets/clover-rescue-team/bot1.jpg differ diff --git a/docs/assets/clover-rescue-team/bot2.png b/docs/assets/clover-rescue-team/bot2.png new file mode 100644 index 00000000..3c015de0 Binary files /dev/null and b/docs/assets/clover-rescue-team/bot2.png differ diff --git a/docs/assets/clover-rescue-team/bot3.jpg b/docs/assets/clover-rescue-team/bot3.jpg new file mode 100644 index 00000000..6ee19191 Binary files /dev/null and b/docs/assets/clover-rescue-team/bot3.jpg differ diff --git a/docs/assets/clover-rescue-team/bot4.png b/docs/assets/clover-rescue-team/bot4.png new file mode 100644 index 00000000..fd2b3a75 Binary files /dev/null and b/docs/assets/clover-rescue-team/bot4.png differ diff --git a/docs/assets/clover-rescue-team/bot5.jpg b/docs/assets/clover-rescue-team/bot5.jpg new file mode 100644 index 00000000..186eb8ab Binary files /dev/null and b/docs/assets/clover-rescue-team/bot5.jpg differ diff --git a/docs/assets/clover-rescue-team/bot6.jpg b/docs/assets/clover-rescue-team/bot6.jpg new file mode 100644 index 00000000..8b68a814 Binary files /dev/null and b/docs/assets/clover-rescue-team/bot6.jpg differ diff --git a/docs/assets/clover-rescue-team/bot7.jpg b/docs/assets/clover-rescue-team/bot7.jpg new file mode 100644 index 00000000..56559036 Binary files /dev/null and b/docs/assets/clover-rescue-team/bot7.jpg differ diff --git a/docs/assets/clover-rescue-team/m1.jpg b/docs/assets/clover-rescue-team/m1.jpg new file mode 100644 index 00000000..e59fd4ba Binary files /dev/null and b/docs/assets/clover-rescue-team/m1.jpg differ diff --git a/docs/assets/clover-rescue-team/m2.jpg b/docs/assets/clover-rescue-team/m2.jpg new file mode 100644 index 00000000..a01c07a5 Binary files /dev/null and b/docs/assets/clover-rescue-team/m2.jpg differ diff --git a/docs/assets/clover-rescue-team/m3.jpg b/docs/assets/clover-rescue-team/m3.jpg new file mode 100644 index 00000000..d14eed06 Binary files /dev/null and b/docs/assets/clover-rescue-team/m3.jpg differ diff --git a/docs/assets/clover-rescue-team/m4.jpg b/docs/assets/clover-rescue-team/m4.jpg new file mode 100644 index 00000000..7dd5109b Binary files /dev/null and b/docs/assets/clover-rescue-team/m4.jpg differ diff --git a/docs/assets/clover-rescue-team/m5.jpg b/docs/assets/clover-rescue-team/m5.jpg new file mode 100644 index 00000000..73ff351f Binary files /dev/null and b/docs/assets/clover-rescue-team/m5.jpg differ diff --git a/docs/assets/clover-rescue-team/main.png b/docs/assets/clover-rescue-team/main.png new file mode 100644 index 00000000..fdd036ac Binary files /dev/null and b/docs/assets/clover-rescue-team/main.png differ diff --git a/docs/assets/clover-rescue-team/mockup.png b/docs/assets/clover-rescue-team/mockup.png new file mode 100644 index 00000000..40152705 Binary files /dev/null and b/docs/assets/clover-rescue-team/mockup.png differ diff --git a/docs/assets/clover-rescue-team/s1.png b/docs/assets/clover-rescue-team/s1.png new file mode 100644 index 00000000..91cb4fac Binary files /dev/null and b/docs/assets/clover-rescue-team/s1.png differ diff --git a/docs/assets/clover-rescue-team/s2.png b/docs/assets/clover-rescue-team/s2.png new file mode 100644 index 00000000..fe3f91a7 Binary files /dev/null and b/docs/assets/clover-rescue-team/s2.png differ diff --git a/docs/assets/clover-rescue-team/s3.png b/docs/assets/clover-rescue-team/s3.png new file mode 100644 index 00000000..027dda3f Binary files /dev/null and b/docs/assets/clover-rescue-team/s3.png differ diff --git a/docs/assets/clover-rescue-team/s4.png b/docs/assets/clover-rescue-team/s4.png new file mode 100644 index 00000000..74f7b69b Binary files /dev/null and b/docs/assets/clover-rescue-team/s4.png differ diff --git a/docs/assets/clover-rescue-team/signup.png b/docs/assets/clover-rescue-team/signup.png new file mode 100644 index 00000000..9d219d3f Binary files /dev/null and b/docs/assets/clover-rescue-team/signup.png differ diff --git a/docs/assets/clover-rescue-team/status.png b/docs/assets/clover-rescue-team/status.png new file mode 100644 index 00000000..9cf278cb Binary files /dev/null and b/docs/assets/clover-rescue-team/status.png differ diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index df8628e9..c6198104 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -104,6 +104,7 @@ * [Video contest](video_contest.md) * [Educational contests](educational_contests.md) * [Clover-based projects](projects.md) + * [The Clover Rescue Project](clover-rescue-team.md) * [Autonomous valet parking drone assistance](djs_phoenix_ikshana.md) * [Autonomous Multirotor Landing System (AMLS)](amls.md) * [Drone show](clever-show.md) diff --git a/docs/en/clover-rescue-team.md b/docs/en/clover-rescue-team.md new file mode 100644 index 00000000..368e1e65 --- /dev/null +++ b/docs/en/clover-rescue-team.md @@ -0,0 +1,141 @@ +# The Clover Rescue Project + +[CopterHack-2022](copterhack2022.md), Clover Rescue Team - When something went wrong. + +## Team information + +### The list of team members + +* Кирилл Лещинский, [@k_leshchinskiy](https://t.me/k_leshchinskiy) - TeamLead. +* Кузнецов Михаил, [@fletchling_dev](https://t.me/fletchling_dev) - Software Developer. +* Даниил Валишин, [@Astel_1](https://t.me/Astel_1) - Tech Specialist/Python programmer. +* Роман Сибирцев, [@r_sibirtsev](https://t.me/r_sibirtsev) - Hardware engineer/tester. + +## Project description + +### Table of contents + +* [Idea](#idea) +* [How it works](#hiw) +* [Required hardware](#rh) +* [Operating Instructions](#oi) +* [Installation instructions](#ii) +* [Work example/functions](#functions) +* [Settings](#settings) +* [Mobile version](#mobile) +* [Bots](#bots) +* [Our plans for the future](#plans) + +## Project Idea + +The idea of this project came immediately, it lies on the surface. A system that makes situations where pilots cannot find their flown away drone or stop it at full speed flying into a wall, a thing of the past, is something that pilots have been missing for a long time. The key feature of our software is that users can manage their Clover from anywhere in the world, this software replaces FTP and SSH (users can upload the code to their drone and run it directly from our site). Also, if radio communication with the Clover is lost, it can be returned to the user's or takeoff location with just one click. Moreover, the user can monitor the status in realtime, as well as location, camera data, and airborne position data of the drone. There are also functions that can be useful in emergency situations, such as landing, hovering and disarming the drone remotely from our website. A mobile version of the site with full functionality is also available! + +[Presentation video](https://youtu.be/4bvOu0h3YU0) + +[Functional review video](https://youtu.be/jjeBh1ch4Xo) + +[Link to the website](https://48c5-94-29-124-254.eu.ngrok.io) + + + +## How It Works + +Links to repositories: + +* https://github.com/DevMBS/CRTClient +* https://github.com/DevMBS/CRTClover + +The first repository is the main server that users and their drones connect to. This server provides communication and control of the drone through a user-friendly interface. +The second repository represents the server that runs on the drone and connects to the main server. This server reads and transmits telemetry to the main server (which is displayed as a 3-D visualization). It also takes commands from the user and executes them. +The Socket.IO library is used to transfer data between the client, server and drone. +After connecting the client and the drone to the server, they are added to a unique room with their UID, and already in it they exchange data. +You can learn more about how it works by visiting the repositories. + +## Required Hardware + +All you need is COEX Clover 3/4, Raspberry Pi 3/4, USB WIFI Modem and RPi Camera! + +## Operating Instructions + +Firstly, users need to register on our website. + + + +After registration the main control panel and installation instructions open. + +## Installation Instructions + +First, you need to connect to your Clover via SSH and paste the command indicated in the instructions that opened (if it is not open, you can open it by clicking on the "Instructions" button). The command looks like that: + +```bash +wget https://48c5-94-29-124-254.eu.ngrok.io/assets/installers/install.sh && sudo chmod 777 ./install.sh && ./install.sh #UID +``` + +When the software is installed, the server will automatically start. After installation, you can forget about manually launching the software, it will automatically start and connect to the main server after turning on the Clover! + +## Work Example, Functions + + + +On the website there are several commands for controlling the drone. “Get photo” allows you to get an image from the drone camera. The “Land” button lands the drone. The "Return" command returns drone to the operator, according to GPS coordinates (this requires a stable connection of the drone with 10 or more satellites). "Hover" makes the drone hover in the air. "Disarm" instantly disables the drone's motors, so you need to be careful with this command. The “Choose Code” and “Upload & Run” buttons allow users to select a code written in Python, upload it to the drone and run it. Also, users will see output of their code and all its errors. There is also interactive map with markers, blue marker the is location of the user, purple marker is the location of his drone. Also, as you can see, there is a real-time visualization of the Clover’s airborne position, as well as its altitude and the average voltage between the battery cells. + +## Settings + + + +In the settings users can set speed and altitude of the return. + + + +Users can choose an action after return (hover or land). + + + +...And the place where the drone will return (User coordinates or takeoff coordinates). + + + +Users can also set the period for automatically receiving photos from the drone. + + + +At the top of the website is the status of your drone (Disconnected/Connected, disarmed, Connected, in flight). + + + +## Mobile Version + +The mobile version of the site has absolutely the same functionality (swipe to the right/left to move between control panels). + + + + + + + +## Bots on the social networks and messengers + +Bots on the social networks is an example of what you can do based on our project. They have the main functionality of our website and The Clover Rescue Team is still working on their features. + + + + + + + + + +[VK Bot Repository](https://github.com/Astel2022/CRTVkbot) + +[Link to the bot](https://vk.com/rescueclover) + +[Demonstration video of the bot](https://youtu.be/N3oFobVCmx4) + +## Our plans for the future + +We do not plan to stop and want to continue the development. Here is a list of what will be added. + +1. Built-in code editor. +2. More drone control bots in social networks and messengers. +3. Socket API will be written so users can create their applications in different programming languages based on our app. +4. Drone swarm controls. diff --git a/docs/en/copterhack2022.md b/docs/en/copterhack2022.md index b12277c1..90d24b8d 100644 --- a/docs/en/copterhack2022.md +++ b/docs/en/copterhack2022.md @@ -16,7 +16,7 @@ The proposed projects have to be open-source and be compatible with the Clover q ||🇷🇺 Stereo|[Neural obstacle avoidance](https://github.com/den250400/clover/blob/neural-obstacle-avoidance/docs/en/neural-obstacle-avoidance.md)|| ||🇷🇺 Space clowns|[Copter For Space](https://github.com/slavikyd/clover/blob/patch-3/docs/ru/c4s.md)|| ||🇧🇷 Atena - Grupo SEMEAR|[Swarm in Blocks](https://github.com/Grupo-SEMEAR-USP/clover/blob/Swarm_in_Blocks/docs/en/swarm_in_blocks.md)|| -||🇷🇺 Clover Rescue Team|[Rescue Clover](https://github.com/DevMBS/clover/blob/CloverRescueTeam/docs/ru/clover-rescue-team.md)|| +||🇷🇺 Clover Rescue Team|[Rescue Clover](clover-rescue-team.md)|| ||🇷🇺 CopterCat|[CopterCat](../ru/copter_cat.html)|| ||🇮🇳 DJS Phoenix|[Autonomous valet parking drone assistance](djs_phoenix_ikshana.md)|| ||🇷🇺 С305|[Система мониторинга воздуха](../ru/air_monitor.html)| | diff --git a/docs/ru/copterhack2022.md b/docs/ru/copterhack2022.md index 0a229751..b7c1e8bb 100644 --- a/docs/ru/copterhack2022.md +++ b/docs/ru/copterhack2022.md @@ -16,7 +16,7 @@ CopterHack 2022 — это международный конкурс по ра ||🇷🇺 Stereo|[Neural obstacle avoidance](https://github.com/den250400/clover/blob/neural-obstacle-avoidance/docs/en/neural-obstacle-avoidance.md)|| ||🇷🇺 Space clowns|[Copter For Space](https://github.com/slavikyd/clover/blob/patch-3/docs/ru/c4s.md)|| ||🇧🇷 Atena - Grupo SEMEAR|[Swarm in Blocks](https://github.com/Grupo-SEMEAR-USP/clover/blob/Swarm_in_Blocks/docs/en/swarm_in_blocks.md)|| -||🇷🇺 Clover Rescue Team|[Rescue Clover](https://github.com/DevMBS/clover/blob/CloverRescueTeam/docs/ru/clover-rescue-team.md)|| +||🇷🇺 Clover Rescue Team|[Rescue Clover](../en/clover-rescue-team.html)|| ||🇷🇺 CopterCat|[CopterCat](copter_cat.md)|| ||🇮🇳 DJS Phoenix|[Autonomous valet parking drone assistance](../en/djs_phoenix_ikshana.html)|| ||🇷🇺 С305|[Система мониторинга воздуха](air_monitor.md)| |