ara-api 0.9.0b0__tar.gz

ara_api-0.9.0b0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alexander Kleimenov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ara_api-0.9.0b0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.3
+Name: ara-api
+Version: 0.9.0b0
+Summary: Applied Robotics Avia API for ARA MINI, ARA EDU and ARA FPV drones
+License: MIT License
+         
+         Copyright (c) 2025 Alexander Kleimenov
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Keywords: robotics,drones,API,ARA
+Author: Alexander Kleimenov
+Maintainer: Alexander Kleimenov
+Maintainer-email: nequamy@gmail.com
+Requires-Python: >=3.10
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Dist: colorama (==0.4.6)
+Requires-Dist: customtkinter (==5.2.2)
+Requires-Dist: grpcio (==1.69.0)
+Requires-Dist: grpcio-tools (==1.66.2)
+Requires-Dist: numpy (>=2.1.1)
+Requires-Dist: opencv-contrib-python (==4.10.0.84)
+Requires-Dist: opencv-python (==4.10.0.84)
+Requires-Dist: pandas (==2.2.3)
+Requires-Dist: pillow (>=11.1.0,<12.0.0)
+Requires-Dist: pyfiglet (==1.0.2)
+Requires-Dist: pyserial (==3.5)
+Description-Content-Type: text/markdown
+
+
+# ARA API
+
+---
+
+![badge](https://img.shields.io/badge/Language-Python-green) ![badge](https://img.shields.io/badge/ARA_API-Software-blue) ![badge](https://img.shields.io/badge/Version-v1.0.0-red)
+
+**Applied Robotics Avia API** — это современный API для управления линейкой дронов и самолетов компании **Applied Robotics Avia**, а также для работы с симулятором **AgroTechSim**.
+
+
+--- 
+## 📖 Описание 
+
+Данный проект предлагает единый интерфейс для управления, анализа и автоматизации полетов. **ara-api** сочетает простоту использования, высокую производительность и поддержку множества языков программирования. 
+
+### Основные особенности: 
+1. Экранирование работы от конечного пользователя. 
+2. Интегрированная документация, загружаемая вместе с API. 
+3. Высокая скорость работы благодаря использованию HTTP/2 и gRPC. 
+4. Простота запуска и настройки. 
+5. Поддержка анализаторов для выполнения лабораторных работ. 
+6. Предохранительные меры для безопасности автономных полетов. 
+
+--- 
+## 🌟 Возможности 
+
+- **Мульти-языковая поддержка**: Автономное управление доступно на следующих языках: C#/.NET, C++, Dart, Go, Java, Kotlin, Node.js, Objective-C, PHP, Python, Ruby.  
+- **Протокол gRPC**: используется как внутри приложения, так и для внешнего взаимодействия. 
+- **Данные с полетного контроллера**: чтение одометрии, ориентации, IMU, оптического потока и дальномера.
+- **Встроенный анализатор**: запись и анализ логов, а также два режима запуска анализатора - online и offline.
+- **Библиотека работы с камерой**: анализ изображения и получение готовых значений(QR-code, Aruco, Blob)
+
+--- 
+## 🚀 Установка проекта 
+```
+foo@bar: pip3 install ara-api
+```
+## 📚 Использование
+### Терминал
+
+1) Запуск ядра API:
+```bash
+foo@bar:~$ ara-api-core 
+```
+2) Запуск анализатора: 
+```bash
+foo@bar:~$ ara-api-analyzer
+```
+3) Запуск пакета для работы с камерой:
+```bash
+foo@bar:~$ ara-api-vision 
+```
+
+***⚠️Важно!!! Перед началом использования удостоверьтесь, что ваш дрон обновлен до самой актуальной версии***
+
+---
+## Вызов документации по использованию команд:
+1) Запуск ядра API:
+```bash
+foo@bar:~$ ara-api-core --help
+```
+2) Запуск анализатора: 
+```bash
+foo@bar:~$ ara-api-analyzer --help
+```
+3) Запуск пакета для работы с камерой:
+```bash
+foo@bar:~$ ara-api-vision --help
+```
+
+---
+## 🧩Функции библиотеки ```ara_core```
+---
+### `takeoff(altitude)` 
+Вызывает сервис взлёта. 
+- **Параметры:** 
+	- `altitude` (float): Высота, на которую нужно подняться. 
+- **Возвращает:** 
+	- `str`: Статус операции взлёта. 
+--- 
+### `land()` 
+Вызывает сервис посадки. 
+- **Возвращает:** 
+	- `str`: Статус операции посадки. 
+--- 
+### `move_by_point(x, y)` 
+Вызывает сервис перемещения. 
+- **Параметры:**
+	- `x` (float): Координата X точки, в которую нужно переместиться. 
+	- `y` (float): Координата Y точки, в которую нужно переместиться. 
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `change_altitude(altitude)` 
+Вызывает сервис изменения высоты. 
+- **Параметры:**
+	- `altitude` (float): значение высоты в метрах, на которую нужно переместиться. 
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `set_velocity(vx, vy)` 
+Вызывает сервис задания скорости. 
+- **Параметры:**
+	- `vx` (float): Скорость дрона по X. 
+	- `vy` (float): Скорость дрона по Y. 
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `reset_velocity_state()` 
+Вызывает сервис перемещения
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `get_imu_data()` 
+Получает данные IMU (инерциального измерительного устройства) от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными гироскопа и акселерометра. 
+--- 
+### `get_attitude_data()` 
+Получает данные ориентации от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными об углах ориентации. 
+--- 
+### `get_odometry_data()` 
+Получает данные одометрии от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными о положении и скорости. 
+--- 
+### `get_optical_flow_data()`
+Получает данные оптического потока от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными об оптическом потоке.
+

