Skip to content

Commit

Permalink
Merge pull request #23 from PickNikRobotics/update-to-pro
Browse files Browse the repository at this point in the history
Rebrand to MoveIt Pro
  • Loading branch information
dyackzan authored Jan 29, 2024
2 parents 2c122ee + 6be8f30 commit eef8834
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 27 deletions.
6 changes: 3 additions & 3 deletions .env
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Defaults for the MoveIt Studio docker compose agent services.
# Defaults for the MoveIt Pro docker compose agent services.

# Robot configuration package to launch
STUDIO_CONFIG_PACKAGE=picknik_kinova_gen3_base_config

# MoveIt Studio version tag, this should reference the version in which to build your user workspace.
# MoveIt Pro version tag, this should reference the version in which to build your user workspace.
# Be careful! Changing this without understanding the consequences may break your installation.
STUDIO_DOCKER_TAG=main

# Licensing -- enter your MoveIt Studio license below
# Licensing -- enter your MoveIt Pro license below
STUDIO_LICENSE_KEY=

# User name and UID to use when building the container
Expand Down
8 changes: 4 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Docker image for extending MoveIt Studio with a custom overlay.
# Docker image for extending MoveIt Pro with a custom overlay.
#
# Example build command (with defaults):
#
# docker build -f ./Dockerfile .
#

# Specify the MoveIt Studio release to build on top of.
# Specify the MoveIt Pro release to build on top of.
ARG MOVEIT_STUDIO_BASE_IMAGE
ARG USERNAME=studio-user
ARG USER_UID=1000
ARG USER_GID=1000

#####################################################
# Starting from the specified MoveIt Studio release #
# Starting from the specified MoveIt Pro release #
#####################################################
# The image tag is specified in the argument itself.
# hadolint ignore=DL3006
Expand Down Expand Up @@ -52,7 +52,7 @@ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \

# Install additional dependencies
# You can also add any necessary apt-get install, pip install, etc. commands at this point.
# NOTE: The /opt/overlay_ws folder contains MoveIt Studio binary packages and the source file.
# NOTE: The /opt/overlay_ws folder contains MoveIt Pro binary packages and the source file.
# hadolint ignore=SC1091
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
--mount=type=cache,target=/var/lib/apt,sharing=locked \
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# MoveIt Studio Kortex Workspace
# MoveIt Pro Kortex Workspace

