diff --git a/README.md b/README.md index b8ee0829153537e5c135f35b10045f204abb9882..7c32385965566992cbb2cb41ec9a76da9484c85d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,37 @@ -# Robobin - -#Lidar System - - - - -# Application: - - - - - - - +# RoboBin Repository + +## Useful Commands + +- `colcon build --symlink install` - **Build the ROS2 workspace.** +- `ssh robobin@192.168.0.184` - **SSH into RoboBin for remote control.** +- `rm -rf build/ install/ log/` - **Clean the workspace.** +- `ros2 run tf2_tools view_frames` - **View ROS2 frames.** +- `ros2 run teleop_twist_keyboard teleop_twist_keyboard` - **Keyboard from ROS2** +- `ls -la /dev | grep USB` - **List USB devices.** +- `ros2 run nav2_map_server map_saver_cli -f <map_name>` - **Save the map.** + +## Node Files (To RUN) + +- `ros2 run super_robot test_imu_node` - **RUN IMU node.** +- `ros2 run super_robot test_motor_node` - **RUN simple motor node.** +- `ros2 run super_robot test_encoder_node` - **RUN encoder node.** +- `ros2 run super_robot test_control_feedback` - **RUN motor with PID control feedback.** +- `ros2 run super_robot odometry_node` - **RUN odometry node.** +- `ros2 run super_robot test_preprogram_route` - **RUN pre-programmed route.** +- `ros2 run super_robot goal_selector` - **Select goals for robot.** +- `ros2 run super_robot pos_track` - **Track robot's position in the map** + `ros2 run super_robot api_node` - **Start the API for the app's connection** +## Launch Files (To RUN) + +- `ros2 launch super_robot view_robot.py` - **Launch robot model in RViz.** +- `ros2 launch super_robot ekf_launch.py` - **Launch EKF node.** +- `ros2 launch super_robot launch_lidar.py` - **Launch LiDAR sensor.** +- `ros2 launch super_robot online_async_launch.py` - **Launch mapping package.** +- `ros2 launch super_robot basic.py` - **Launch basic setup which include all the nodes.** +- `ros2 launch super_robot localization_launch.py` - **Launch localization system.** +- `ros2 launch super_robot navigation_launch.py` - **Launch navigation system.** + +### Keepout Zone: + +- `ros2 launch super_robot keepout_costmap_filter_launch.py` - **Launch costmap filter.** +- `ros2 launch super_robot keepout_navigation_launch.py` - **Launch navigation with Keepout zone**