ara_api-0.9.0b0/README.md

@@ -0,0 +1,132 @@
+
+# ARA API
+
+---
+
+![badge](https://img.shields.io/badge/Language-Python-green) ![badge](https://img.shields.io/badge/ARA_API-Software-blue) ![badge](https://img.shields.io/badge/Version-v1.0.0-red)
+
+**Applied Robotics Avia API** — это современный API для управления линейкой дронов и самолетов компании **Applied Robotics Avia**, а также для работы с симулятором **AgroTechSim**.
+
+
+--- 
+## 📖 Описание 
+
+Данный проект предлагает единый интерфейс для управления, анализа и автоматизации полетов. **ara-api** сочетает простоту использования, высокую производительность и поддержку множества языков программирования. 
+
+### Основные особенности: 
+1. Экранирование работы от конечного пользователя. 
+2. Интегрированная документация, загружаемая вместе с API. 
+3. Высокая скорость работы благодаря использованию HTTP/2 и gRPC. 
+4. Простота запуска и настройки. 
+5. Поддержка анализаторов для выполнения лабораторных работ. 
+6. Предохранительные меры для безопасности автономных полетов. 
+
+--- 
+## 🌟 Возможности 
+
+- **Мульти-языковая поддержка**: Автономное управление доступно на следующих языках: C#/.NET, C++, Dart, Go, Java, Kotlin, Node.js, Objective-C, PHP, Python, Ruby.  
+- **Протокол gRPC**: используется как внутри приложения, так и для внешнего взаимодействия. 
+- **Данные с полетного контроллера**: чтение одометрии, ориентации, IMU, оптического потока и дальномера.
+- **Встроенный анализатор**: запись и анализ логов, а также два режима запуска анализатора - online и offline.
+- **Библиотека работы с камерой**: анализ изображения и получение готовых значений(QR-code, Aruco, Blob)
+
+--- 
+## 🚀 Установка проекта 
+```
+foo@bar: pip3 install ara-api
+```
+## 📚 Использование
+### Терминал
+
+1) Запуск ядра API:
+```bash
+foo@bar:~$ ara-api-core 
+```
+2) Запуск анализатора: 
+```bash
+foo@bar:~$ ara-api-analyzer
+```
+3) Запуск пакета для работы с камерой:
+```bash
+foo@bar:~$ ara-api-vision 
+```
+
+***⚠️Важно!!! Перед началом использования удостоверьтесь, что ваш дрон обновлен до самой актуальной версии***
+
+---
+## Вызов документации по использованию команд:
+1) Запуск ядра API:
+```bash
+foo@bar:~$ ara-api-core --help
+```
+2) Запуск анализатора: 
+```bash
+foo@bar:~$ ara-api-analyzer --help
+```
+3) Запуск пакета для работы с камерой:
+```bash
+foo@bar:~$ ara-api-vision --help
+```
+
+---
+## 🧩Функции библиотеки ```ara_core```
+---
+### `takeoff(altitude)` 
+Вызывает сервис взлёта. 
+- **Параметры:** 
+	- `altitude` (float): Высота, на которую нужно подняться. 
+- **Возвращает:** 
+	- `str`: Статус операции взлёта. 
+--- 
+### `land()` 
+Вызывает сервис посадки. 
+- **Возвращает:** 
+	- `str`: Статус операции посадки. 
+--- 
+### `move_by_point(x, y)` 
+Вызывает сервис перемещения. 
+- **Параметры:**
+	- `x` (float): Координата X точки, в которую нужно переместиться. 
+	- `y` (float): Координата Y точки, в которую нужно переместиться. 
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `change_altitude(altitude)` 
+Вызывает сервис изменения высоты. 
+- **Параметры:**
+	- `altitude` (float): значение высоты в метрах, на которую нужно переместиться. 
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `set_velocity(vx, vy)` 
+Вызывает сервис задания скорости. 
+- **Параметры:**
+	- `vx` (float): Скорость дрона по X. 
+	- `vy` (float): Скорость дрона по Y. 
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `reset_velocity_state()` 
+Вызывает сервис перемещения
+- **Возвращает:** 
+	- `str`: Статус операции перемещения. 
+--- 
+### `get_imu_data()` 
+Получает данные IMU (инерциального измерительного устройства) от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными гироскопа и акселерометра. 
+--- 
+### `get_attitude_data()` 
+Получает данные ориентации от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными об углах ориентации. 
+--- 
+### `get_odometry_data()` 
+Получает данные одометрии от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными о положении и скорости. 
+--- 
+### `get_optical_flow_data()`
+Получает данные оптического потока от сервиса драйвера. 
+- **Возвращает:** 
+	- `dict`: Словарь с данными об оптическом потоке.

