diff --git a/README.md b/README.md index b447b10..3e18377 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,26 @@ Repo for ROS2 packages related to Robossembler +## Packages List + +1. `env_manager` - virtual environment switching manager and related packages + - `env_interface` - base class for creating a specific environment based on the ROS 2 LifeCycle Node + - `env_manager` - main package of the virtual environment switching manager + - `env_manager_interfaces` - ROS 2 interfaces for env_manager, describe messages about the state of the environment, services for configuring/loading/enabling/unloading the environment + - `gz_environment` - a specific instance of `env_interface` for the Gazebo simulator + - `planning_scene_manager` - sync env with planning scene for MoveIt 2 + - `rbs_gym` - training module with reinforcement: management of the learning process, formation of simulation environments, management of action spaces (actions) and perception (observation), task management, utilities +2. `rbs_bringup` - package for launching different launch scenarios: simulation, real robot, different hardware configurations (multi-robot) +3. `rbs_bt_executor` - module for launching behavior trees on Behavior Tree CPP v4 +4. `rbs_interface` - package for linking trees with skill servers +5. `rbs_perception` - machine perception module, where different versions are implemented +6. `rbs_simulation` - models for simulation +7. `rbs_skill_interfaces` - commonly used (common) interfaces for interacting with Skill Servers and the Behavior Tree (specific interfaces are placed in Skill Server packages) +8. `rbs_skill_servers` - Skill Server packages: Move, Object Detection, 6D Pose Estimation +9. `rbs_task_planner` - PDDL-based task scheduler +10. `rbs_utils` - working with a config containing capture positions for details +11. `rbss_objectdetection` - Object Detection Skill Server using YOLOv8 + ## Instructions ### Requirements * OS: Ubuntu 22.04 diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000..b8282f3 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,20 @@ +Robossembler ROS 2 Packages + +- `env_manager` - менеджер переключения виртуальных сред + - `env_interface` - базовый класс для создания конкретной среды на базе ROS 2 LifeCycle Node + - `env_manager` - основной пакет менеджера переключения виртуальных сред + - `env_manager_interfaces` - интерфейсы ROS 2 для env_manager, описывают сообщения о состоянии среды, сервисы по конфигурации/загрузке/включению/выгрузке среды + - `gz_environment` - конкретный экземпляр `env_interface` для симулятора Gazebo + - `planning_scene_manager` - управление сценой планирования для MoveIt (среда для MoveIt) + - `rbs_gym` - модуль обучения с подреплением: управление процесом обучения, формирование сред симуляции, управление пространствами действий(actions) и восприятия(observation), управление задачами, утилиты + +- `rbs_bringup` - пакет для запуска разных launch сценариев: симуляция, реальный робот, разные конфигурации оборудования (multi-robot) +- `rbs_bt_executor` - модуль запуска деревьев поведения на Behavior Tree CPP v4 +- `rbs_interface` - пакет для связывания деревьев со скилл-серверами (объединить с - `rbs_bt_executor`) +- `rbs_perception` - модуль машинного восприятия, где реализованы разные версии +- `rbs_simulation` - модели для симуляции (к удалить или объединить с env_manager/rbs_gym) +- `rbs_skill_interfaces` - общеиспользуемые (common) интерфейсы для взаимодействия с Серверами Навыков и Деревом поведения (специфичные интерфейсы размещаются в пакетах Серверов Навыков) +- `rbs_skill_servers` - пакеты Серверов Навыков (упразднить, для каждого Сервера Навыков свой пакет) +- `rbs_task_planner` - планировщик задач на базе PDDL +- `rbs_utils` - работа с конфигом, содержащим позиции захвата для деталей +- `rbss_objectdetection` - Сервер Навыка обнаружения объектов с помощью YOLOv8 \ No newline at end of file