This is a sample user workspace for running MoveIt Studio with Kinova's family of arms.
For more information, refer to the [MoveIt Studio Documentation](https://docs.picknik.ai/).
This is a sample user workspace for running MoveIt Pro with Kinova's family of arms.
For more information, refer to the [MoveIt Pro Documentation](https://docs.picknik.ai/).

Instructions for building your own MoveIt Studio configuration can be found [here.](https://docs.picknik.ai/en/stable/getting_started/configuration_tutorials/configure_custom_robot/config_package.html)
Instructions for building your own MoveIt Pro configuration can be found [here.](https://docs.picknik.ai/en/stable/getting_started/configuration_tutorials/configure_custom_robot/config_package.html)

MoveIt Studio can be used with real robots and full simulators such as Gazebo and NVIDIA Isaac Sim.
MoveIt Pro can be used with real robots and full simulators such as Gazebo and NVIDIA Isaac Sim.
For testing purposes, you can also use the [ROS 2 Control Mock Components](https://control.ros.org/master/doc/ros2_control/hardware_interface/doc/mock_components_userdoc.html), which is what this repo is configured to use.

---
## MoveIt Studio Configuration
## MoveIt Pro Configuration

This package follows the recommended layout of a MoveIt Studio configuration package.
This package follows the recommended layout of a MoveIt Pro configuration package.
Any configuration package or custom Behavior implementation can be included in the `src/` directory.
Packages in `src/` will be compiled and sourced by MoveIt Studio at first launch.
Packages in `src/` will be compiled and sourced by MoveIt Pro at first launch.

## Kinova Configuration Packages

This workspace contains several MoveIt Studio configuration packages for Kinova arms that inherit from each other for different applications.
This workspace contains several MoveIt Pro configuration packages for Kinova arms that inherit from each other for different applications.

```mermaid
graph TB
Expand Down
10 changes: 5 additions & 5 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Docker Compose file for user overlays of the MoveIt Studio images.
# Docker Compose file for user overlays of the MoveIt Pro images.

version: "3.9"

services:
# Sets common properties for other services. Should not be instantiated directly.
base:
# Extend the installed MoveIt Studio docker compose file.
# Change this to match your environment, if MoveIt Studio was installed to a different location.
# Extend the installed MoveIt Pro docker compose file.
# Change this to match your environment, if MoveIt Pro was installed to a different location.
extends:
file: ${HOME}/moveit_studio/docker-compose.yaml
service: base
Expand All @@ -20,7 +20,7 @@ services:
- USERNAME=${USERNAME:-studio-user}
- MOVEIT_STUDIO_BASE_IMAGE=picknikciuser/moveit-studio:${STUDIO_DOCKER_TAG:-main}

# Starts the MoveIt Studio Agent and the Bridge between the Agent and the Web UI
# Starts the MoveIt Pro Agent and the Bridge between the Agent and the Web UI
agent_bridge:
extends: base
privileged: true
Expand Down Expand Up @@ -105,7 +105,7 @@ services:
- ./install/:/opt/user_overlay_ws/install:rw
- ./log/:/opt/user_overlay_ws/log:rw
- ./.ccache/:/home/${USERNAME:-studio-user}/.ccache:rw
- ${HOME}/.ros/log_moveit_studio:/root/.ros/log:/root/.ros/log
- ${HOME}/.ros/log_moveit_pro:/root/.ros/log:/root/.ros/log
# Allow access to host hardware e.g. RealSense cameras
- /dev:/dev
command: sleep infinity
Expand Down
2 changes: 1 addition & 1 deletion src/kinova_gen3_base_config/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Kinova_Gen3_base_config

Base Config for using the Kinova Gen3 manipulator with MoveIt Studio.
Base Config for using the Kinova Gen3 manipulator with MoveIt Pro.
10 changes: 6 additions & 4 deletions src/kinova_gen3_base_config/config/config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
###############################################################
#
# This configures the robot to work with moveit studio
# This configures the robot to work with moveit pro
#
###############################################################

Expand All @@ -13,16 +13,16 @@ hardware:
# [Required]
simulated: ${MOCK_HARDWARE:-true}

# If the MoveIt Studio Agent should launch the ros2 controller node.
# If the MoveIt Pro Agent should launch the ros2 controller node.
# [Optional, default=True]
launch_control_node: True

# If the MoveIt Studio Agent should launch the robot state publisher.
# If the MoveIt Pro Agent should launch the robot state publisher.
# This should be false if you are launching the robot state publisher as part of drivers.
# [Optional, default=True]
launch_robot_state_publisher: True

# If the MoveIt Studio Agent should launch cameras when simulated.
# If the MoveIt Pro Agent should launch cameras when simulated.
# This must be False when using mock hardware, since there are no cameras simulated.
# [Optional, default=True]
launch_cameras_when_simulated: False
Expand Down Expand Up @@ -162,6 +162,8 @@ octomap_manager:

objectives:
behavior_loader_plugins:
# This plugin will load the core MoveIt Pro behaviors.
# Add additional plugin loaders as needed.
core:
- "moveit_studio::behaviors::CoreBehaviorsLoader"
objective_library_paths:
Expand Down
2 changes: 1 addition & 1 deletion src/picknik_kinova_gen3_site_config/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Picknik_Kinova_Gen3_site_config

A specific configuration of a Kinova Gen3 manipulator for use with MoveIt Studio. Based on the `kinova_gen3_base_config` package.
A specific configuration of a Kinova Gen3 manipulator for use with MoveIt Pro. Based on the `kinova_gen3_base_config` package.

0 comments on commit eef8834

Please sign in to comment.