ara_api-0.9.0b0/ara_api/__init__.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+from importlib.metadata import version
+
+__version__ = version(__name__)
+
+from .ara_lib import *
+
+
+import sys
+from pathlib import Path
+
+sys.path.append(str(Path(__file__).resolve().parent))

ara_api-0.9.0b0/ara_api/__main__.py

@@ -0,0 +1,258 @@
+import multiprocessing
+import os
+import time
+import logging
+import asyncio
+import platform
+from importlib.metadata import version
+
+import colorama
+import pyfiglet
+from colorama import Fore
+
+from navigation.nav_service import serve as nav_serve
+from driver.msp_service import main as msp_main
+
+import argparse
+
+system = "win"
+system = platform.system()
+if system in ["Linux", "Darwin"]:  # Darwin is macOS
+    system = "unix"
+    multiprocessing.set_start_method("fork")
+
+
+class ServiceManager:
+    """
+    Manages the lifecycle of multiple services running in parallel.
+    """
+
+    def __init__(self):
+        """
+        Initializes the ServiceManager with necessary configurations.
+        """
+        self.ascii_art = pyfiglet.figlet_format(
+            f"ARA MINI API {version('ara_api')}", font="slant", width=50
+        )
+        self.summary = (
+            f"{Fore.CYAN + 'Поздравляем! Вы запустили API для программирования ARA MINI\n\n'}"
+            f"{Fore.CYAN + 'Для подключения в конфигуратеоре к квадрокоптеру:\n'}"
+            f"{Fore.CYAN + '\tUDP:'} \t{Fore.MAGENTA + 'http://192.168.2.113:14550\n'}"
+            f"{Fore.CYAN + '\tTCP:'} \t{Fore.MAGENTA + 'http://192.168.2.113:5760\n\n'}"
+            f"{Fore.CYAN + 'Изображение с камеры:'} \t\t{Fore.MAGENTA + 'http://192.168.2.113:81/stream\n'}"
+        )
+        self.docs = (
+            f"{Fore.MAGENTA + 'Applied Robotics Avia API'} {Fore.CYAN + '— это современный API для управления линейкой дронов и самолетов компании '}"
+            f"{Fore.MAGENTA + 'Applied Robotics Avia'}, {Fore.CYAN + 'а также для работы с симулятором'} {Fore.MAGENTA + 'AgroTechSim'}.\n\n"
+            f"{Fore.CYAN + '### Основные особенности:\n'}"
+            f"{Fore.CYAN + '1. Экранирование работы от конечного пользователя.\n'}"
+            f"{Fore.CYAN + '2. Интегрированная документация, загружаемая вместе с API.\n'}"
+            f"{Fore.CYAN + '3. Высокая скорость работы благодаря использованию HTTP/2 и gRPC.\n'}"
+            f"{Fore.CYAN + '4. Простота запуска и настройки.\n'}"
+            f"{Fore.CYAN + '5. Поддержка анализаторов для выполнения лабораторных работ.\n'}"
+            f"{Fore.CYAN + '6. Предохранительные меры для безопасности автономных полетов.\n\n'}"
+            f"{Fore.CYAN + '### Команды:\n'}"
+            f"{Fore.CYAN + '- Запуск API:'} {Fore.MAGENTA + 'ara-api-core'}\n"
+            f"{Fore.CYAN + '- Запуск анализатора:'} {Fore.MAGENTA + 'ara-api-analyzer'}\n"
+            f"{Fore.CYAN + '- Запуск vision-сервиса:'} {Fore.MAGENTA + 'ara-api-vision'}\n\n"
+            f"{Fore.CYAN + '### Для запуска документации к командам нужно добавить флаг при вызове:'} {Fore.MAGENTA + '--help'}\n"
+        )
+
+        self.processes = []
+        self.parser = argparse.ArgumentParser(
+            description="Запуск приложения и сервисов для автономного полета и управления ARA MINI"
+        )
+        self.parser.add_argument(
+            "--sensor-output",
+            action="store_true",
+            help="Вывод данных с датчиков в терминал",
+        )
+        self.parser.add_argument(
+            "--logging",
+            action="store_true",
+            help="Включение логирования",
+        )
+        self.parser.add_argument(
+            "--docs",
+            action="store_true",
+            help="Отображение документации",
+        )
+        self.parser.add_argument(
+            "--analyzer",
+            action="store_true",
+            help="Запуск чтения данных для только для анализатора",
+        )
+        self.parser.add_argument(
+            "--only-msp",
+            action="store_true",
+            help="Запуск чтения данных c полетного контроллера ARA MINI",
+        )
+        self.parser.add_argument(
+            "--serial",
+            type=str,
+            default=None,
+            help="Подключение по Serial-порту (по умолчанию /dev/ttyACM0)",
+        )  # TODO: дореализовать флаг
+        self.parser.add_argument(
+            "--ip",
+            type=str,
+            default=None,
+            help="Подключение по TCP с явным указанием IP (по умолчанию 192.168.2.113)",
+        )  # TODO: дореализовать флаг
+
+        self.args = self.parser.parse_args()
+
+        if self.args.logging:
+            self.__init_logging__("log")
+        else:
+            self.logger = logging.getLogger("service_manager")
+            self.logger.disabled = True
+
+    def __init_logging__(self, log_directory="log"):
+        """
+        Sets up logging configuration for the service manager.
+        """
+        if not os.path.exists(log_directory):
+            os.makedirs(log_directory)
+
+        self.logger = logging.getLogger("service_manager")
+        self.logger.setLevel(logging.INFO)
+        self.logger_formater = logging.Formatter(
+            "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+        )
+        self.logger_handler = logging.FileHandler(
+            os.path.join(log_directory, "service_manager.log")
+        )
+        self.logger_handler.setFormatter(self.logger_formater)
+        self.logger.addHandler(self.logger_handler)
+
+    def gui_run(self):
+        colorama.init()
+
+        print(Fore.BLUE + self.ascii_art)
+        print("=" * 60)
+        print("\n")
+        print(Fore.CYAN + self.summary)
+
+        if self.args.sensor_output:
+            print(Fore.RED + "Data output:")
+
+        print(Fore.MAGENTA)
+        colorama.deinit()
+
+    def show_quick_docs(self):
+        print(Fore.CYAN + self.docs)
+
+    def run_nav_service(self):
+        """
+        Runs the Navigation service.
+        """
+        try:
+            self.logger.info("Starting Navigation service")
+            asyncio.run(nav_serve(log=self.args.logging))
+        except Exception as e:
+            self.logger.error("Error starting Navigation service: %s", e)
+
+    def run_msp_service(self):
+        """
+        Runs the MSP service.
+        """
+        try:
+            self.logger.info("Starting MSP service")
+            if self.args.ip:
+                raise Exception("Only one connection type can be specified")
+
+            if self.args.ip is not None:
+                type = "TCP"
+            elif self.args.serial is not None:
+                type = "SERIAL"
+            else:
+                type = "TCP"
+                self.args.ip = "192.168.2.113"
+                self.args.serial = None
+
+            msp_main(
+                ip=self.args.ip,
+                type=type,
+                serial=self.args.serial,
+                analyzer=self.args.analyzer,
+                logging=self.args.logging,
+                output=self.args.sensor_output,
+            )
+        except Exception as e:
+            self.logger.error("Error starting MSP service: %s", e)
+
+    def start_services(self):
+        """
+        Starts all the services as separate processes.
+        """
+        self.processes.append(
+            multiprocessing.Process(
+                target=self.run_msp_service, name="MSP", daemon=True
+            )
+        )
+
+        if not self.args.only_msp:
+            self.processes.append(
+                multiprocessing.Process(
+                    target=self.run_nav_service, name="NAV", daemon=True
+                )
+            )
+
+        for process in self.processes:
+            try:
+                self.logger.info("Starting process %s", process.name)
+                process.start()
+            except Exception as e:
+                self.logger.error("Error starting process %s: %s", process.name, e)
+
+    def monitor_services(self):
+        """
+        Monitors the services and logs their status.
+        """
+        try:
+            while True:
+                for process in self.processes:
+                    if not process.is_alive():
+                        self.logger.warning("%s process has terminated.", process.name)
+                        return
+                time.sleep(1)
+        except KeyboardInterrupt:
+            self.logger.info("Terminating processes due to KeyboardInterrupt")
+            self.terminate_services()
+        except Exception as e:
+            self.logger.error("Error monitoring services: %s", e)
+            self.terminate_services()
+
+    def terminate_services(self):
+        """
+        Terminates all running services.
+        """
+        for process in self.processes:
+            try:
+                self.logger.info("Terminating process %s", process.name)
+                process.terminate()
+                process.join()
+            except Exception as e:
+                self.logger.error("Error terminating process %s: %s", process.name, e)
+        self.logger.info("All processes terminated.")
+
+    def mainloop(self):
+        self.gui_run()
+        if self.args.docs:
+            self.show_quick_docs()
+        else:
+            self.start_services()
+            self.monitor_services()
+
+
+def main():
+    if platform.system() == "Windows":
+        if multiprocessing.get_start_method(allow_none=True) != "spawn":
+            multiprocessing.set_start_method("spawn")
+    manager = ServiceManager()
+    manager.mainloop()
+
+
+if __name__ == "__main__":
+    main()